All Classes and Interfaces
Class
Description
Exception thrown when the operation was aborted, typically due to a concurrency issue like
sequencer check failures, transaction aborts, etc.
AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>,CollectionT extends AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT,CollectionT>>
Partial implementation of
FixedSizeCollection.AbstractPage<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>>
Partial implementation of
AsyncPage.AbstractPagedListResponse<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>,CollectionT extends AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT,CollectionT>>
Partial implementation of
PagedListResponse.A simple ThresholdBatchReceiver that just accumulates batches.
Exception thrown when some entity that we attempted to create (e.g., file or directory) already
exists.
Context for an API call.
Key for api call context options key-value pair.
ApiCallContextOptions encapsulates additional call options to pass in a
ApiCallContextImplementation of HeaderProvider that provides headers describing the API client library making
API calls.
Represents an exception thrown during an RPC call.
A factory class that returns the corresponding type of exception class from the given status
code.
A utility class for working with
ApiException.Receives notifications from an observable stream of messages.
Implementations of this class trace the logical flow of a google cloud client.
A context class to be used with
ApiTracer.inScope() and a try-with-resources block.A factory to create new instances of
ApiTracers.The type of operation the
ApiTracer is tracing.An AsyncPage extends a
Page object with a getNextPageAsync method.This exception is used to preserve the caller's stacktrace when invoking an async task in a sync
context.
Represents a resource running in the background that needs to be shut down for resources to be
released.
Treats a collection of background resources as a single background resource.
A base implementation of
ApiTracer that does nothing.Base factory that will build
ApiTracers that do nothing.A Background resource that does nothing.
A basic implementation of
ResultRetryAlgorithm.A Batch contains a collection of requests that are to be batched into a single API call.
An ApiFuture to be used with batching.
BatchedRequestIssuer receives a response or an exception and waits to set the given batchedFuture
until sendResult() is called.
This class contains the element and its corresponding unresolved future, which would be resolved
when batch is
successful or failed.Represents a batching context where individual elements will be accumulated and flushed in a
large batch request at some point in the future.
A Factory class which, for each unique partitionKey, creates a trio including a ThresholdBatcher,
BatchExecutor, and ThresholdBatchingForwarder.
Queues up the elements until
BatcherImpl.flush() is called; once batching is over, returned future
resolves.A
UnaryCallable which will batch requests based on the given BatchingDescriptor and
BatcherFactory.This is an extension of
UnaryCallSettings class to configure a UnaryCallable for
calls to an API method that supports batching.A settings class to configure a
UnaryCallable for calls to an API method that supports
batching.A base builder class for
BatchingCallSettings.An adapter that packs and unpacks the elements in and out of batch requests and responses.
Interface which represents an object that transforms request/response data for the purposes of
batching.
Represents exception occurred during batching.
Wraps a
FlowController for use by batching.Adapter to pack individual elements into a larger batch request.
Represents the batching settings to use for an API method that is capable of batching.
See the class documentation of
BatchingSettings for a description of the different
values that can be set.The interface representing a threshold to be used in ThresholdBatcher.
Factory methods for general-purpose batching thresholds.
Represent the resource used by a batch including element and byte.
A wrapper around a bidirectional stream.
A BidiStreamingCallable is an immutable object which is capable of making RPC calls to
bidirectional streaming API methods.
Class with utility methods to create callable objects using provided settings.
The exception thrown when the operation was cancelled (typically by the caller).
Encapsulates client state, including executor, credentials, and transport channel.
A base settings class to configure a client class.
ClientSettings.Builder<SettingsT extends ClientSettings<SettingsT>,B extends ClientSettings.Builder<SettingsT,B>>
A wrapper used to send requests to the server.
A ClientStreamingCallable is an immutable object which is capable of making RPC calls to client
streaming API methods.
A callback used to report that the
ClientStream is ready to send more messages.Data class representing context_aware_metadata.json file.
Provides an interface to hold and acquire the credentials that will be used to call the service.
Exception thrown due to unrecoverable data loss or corruption.
Exception thrown when deadline expired before operation could complete.
The retry executor which executes attempts in the current thread, potentially causing the current
thread to sleep for the specified amount of time before execution.
Distribution records values from
0 (inclusive) to endValue (exclusive) and
computes their percentiles.Settings for dynamic flow control
Interface representing an object that provides a numerical count given an object of the
parameterized type.
EndpointContext is an internal class used by the client library to resolve the endpoint.
Provides an interface to provide the environment variable values.
This class contains a list of standard error messages that returns from server.
ExecutorAsBackgroundResource wraps an
ExecutorService so that it can be used as a BackgroundResource.Provides an interface to either build a ScheduledExecutorService or provide a fixed
ScheduledExecutorService that will be used to make calls to a service.
The timed poll algorithm which uses jittered exponential backoff factor for calculating the next
poll execution time and throws
PollException in case if total timeout or total number of
attempts is reached.The timed retry algorithm which uses jittered exponential backoff factor for calculating the next
attempt execution time.
Exception thrown when the operation was rejected because the system is not in a state required
for the operation's execution.
FixedCredentialsProvider is a CredentialsProvider which always provides the same credentials.
FixedExecutorProvider is an ExecutorProvider which always returns the same executor.
An instance of HeaderProvider that always provides the same headers.
A FixedSizeCollection object wraps multiple API list method responses into a single collection
with a fixed number of elements.
An instance of TransportChannelProvider that always provides the same TransportChannel.
A watchdog provider which always returns the same watchdog instance provided to the provider
during construction.
Record the statistics of flow control events.
A flow control event.
Provides flow control capability.
Base exception that signals a flow control state.
Runtime exception that can be used in place of FlowControlException when an unchecked exception
is required.
Enumeration of behaviors that FlowController can use in case the flow control limits are
exceeded.
Exception thrown when client-side flow control is enforced based on the maximum number of
outstanding in-memory elements.
Exception thrown when client-side flow control is enforced based on the maximum number of
unacknowledged in-memory bytes.
Settings for
FlowController.Provides properties of the GAX library.
GoogleCredentialsProvider acquires credentials using Application Default Credentials.
Provider of headers to put on http requests.
InstantiatingChannelProvider is an ExecutorProvider which constructs a new
ScheduledExecutorService every time getExecutor() is called.
A watchdog provider which instantiates a new provider on every request.
Exception thrown due to internal errors.
Exception thrown when client specified an invalid argument.
Implementation-agnostic interface for managing long-running operations.
A value class to represent the name of the RPC method in an
ApiTracer.Provides an interface for metrics recording.
This class computes generic metrics that can be observed in the lifecycle of an RPC operation.
A
ApiTracerFactory to build instances of MetricsTracer.Provider class for mutual TLS.
The policy for mutual TLS endpoint usage.
Internal class offering helper methods for registering methods/classes for reflection.
NoCredentialsProvider is a CredentialsProvider which always returns null.
Implementation of HeaderProvider that provides empty headers.
A future which cannot be cancelled from the external package.
Exception thrown when some requested entity (e.g., file or directory) was not found.
A threshold which accumulates a count based on the provided ElementCounter.
Implementation of
ApiTracer that uses OpenCensus.A
ApiTracerFactory to build instances of OpencensusTracer.OpenTelemetry implementation of recording metrics.
An OperationCallable is an immutable object which is capable of initiating RPC calls to
long-running API methods and returning an
OperationFuture to manage the polling of the
Operation and getting the response.A settings class to configure an
OperationCallable for calls to initiate, resume, and
cancel a long-running operation.An ApiFuture which tracks polling of a service.
An ApiFuture which tracks polling of a service.
Operation polling algorithm, which keeps retrying until
OperationSnapshot.isDone() is
true.A snapshot of a long-running operation.
Operation timed polling algorithm, which uses exponential backoff factor for determining when the
next polling operation should be executed.
Exception thrown when the operation was attempted past the valid range.
A Page object wraps an API list method response.
The context for a page call.
A UnaryCallable which provides page streaming functionality for unary calls.
A settings class to configure a
UnaryCallable for calls to an API method that supports
page streaming.An interface which provides the functionality to extract data from requests and inject data into
requests for the purposes of page streaming.
Response for paged results from a list API method
Interface for constructing futures which return PagedListResponse objects.
Utility class for
Pages.Exception thrown when the caller does not have permission to execute the specified operation.
PollException is thrown when polling algorithm exceeds total timeout or total number of
attempts.Exception thrown when parsing protocol buffer message failed
QuotaProjectIdHidingCredentials is intended to be used to wrap a Credentials to
hide quota project idA request mutator takes a
request message, applies some Function to it, and then returns
the modified request message.This builder class builds a request params map that will be used by autogenerated implementation
of
RequestParamsExtractor.A request params encoder takes a
request object and encodes some (or all) of its
parameters in a string form following specific parameter extraction and string encoding rules,
defined by concrete implementations of this interface.A request params extractor takes a
request message, extracts specific field values from
it, converts them in strings and returns them as key-value pairs, where a key is a request field
name and a value is a string representation of a field value.The request params encoder, which encodes URL-encoded parameters in one URL parameters string.
An exception occurs when some background resource is not able to close properly.
Exception thrown when some resource has been exhausted, perhaps a per-user quota, or perhaps the
entire file system is out of space.
Receives notifications from server-streaming calls.
Same as
ResultRetryAlgorithmWithContext, but without methods that accept a RetryingContext.A result retry algorithm is responsible for the following operations (based on the response
returned by the previous attempt or on the thrown exception):
Accepting a task for retry so another attempt will be made.
The retry algorithm, which makes decision based either on the thrown exception or the returned
response, and the execution time settings of the previous attempt.
Context for a retryable operation.
A retrying executor is responsible for the following operations:
Creating first attempt
RetryingFuture, which acts as a facade, hiding from client
code the actual execution of scheduled retry attempts.A
RetryingExecutor that accepts a per-operation context.Represents a retrying future.
Holds the parameters for retry or poll logic with jitter, timeout and exponential
backoff.
A base builder class for
RetrySettings.The retry executor which uses
ScheduledExecutorService to schedule an attempt tasks.A blocking Iterable-style wrapper around server stream responses.
A wrapper exception thrown by
ServerStreamingAttemptCallable to communicate additional
context to the StreamingRetryAlgorithm and to pass the original cancellation stack trace
to RetryingServerStreamingCallable.A ServerStreamingCallable is an immutable object which is capable of making RPC calls to server
streaming API methods.
A settings class to configure a
ServerStreamingCallable.Simplest implementation of a
StreamResumptionStrategy which returns the initial request
for unstarted streams.A value class to represent the name of the operation in an
ApiTracer.Base implementation of
ResponseObserver that performs state sanity checks.Transport-specific status code.
Allows the implementer of
ResponseObserver to control the flow of responses.A settings class to configure a streaming callable object for calls to a streaming API method.
The streaming retry algorithm, which makes decision based either on the thrown exception and the
execution time settings of the previous attempt.
This is part of the server streaming retry api.
A base settings class to configure a client stub class.
StubSettings.Builder<SettingsT extends StubSettings<SettingsT>,B extends StubSettings.Builder<SettingsT,B>>
Queues up elements until either a duration of time has passed or any threshold in a given set of
thresholds is breached, and then delivers the elements in a batch to the consumer.
Builder for a ThresholdBatcher.
Interface representing an object that receives batches from a ThresholdBatcher and takes action
on them.
Timed attempt execution settings.
Same as
TimedRetryAlgorithmWithContext, but without methods that accept a RetryingContext.A timed retry algorithm is responsible for the following operations, based on the previous
attempt settings and current time:
Creating first attempt
TimedAttemptSettings.This callable wraps a batching callable chain in a
ApiTracer.A wrapper callable that will wrap a callable chain in a trace.
A wrapper callable that will wrap a callable chain in a trace.
This callable wraps a
OperationCallable in a ApiTracer.Traces the initial RPC of a long running operation.
A wrapper callable that will wrap a callable chain in a trace.
This callable wraps a callable chain in a
ApiTracer.A UnaryCallable that translates request types and response types using the given transformers.
Class whose instances can issue RPCs on a particular transport.
Provides an interface to either build a TransportChannel or provide a fixed TransportChannel that
will be used to make calls to a service.
A UnaryCallable is an immutable object which is capable of making RPC calls to non-streaming API
methods.
A base settings class to configure a UnaryCallable.
A base builder class for
UnaryCallSettings.Exception thrown when the request does not have valid authentication credentials for the
operation.
Exception thrown when the service is currently unavailable.
Exception thrown when the operation is not implemented or not supported/enabled in this service.
Exception thrown due to an unknown error.
Prevents the streams from hanging indefinitely.
The marker exception thrown when a timeout is exceeded.