From commits-return-5607-archive-asf-public=cust-asf.ponee.io@kudu.apache.org Thu Mar 22 22:17:09 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id B681818067E for ; Thu, 22 Mar 2018 22:17:03 +0100 (CET) Received: (qmail 8614 invoked by uid 500); 22 Mar 2018 21:17:02 -0000 Mailing-List: contact commits-help@kudu.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kudu.apache.org Delivered-To: mailing list commits@kudu.apache.org Received: (qmail 7668 invoked by uid 99); 22 Mar 2018 21:17:01 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 22 Mar 2018 21:17:01 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 75FF1F6760; Thu, 22 Mar 2018 21:17:01 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: mpercy@apache.org To: commits@kudu.apache.org Date: Thu, 22 Mar 2018 21:17:34 -0000 Message-Id: <42f56fc822ea47b5bde79c168dc39b38@git.apache.org> In-Reply-To: <8e286dd10df240c3ac844ffb8d15fbaa@git.apache.org> References: <8e286dd10df240c3ac844ffb8d15fbaa@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [35/51] [partial] kudu git commit: Fix 1.7.0 apidocs and cpp-client-api http://git-wip-us.apache.org/repos/asf/kudu/blob/33b93347/cpp-client-api/classkudu_1_1_status.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1_status.html b/cpp-client-api/classkudu_1_1_status.html new file mode 100644 index 0000000..9571e5c --- /dev/null +++ b/cpp-client-api/classkudu_1_1_status.html @@ -0,0 +1,1012 @@ + + + + + + + +Kudu C++ client API: kudu::Status Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Kudu C++ client API +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
+
kudu::Status Class Reference
+
+
+ +

A representation of an operation's outcome. + More...

+ +

#include <status.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ Status ()
 Create an object representing success status.
 
 Status (const Status &s)
 
Status & operator= (const Status &s)
 
bool ok () const
 
bool IsNotFound () const
 
bool IsCorruption () const
 
bool IsNotSupported () const
 
bool IsIOError () const
 
bool IsInvalidArgument () const
 
bool IsAlreadyPresent () const
 
bool IsRuntimeError () const
 
bool IsNetworkError () const
 
bool IsIllegalState () const
 
bool IsNotAuthorized () const
 
bool IsAborted () const
 
bool IsRemoteError () const
 
bool IsServiceUnavailable () const
 
bool IsTimedOut () const
 
bool IsUninitialized () const
 
bool IsConfigurationError () const
 
bool IsIncomplete () const
 
bool IsEndOfFile () const
 
bool IsDiskFailure () const
 
std::string ToString () const
 
std::string CodeAsString () const
 
Slice message () const
 
int16_t posix_code () const
 
Status CloneAndPrepend (const Slice &msg) const
 
Status CloneAndAppend (const Slice &msg) const
 
size_t memory_footprint_excluding_this () const
 
size_t memory_footprint_including_this () const
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Static Public Member Functions

static Status OK ()
 
