Google Cloud C++ Client  1.32.1
C++ Client Library for Google Cloud Platform
Namespaces | Classes | Typedefs | Enumerations | Functions
google::cloud Namespace Reference

Contains all the Google Cloud C++ Library APIs. More...

Namespaces

 v1
 The Google Cloud C++ Library inlined, versioned namespace.
 

Classes

class  CompletionQueue
 Call the functor associated with asynchronous operations when they complete. More...
 
class  StatusOr
 Holds a value or a Status indicating why there is no value. More...
 
class  ConnectionOptions
 The configuration parameters for client connections. More...
 
struct  LogRecord
 Represents a single log message. More...
 
class  LogBackend
 The logging backend interface. More...
 
class  LogSink
 A sink to receive log records. More...
 
struct  NullStream
 Implements operator<< for all types, without any effect. More...
 
class  Logger
 Define the class to capture a log message. More...
 
class  Logger< false >
 Define the logger for a disabled log level. More...
 
class  Credentials
 The public interface for Google's Unified Auth Client (GUAC) library. More...
 
struct  DelegatesOption
 Configure the delegates for MakeImpersonateServiceAccountCredentials() More...
 
struct  ScopesOption
 Configure the scopes for MakeImpersonateServiceAccountCredentials() More...
 
struct  AccessTokenLifetimeOption
 Configure the access token lifetime. More...
 
struct  UnifiedCredentialsOption
 A wrapper to store credentials into an options. More...
 
struct  CARootsFilePathOption
 Configures a custom CA (Certificates Authority) certificates file. More...
 
struct  EndpointOption
 Change the endpoint. More...
 
struct  UserAgentProductsOption
 User-agent products to include with each request. More...
 
struct  TracingComponentsOption
 Return whether tracing is enabled for the given component. More...
 
struct  GrpcCredentialOption
 The gRPC credentials used by clients configured with this object. More...
 
struct  GrpcNumChannelsOption
 The number of transport channels to create. More...
 
struct  GrpcChannelArgumentsOption
 A string-string map of arguments for grpc::ChannelArguments::SetString. More...
 
struct  GrpcChannelArgumentsNativeOption
 The native grpc::ChannelArguments object. More...
 
struct  GrpcTracingOptionsOption
 The TracingOptions to use when printing grpc protocol buffer messages. More...
 
struct  GrpcBackgroundThreadPoolSizeOption
 The size of the background thread pool. More...
 
struct  GrpcCompletionQueueOption
 The CompletionQueue to use for background gRPC work. More...
 
struct  GrpcBackgroundThreadsFactoryOption
 Changes the BackgroundThreadsFactory. More...
 
class  Project
 This class identifies a Cloud Project. More...
 
class  BackgroundThreads
 A object representing the background threads available to a Client. More...
 
class  Status
 Reports error code and details from a remote request. More...
 
class  RuntimeStatusError
 
class  Options
 A class that holds option structs indexed by their type. More...
 
class  TracingOptions
 The configuration parameters for RPC/protobuf tracing. More...
 
class  IamBindings
 Simplified view of multiple roles and their members for IAM. More...
 
struct  IamPolicy
 A deprecated representation of IAM policies. More...
 
class  KmsKeyName
 This class identifies a Google Cloud KMS Key. More...
 
struct  AsyncTimerResult
 The result of an async timer operation. More...
 
class  AsyncOperation
 Represents a pending asynchronous operation. More...
 
class  future
 Implement ISO/IEC TS 19571:2016 future<T>. More...
 
class  promise
 Implement promise<T> as defined in ISO/IEC TS 19571:2016. More...
 
class  future< void >
 Implement ISO/IEC TS 19571:2016 future for void. More...
 
class  promise< void >
 Specialize promise as defined in ISO/IEC TS 19571:2016 for void. More...
 
class  IamBinding
 Simplified view of roles and members for IAM. More...
 
