Contains all the Google Cloud C++ Library APIs.
Classes AsyncOperationRepresents a pending asynchronous operation.
AsyncStreamingReadWriteRpc<Request, Response>A streaming read-write RPC.
BackgroundThreadsA object representing the background threads available to a Client.
CompletionQueueCall the functor associated with asynchronous operations when they complete.
ConnectionOptions<ConnectionTraits>The configuration parameters for client connections.
CredentialsAn opaque representation of the authentication configuration.
ErrorInfoDescribes the cause of the error with structured details.
future<T>Implement ISO/IEC TS 19571:2016 future<T>.
Specialize ISO/IEC TS 19571:2016 future for void.
GenericPollingPolicy<Retry, Backoff>Construct a polling policy from existing Retry and Backoff policies.
KmsKeyNameThis class identifies a Google Cloud KMS Key.
LocationA representation of a Cloud Location.
LogBackendThe logging backend interface.
Logger<bool>Define the class to capture a log message.
Logger< false >Define the logger for a disabled log level.
LogSinkA sink to receive log records.
OptionsA class that holds option structs indexed by their type.
PollingPolicyControl the Cloud C++ client library behavior with respect to polling on long running operations.
ProjectThis class identifies a Cloud Project.
promise<T>Implement ISO/IEC TS 19571:2016 promise<T>.
Specialize ISO/IEC TS 19571:2016 promise for void.
ProxyConfigThe configuration for a HTTP Proxy.
RetryPolicyDefine the interface for retry policies.
RuntimeStatusErrorA runtime error that wraps a google::cloud::Status.
Represents success or an error with info about the error.
StatusOr<T>Holds a value or a Status indicating why there is no value.
A StreamRange<T> is a range of StatusOr<T> where the end-of-stream is indicated by a non-OK Status.
The configuration parameters for RPC/protobuf tracing.
Structs AccessTokenRepresents an access token with a known expiration time.
AccessTokenLifetimeOptionConfigure the access token lifetime.
AsyncTimerResultThe result of an async timer operation.
Configure the "authority" attribute.
CARootsFilePathOptionConfigures a custom CA (Certificates Authority) certificates file.
An option to inject custom headers into the request.
DelegatesOptionConfigure the delegates for MakeImpersonateServiceAccountCredentials()
Let the server make retry decisions, when applicable.
EndpointOptionChange the endpoint.
ExperimentalTagAn argument type to indicate experimental functions.
FieldMaskOptionConfigure server-side filtering.
GrpcBackgroundThreadPoolSizeOptionThe size of the background thread pool.
GrpcBackgroundThreadsFactoryOptionChanges the BackgroundThreadsFactory.
The native grpc::ChannelArguments object.
A string-string map of arguments for grpc::ChannelArguments::SetString.
The CompletionQueue to use for background gRPC work.
The gRPC compression algorithm used by clients/operations configured with this object.
GrpcCredentialOptionThe gRPC credentials used by clients configured with this object.
GrpcNumChannelsOptionThe number of transport channels to create.
GrpcTracingOptionsOptionThe TracingOptions to use when printing grpc protocol buffer messages.
Sets the interface name to use as outgoing network interface.
LoggingComponentsOptionEnable logging for a set of components.
LogRecordRepresents a single log message.
NoAwaitTag NullStreamImplements operator<< for all types, without any effect.
OpenTelemetryTracingOptionEnables tracing with OpenTelemetry
ProxyOptionConfigure the HTTP Proxy.
QuotaUserOptionConfigure the QuotaUser system parameter.
RestTracingOptionsOptionThe TracingOptions to use when printing REST transport http messages.
RPC request metadata.
ScopesOptionConfigure the scopes for MakeImpersonateServiceAccountCredentials()
Timeout for the server to finish processing the request.
UnifiedCredentialsOptionA wrapper to store credentials into an options.
UserAgentProductsOptionUser-agent products to include with each request.
UserIpOptionConfigure the UserIp system parameter.
UserProjectOptionSpecifies a project for quota and billing purposes.
Enums IdempotencyWhether a request is idempotent.
SeverityDefine the severity levels for Google Cloud Platform C++ Libraries logging.
StatusCodeWell-known status codes with grpc::StatusCode-compatible values.
Create a future that is immediately ready.
Parameters Name Descriptiont T &&
typename T auto make_ready_future()
Create a future that is immediately ready.
Returns Type Descriptionfuture< void > MakeStatusFromRpcError(grpc::Status const &)
Creates a google::cloud::Status from a grpc::Status.
status grpc::Status const &
google::cloud::Status MakeStatusFromRpcError(grpc::StatusCode, std::string)
Creates a google::cloud::Status from a grpc::StatusCode and description.
code grpc::StatusCode
what std::string
google::cloud::Status MakeStatusFromRpcError(google::rpc::Status const &)
Creates a google::cloud::Status from a google:rpc::Status proto.
Some gRPC services return the google::rpc::Status proto for errors. The libraries in google-cloud-cpp represent these errors using a google::cloud::Status.
proto google::rpc::Status const &
google::cloud::Status MakeKmsKeyName(std::string const &)
Constructs a KmsKeyName from the given full_name.
Returns a non-OK Status if full_name is improperly formed.
full_name std::string const &
StatusOr< KmsKeyName > MakeLocation(std::string const &)
Constructs a Location from the given full_name.
Returns a non-OK Status if full_name is improperly formed.
full_name std::string const &
StatusOr< Location > ParseSeverity(std::string const &)
Convert a human-readable representation to a Severity.
Parameter Name Descriptionname std::string const &
absl::optional< Severity > MakeProject(std::string const &)
Constructs a Project from the given full_name.
Returns a non-OK Status if full_name is improperly formed.
full_name std::string const &
StatusOr< Project > StatusCodeToString(StatusCode)
Convert code to a human readable string.
code StatusCode
std::string make_status_or(T) Parameters Name Description rhs T
typename T StatusOr< T > AddUniverseDomainOption(ExperimentalTag, Options)
Creates an Options containing the UnifiedCredentialsOption and its corresponding UniverseDomainOption.
Uses the UnifiedCredentialsOption in options or ApplicationDefaultCredentials if UnifiedCredentialsOption is not found, and retrieves the universe_domain from those Credentials and sets the UniverseDomainOption to the result.
If the Metadata Server needs to be called, this function checks the options for the UniverseDomainRetryPolicyOption and UniverseDomainBackoffPolicyOption. If either policy option is not present a default policy is used for the corresponding policy option.
If everything succeeds, the Options returned contain both the UnifiedCredentialsOption and the UniverseDomainOption. If the RetryPolicy becomes exhausted or other errors are encountered, that Status is returned.
tag ExperimentalTag
options Options
StatusOr< Options > GetUniverseDomain(ExperimentalTag, Credentials const &, Options const &)
Interrogates the provided credentials for the universe_domain.
If the Metadata Server needs to be called, this function checks the options for the UniverseDomainRetryPolicyOption and UniverseDomainBackoffPolicyOption. If either policy option is not present a default policy is used for the corresponding policy option.
If successful the universe_domain value is returned, otherwise a Status indicating the error encountered is returned.
tag ExperimentalTag
credentials Credentials const &
options Options const &
StatusOr< std::string > version_major()
The Google Cloud C++ Client major version.
Returns Type Descriptionint constexpr version_minor()
The Google Cloud C++ Client minor version.
Returns Type Descriptionint constexpr version_patch()
The Google Cloud C++ Client patch version.
Returns Type Descriptionint constexpr version_pre_release()
The Google Cloud C++ Client pre-release version.
Returns Type Descriptionchar const * version()
A single integer representing the Major/Minor/Patch version.
Returns Type Descriptionint constexpr version_string()
The version as a string, in MAJOR.MINOR.PATCH[-PRE][+gitrev] format.
Returns Type Descriptionstd::string Type Aliases CommonOptionList
Alias Of: OptionList< EndpointOption, UserAgentProductsOption, LoggingComponentsOption, UserProjectOption, AuthorityOption, CustomHeadersOption >
A list of all the common options.
BackoffPolicyAlias Of: ::google::cloud::internal::BackoffPolicy
The base class for backoff policies.
ExponentialBackoffPolicyAlias Of: google::cloud::internal::ExponentialBackoffPolicy
A truncated exponential backoff policy with randomized periods.
UnifiedCredentialsOptionListAlias Of: OptionList< AccessTokenLifetimeOption, CARootsFilePathOption, DelegatesOption, ScopesOption, LoggingComponentsOption, UnifiedCredentialsOption, experimental::ClientSslCertificateOption, experimental::CAInMemoryOption >
A list of options related to authentication.
BackgroundThreadsFactoryAlias Of: std::function< std::unique_ptr< BackgroundThreads >()>
Alias Of: OptionList< GrpcCredentialOption, GrpcCompressionAlgorithmOption, GrpcNumChannelsOption, GrpcChannelArgumentsOption, GrpcChannelArgumentsNativeOption, GrpcTracingOptionsOption, GrpcBackgroundThreadPoolSizeOption, GrpcCompletionQueueOption, GrpcBackgroundThreadsFactoryOption >
A list of all the gRPC options.
IamUpdaterAlias Of: 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.
The updater is called with a recently fetched policy, and should either return an empty optional if no changes are required, or return a new policy to be set. In the latter case the updater should either (1) set the etag of the returned policy to that of the recently fetched policy (strongly suggested), or (2) not set the etag at all.
In case (1) if the etag does not match the existing policy (i.e., there has been an intermediate update), this update is dropped and a new cycle is initiated. In case (2) the existing policy is overwritten blindly.
Alias Of: absl::optional< T >
Alias template for google::cloud::optional.
absl::optional<T> directly.
OptionList
Alias Of: internal::TypeList< T... >
A template to hold a list of "option" types.
This can be a useful way to create meaningful lists of options. For example, there could be a list containing all the gRPC options. Or a list of all ProductX options. This gives us a way to link to lists of options with doxygen, and to do some checking about what options a function may expect.
RestOptionListAlias Of: ::google::cloud::OptionList< QuotaUserOption, RestTracingOptionsOption, ServerTimeoutOption, UserIpOption, Interface, experimental::SslCtxCallbackOption >
The complete list of options accepted by CurlRestClient
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4