Methods to build status objects for various types of errors.
Parameters
+ + + + +
[in]msgThe informational message on the error.
[in]msg2Additional information on the error (optional).
[in]posix_codePOSIX error code, if applicable (optional).
+
+
+
Returns
The error status of an appropriate type.
+
+static Status NotFound (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status Corruption (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status NotSupported (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status InvalidArgument (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status IOError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status AlreadyPresent (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status RuntimeError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status NetworkError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status IllegalState (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status NotAuthorized (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status Aborted (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status RemoteError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status ServiceUnavailable (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status TimedOut (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status Uninitialized (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status ConfigurationError (const Slice &msg, const Slice &msg2=Slice(), int16_t posix_code=-1)
 
+static Status Incomplete (const Slice &msg, const Slice &msg2=Slice(), int64_t posix_code=-1)
 
+static Status EndOfFile (const Slice &msg, const Slice &msg2=Slice(), int64_t posix_code=-1)
 
+

Detailed Description

+

A representation of an operation's outcome.

+

Constructor & Destructor Documentation

+ +

◆ Status()

+ +
+
+ + + + + +
+ + + + + + + + +
kudu::Status::Status (const Status & s)
+ 		+inline
+
+

Copy the specified status.

+
Parameters
+ + +
[in]sThe status object to copy from.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ CloneAndAppend()

+ +
+
+ + + + + + + + +
Status kudu::Status::CloneAndAppend (const Slice & msg) const
+
+

Clone this status and add the specified suffix to the message.

+

If this status is OK, then an OK status will be returned.

+
Parameters
+ + +
[in]msgThe message to append.
+
+
+
Returns
A new Status object with the same state plus an additional trailing message.
+ +
+
+ +

◆ CloneAndPrepend()

+ +
+
+ + + + + + + + +
Status kudu::Status::CloneAndPrepend (const Slice & msg) const
+
+

Clone this status and add the specified prefix to the message.

+

If this status is OK, then an OK status will be returned.

+
Parameters
+ + +
[in]msgThe message to prepend.
+
+
+
Returns
A new Status object with the same state plus an additional leading message.
+ +
+
+ +

◆ CodeAsString()

+ +
+
+ + + + + + + +
std::string kudu::Status::CodeAsString () const
+
+
Returns
A string representation of the status code, without the message text or POSIX code information.
+ +
+
+ +

◆ IsAborted()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsAborted () const
+ 		+inline
+
+
Returns
true iff the status indicates an Aborted error.
+ +
+
+ +

◆ IsAlreadyPresent()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsAlreadyPresent () const
+ 		+inline
+
+
Returns
true iff the status indicates an AlreadyPresent error.
+ +
+
+ +

◆ IsConfigurationError()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsConfigurationError () const
+ 		+inline
+
+
Returns
true iff the status indicates ConfigurationError.
+ +
+
+ +

◆ IsCorruption()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsCorruption () const
+ 		+inline
+
+
Returns
true iff the status indicates a Corruption error.
+ +
+
+ +

◆ IsDiskFailure()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsDiskFailure () const
+ 		+inline
+
+
Returns
true iff the status indicates a disk failure.
+ +
+
+ +

◆ IsEndOfFile()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsEndOfFile () const
+ 		+inline
+
+
Returns
true iff the status indicates end of file.
+ +
+
+ +

◆ IsIllegalState()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsIllegalState () const
+ 		+inline
+
+
Returns
true iff the status indicates an IllegalState error.
+ +
+
+ +

◆ IsIncomplete()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsIncomplete () const
+ 		+inline
+
+
Returns
true iff the status indicates Incomplete.
+ +
+
+ +

◆ IsInvalidArgument()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsInvalidArgument () const
+ 		+inline
+
+
Returns
true iff the status indicates an InvalidArgument error.
+ +
+
+ +

◆ IsIOError()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsIOError () const
+ 		+inline
+
+
Returns
true iff the status indicates an IOError.
+ +
+
+ +

◆ IsNetworkError()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsNetworkError () const
+ 		+inline
+
+
Returns
true iff the status indicates a NetworkError.
+ +
+
+ +

◆ IsNotAuthorized()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsNotAuthorized () const
+ 		+inline
+
+
Returns
true iff the status indicates a NotAuthorized error.
+ +
+
+ +

◆ IsNotFound()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsNotFound () const
+ 		+inline
+
+
Returns
true iff the status indicates a NotFound error.
+ +
+
+ +

◆ IsNotSupported()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsNotSupported () const
+ 		+inline
+
+
Returns
true iff the status indicates a NotSupported error.
+ +
+
+ +

◆ IsRemoteError()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsRemoteError () const
+ 		+inline
+
+
Returns
true iff the status indicates a RemoteError.
+ +
+
+ +

◆ IsRuntimeError()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsRuntimeError () const
+ 		+inline
+
+
Returns
true iff the status indicates a RuntimeError.
+ +
+
+ +

◆ IsServiceUnavailable()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsServiceUnavailable () const
+ 		+inline
+
+
Returns
true iff the status indicates ServiceUnavailable.
+ +
+
+ +

◆ IsTimedOut()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsTimedOut () const
+ 		+inline
+
+
Returns
true iff the status indicates TimedOut.
+ +
+
+ +

◆ IsUninitialized()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::IsUninitialized () const
+ 		+inline
+
+
Returns
true iff the status indicates Uninitialized.
+ +
+
+ +

◆ memory_footprint_excluding_this()

+ +
+
+ + + + + + + +
size_t kudu::Status::memory_footprint_excluding_this () const
+
+
Returns
The memory usage of this object without the object itself. Should be used when embedded inside another object.
+ +
+
+ +

◆ memory_footprint_including_this()

+ +
+
+ + + + + + + +
size_t kudu::Status::memory_footprint_including_this () const
+
+
Returns
The memory usage of this object including the object itself. Should be used when allocated on the heap.
+ +
+
+ +

◆ message()

+ +
+
+ + + + + + + +
Slice kudu::Status::message () const
+
+

This is similar to ToString, except that it does not include the stringified error code or POSIX code.

+
Note
The returned Slice is only valid as long as this Status object remains live and unchanged.
+
Returns
The message portion of the Status. For OK statuses, this returns an empty string.
+ +
+
+ +

◆ OK()

+ +
+
+ + + + + +
+ + + + + + + +
static Status kudu::Status::OK ()
+ 		+inlinestatic
+
+
Returns
A success status.
+ +
+
+ +

◆ ok()

+ +
+
+ + + + + +
+ + + + + + + +
bool kudu::Status::ok () const
+ 		+inline
+
+
Returns
true iff the status indicates success.
+ +
+
+ +

◆ operator=()

+ +
+
+ + + + + +
+ + + + + + + + +
Status & kudu::Status::operator= (const Status & s)
+ 		+inline
+
+

Assign the specified status.

+
Parameters
+ + +
[in]sThe status object to assign from.
+
+
+
Returns
The reference to the modified object.
+ +
+
+ +

◆ posix_code()

+ +
+
+ + + + + + + +
int16_t kudu::Status::posix_code () const
+
+
Returns
The POSIX code associated with this Status object, or -1 if there is none.
+ +
+
+ +

◆ ToString()

+ +
+
+ + + + + + + +
std::string kudu::Status::ToString () const
+
+
Returns
A string representation of this status suitable for printing. Returns the string "OK" for success.
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+
+ Generated for Kudu version 1.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14 +
+ Copyright © 2018 The Apache Software Foundation. +
+ + http://git-wip-us.apache.org/repos/asf/kudu/blob/33b93347/cpp-client-api/classkudu_1_1client_1_1KuduClient-members.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1client_1_1KuduClient-members.html b/cpp-client-api/classkudu_1_1client_1_1KuduClient-members.html deleted file mode 100644 index 46b8efb..0000000 --- a/cpp-client-api/classkudu_1_1client_1_1KuduClient-members.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - -Kudu C++ client API: Member List - - - - - - - - - - -
-
- - - - - - -
-
Kudu C++ client API -
-
-
- - - - - - -
-
- - -
- -
- - -
-
-
-
kudu::client::KuduClient Member List
-
-
- -

This is the complete list of members for kudu::client::KuduClient, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
::kudu::SecurityUnknownTskTest (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
ClientTest (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
CLOSEST_REPLICA enum valuekudu::client::KuduClient
default_admin_operation_timeout() const kudu::client::KuduClient
default_rpc_timeout() const kudu::client::KuduClient
DeleteTable(const std::string &table_name)kudu::client::KuduClient
ExportAuthenticationCredentials(std::string *authn_creds) const kudu::client::KuduClient
FIRST_REPLICA enum valuekudu::client::KuduClient
GetLatestObservedTimestamp() const kudu::client::KuduClient
GetTableSchema(const std::string &table_name, KuduSchema *schema)kudu::client::KuduClient
internal::Batcher (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
internal::GetTableSchemaRpc (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
internal::LookupRpc (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
internal::MetaCache (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
internal::RemoteTablet (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
internal::RemoteTabletServer (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
internal::WriteRpc (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
IsAlterTableInProgress(const std::string &table_name, bool *alter_in_progress)kudu::client::KuduClient
IsCreateTableInProgress(const std::string &table_name, bool *create_in_progress)kudu::client::KuduClient
IsMultiMaster() const kudu::client::KuduClient
kNoTimestampkudu::client::KuduClientstatic
KuduClientBuilder (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduPartitionerBuilder (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduScanner (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduScanToken (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduScanTokenBuilder (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduSession (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduTable (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduTableAlterer (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
KuduTableCreator (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
LEADER_ONLY enum valuekudu::client::KuduClient
ListTables(std::vector< std::string > *tables, const std::string &filter="")kudu::client::KuduClient
ListTabletServers(std::vector< KuduTabletServer * > *tablet_servers)kudu::client::KuduClient
NewSession()kudu::client::KuduClient
NewTableAlterer(const std::string &table_name)kudu::client::KuduClient
NewTableCreator()kudu::client::KuduClient
OpenTable(const std::string &table_name, sp::shared_ptr< KuduTable > *table)kudu::client::KuduClient
ReplicaSelection enum namekudu::client::KuduClient
SetLatestObservedTimestamp(uint64_t ht_timestamp)kudu::client::KuduClient
TableExists(const std::string &table_name, bool *exists)kudu::client::KuduClient
tools::LeaderMasterProxy (defined in kudu::client::KuduClient)kudu::client::KuduClientfriend
~KuduClient() (defined in kudu::client::KuduClient)kudu::client::KuduClient
- -
-
- Generated for Kudu version 1.6.0 on Thu Dec 7 2017 19:52:43 by Doxygen 1.8.11 -
- Copyright © 2017 The Apache Software Foundation. -
- -