class  PollingPolicy
 Control the Cloud C++ client library behavior with respect to polling on long running operations. More...
 
class  GenericPollingPolicy
 
class  StreamRange
 A StreamRange<T> is a range of StatusOr<T> where the end-of-stream is indicated by a non-OK Status. More...
 

Typedefs

using CommonOptionList = OptionList< EndpointOption, UserAgentProductsOption, TracingComponentsOption >
 A list of all the common options. More...
 
using BackgroundThreadsFactory = std::function< std::unique_ptr< BackgroundThreads >()>
 
using GrpcOptionList = OptionList< GrpcCredentialOption, GrpcNumChannelsOption, GrpcChannelArgumentsOption, GrpcChannelArgumentsNativeOption, GrpcTracingOptionsOption, GrpcBackgroundThreadPoolSizeOption, GrpcCompletionQueueOption, GrpcBackgroundThreadsFactoryOption >
 A list of all the gRPC options. More...
 
template<typename... T>
using OptionList = internal::TypeList< T... >
 A template to hold a list of "option" types. More...
 
using BackoffPolicy = ::google::cloud::internal::BackoffPolicy
 The base class for backoff policies. More...
 
using ExponentialBackoffPolicy = google::cloud::internal::ExponentialBackoffPolicy
 A truncated exponential backoff policy with randomized periods. More...
 
using IamUpdater = std::function< absl::optional< google::iam::v1::Policy >(google::iam::v1::Policy)>
 Used in the SetIamPolicy() read-modify-write cycles where an etag helps prevent simultaneous updates of a policy from overwriting each other. More...
 
template<typename T >
using optional = absl::optional< T >
 Alias template for google::cloud::optional. More...
 

Enumerations

enum class  Severity : int {
  GCP_LS_TRACE , GCP_LS_DEBUG , GCP_LS_INFO , GCP_LS_NOTICE ,
  GCP_LS_WARNING , GCP_LS_ERROR , GCP_LS_CRITICAL , GCP_LS_ALERT ,
  GCP_LS_FATAL , GCP_LS_HIGHEST = int(GCP_LS_FATAL) , GCP_LS_LOWEST = int(GCP_LS_TRACE) , GCP_LS_LOWEST_ENABLED = int(GOOGLE_CLOUD_CPP_LOGGING_MIN_SEVERITY_ENABLED)
}
 Define the severity levels for Google Cloud Platform C++ Libraries logging. More...
 
enum class  StatusCode {
  kOk = 0 , kCancelled = 1 , kUnknown = 2 , kInvalidArgument = 3 ,
  kDeadlineExceeded = 4 , kNotFound = 5 , kAlreadyExists = 6 , kPermissionDenied = 7 ,
  kUnauthenticated = 16 , kResourceExhausted = 8 , kFailedPrecondition = 9 , kAborted = 10 ,
  kOutOfRange = 11 , kUnimplemented = 12 , kInternal = 13 , kUnavailable = 14 ,
  kDataLoss = 15
}
 Well-known status codes with grpc::StatusCode-compatible values. More...
 

Functions

template<typename T >
bool operator== (StatusOr< T > const &a, StatusOr< T > const &b)
 
template<typename T >
bool operator!= (StatusOr< T > const &a, StatusOr< T > const &b)
 
template<typename T >
StatusOr< T > make_status_or (T rhs)
 
constexpr int version_major ()
 The Google Cloud Storage C++ Client major version. More...
 
constexpr int version_minor ()
 The Google Cloud Storage C++ Client minor version. More...
 
constexpr int version_patch ()
 The Google Cloud Storage C++ Client patch version. More...
 
constexpr int version ()
 A single integer representing the Major/Minor/Patch version. More...
 
std::string version_string ()
 The version as a string, in MAJOR.MINOR.PATCH+gitrev format. More...
 
std::ostream & operator<< (std::ostream &os, Severity x)
 Streaming operator, writes a human readable representation. More...
 
std::ostream & operator<< (std::ostream &os, LogRecord const &rhs)
 Default formatting of a LogRecord. More...
 
std::shared_ptr< CredentialsMakeInsecureCredentials ()
 Create insecure (aka anonymous, aka unauthenticated) credentials. More...
 
std::shared_ptr< CredentialsMakeGoogleDefaultCredentials ()
 Creates the default credentials. More...
 
std::shared_ptr< CredentialsMakeAccessTokenCredentials (std::string const &access_token, std::chrono::system_clock::time_point expiration)
 Creates credentials with a fixed access token. More...
 
std::shared_ptr< CredentialsMakeImpersonateServiceAccountCredentials (std::shared_ptr< Credentials > base_credentials, std::string target_service_account, Options opts={})
 Creates credentials for service account impersonation. More...
 
std::shared_ptr< CredentialsMakeServiceAccountCredentials (std::string json_object)
 Creates service account credentials from a JSON object in string form. More...
 
StatusOr< ProjectMakeProject (std::string const &full_name)
 Constructs a Project from the given full_name. More...
 
google::cloud::Status MakeStatusFromRpcError (grpc::Status const &status)
 Creates a google::cloud::Status from a grpc::Status. More...
 
google::cloud::Status MakeStatusFromRpcError (grpc::StatusCode code, std::string what)
 Creates a google::cloud::Status from a grpc::StatusCode and description. More...
 
google::cloud::Status MakeStatusFromRpcError (google::rpc::Status const &status)
 Creates a google::cloud::Status from a google:rpc::Status proto. More...
 
std::string StatusCodeToString (StatusCode code)
 
std::ostream & operator<< (std::ostream &os, StatusCode code)
 
std::ostream & operator<< (std::ostream &os, Status const &rhs)
 
bool operator== (Status const &lhs, Status const &rhs)
 
bool operator!= (Status const &lhs, Status const &rhs)
 
std::ostream & operator<< (std::ostream &os, IamBindings const &rhs)
 
bool operator== (IamBindings const &lhs, IamBindings const &rhs)
 
bool operator< (IamBindings const &lhs, IamBindings const &rhs)
 
bool operator!= (IamBindings const &lhs, IamBindings const &rhs)
 
bool operator> (IamBindings const &lhs, IamBindings const &rhs)
 
bool operator<= (IamBindings const &lhs, IamBindings const &rhs)
 
bool operator>= (IamBindings const &lhs, IamBindings const &rhs)
 
std::ostream & operator<< (std::ostream &os, IamPolicy const &rhs)
 
bool operator== (IamPolicy const &lhs, IamPolicy const &rhs)
 
bool operator< (IamPolicy const &lhs, IamPolicy const &rhs)
 
bool operator!= (IamPolicy const &lhs, IamPolicy const &rhs)
 
bool operator> (IamPolicy const &lhs, IamPolicy const &rhs)
 
bool operator<= (IamPolicy const &lhs, IamPolicy const &rhs)
 
bool operator>= (IamPolicy const &lhs, IamPolicy const &rhs)
 
bool operator== (KmsKeyName const &a, KmsKeyName const &b)
 
std::ostream & operator<< (std::ostream &os, KmsKeyName const &key)
 
StatusOr< KmsKeyNameMakeKmsKeyName (std::string const &full_name)
 Constructs a KmsKeyName from the given full_name. More...
 
bool operator== (Project const &a, Project const &b)
 
bool operator!= (Project const &a, Project const &b)
 
std::ostream & operator<< (std::ostream &os, Project const &p)
 
bool operator== (TracingOptions const &a, TracingOptions const &b)
 
template<typename T >
future< typename internal::make_ready_return< T >::type > make_ready_future (T &&t)
 Create a future<void> that is immediately ready. More...
 
future< void > make_ready_future ()
 Create a future<void> that is immediately ready. More...
 

Detailed Description

Contains all the Google Cloud C++ Library APIs.