Package com.google.api.gax.rpc

Interface Summary

Interface	Description
ApiCallContext	Context for an API call.
ApiStreamObserver<V>	Receives notifications from an observable stream of messages.
BatchingDescriptor<RequestT,ResponseT>	Interface which represents an object that transforms request/response data for the purposes of batching.
BidiStreamObserver<RequestT,ResponseT>
ClientStream<RequestT>	A wrapper used to send requests to the server.
ClientStreamReadyObserver<V>	A callback used to report that the ClientStream is ready to send more messages.
HeaderProvider	Provider of headers to put on http requests.
LongRunningClient	Implementation-agnostic interface for managing long-running operations.
PagedListDescriptor<RequestT,ResponseT,ResourceT>	An interface which provides the functionality to extract data from requests and inject data into requests for the purposes of page streaming.
PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT>	Interface for constructing futures which return PagedListResponse objects.
RequestParamsEncoder<RequestT>	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.
RequestParamsExtractor<RequestT>	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.
ResponseObserver<V>	Receives notifications from server-streaming calls.
StatusCode	Transport-specific status code.
StreamController	Allows the implementer of ResponseObserver to control the flow of responses.
TransportChannel	Class whose instances can issue RPCs on a particular transport.
TransportChannelProvider	Provides an interface to either build a TransportChannel or provide a fixed TransportChannel that will be used to make calls to a service.
WatchdogProvider

Class Summary

Class	Description
ApiCallContext.Key<T>	Key for api call context options key-value pair.
ApiClientHeaderProvider	Implementation of HeaderProvider that provides headers describing the API client library making API calls.
ApiClientHeaderProvider.Builder
ApiExceptionFactory	A factory class that returns the corresponding type of exception class from the given status code.
ApiExceptions	A utility class for working with ApiException.
Batch<RequestT,ResponseT>	A Batch contains a collection of requests that are to be batched into a single API call.
BatchedFuture<ResponseT>	An ApiFuture to be used with batching.
BatchedRequestIssuer<ResponseT>	BatchedRequestIssuer receives a response or an exception and waits to set the given batchedFuture until sendResult() is called.
BatcherFactory<RequestT,ResponseT>	A Factory class which, for each unique partitionKey, creates a trio including a ThresholdBatcher, BatchExecutor, and ThresholdBatchingForwarder.
BatchingCallable<RequestT,ResponseT>	A UnaryCallable which will batch requests based on the given BatchingDescriptor and BatcherFactory.
BatchingCallSettings<RequestT,ResponseT>	A settings class to configure a UnaryCallable for calls to an API method that supports batching.
BatchingCallSettings.Builder<RequestT,ResponseT>
BidiStream<RequestT,ResponseT>	A wrapper around a bidirectional stream.
BidiStreamingCallable<RequestT,ResponseT>	A BidiStreamingCallable is an immutable object which is capable of making RPC calls to bidirectional streaming API methods.
Callables	Class with utility methods to create callable objects using provided settings.
ClientContext	Encapsulates client state, including executor, credentials, and transport channel.
ClientContext.Builder
ClientSettings<SettingsT extends ClientSettings<SettingsT>>	A base settings class to configure a client class.
ClientSettings.Builder<SettingsT extends ClientSettings<SettingsT>,B extends ClientSettings.Builder<SettingsT,B>>
ClientStreamingCallable<RequestT,ResponseT>	A ClientStreamingCallable is an immutable object which is capable of making RPC calls to client streaming API methods.
ErrorDetails	This class contains a list of standard error messages that returns from server.
ErrorDetails.Builder
FixedHeaderProvider	An instance of HeaderProvider that always provides the same headers.
FixedTransportChannelProvider	An instance of TransportChannelProvider that always provides the same TransportChannel.
FixedWatchdogProvider	A watchdog provider which always returns the same watchdog instance provided to the provider during construction.
InstantiatingWatchdogProvider	A watchdog provider which instantiates a new provider on every request.
NoHeaderProvider	Implementation of HeaderProvider that provides empty headers.
OperationCallable<RequestT,ResponseT,MetadataT>	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.
OperationCallSettings<RequestT,ResponseT,MetadataT>	A settings class to configure an OperationCallable for calls to initiate, resume, and cancel a long-running operation.
OperationCallSettings.Builder<RequestT,ResponseT,MetadataT>
PageContext<RequestT,ResponseT,ResourceT>	The context for a page call.
PagedCallable<RequestT,ResponseT,PagedListResponseT>	A UnaryCallable which provides page streaming functionality for unary calls.
PagedCallSettings<RequestT,ResponseT,PagedListResponseT>	A settings class to configure a UnaryCallable for calls to an API method that supports page streaming.
PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT>
RequestParamsBuilder	This builder class builds a request params map that will be used by autogenerated implementation of RequestParamsExtractor.
RequestUrlParamsEncoder<RequestT>	The request params encoder, which encodes URL-encoded parameters in one URL parameters string.
ServerStream<V>	A blocking Iterable-style wrapper around server stream responses.
ServerStreamingCallable<RequestT,ResponseT>	A ServerStreamingCallable is an immutable object which is capable of making RPC calls to server streaming API methods.
ServerStreamingCallSettings<RequestT,ResponseT>	A settings class to configure a ServerStreamingCallable.
ServerStreamingCallSettings.Builder<RequestT,ResponseT>
StateCheckingResponseObserver<V>	Base implementation of ResponseObserver that performs state sanity checks.
StreamingCallSettings<RequestT,ResponseT>	A settings class to configure a streaming callable object for calls to a streaming API method.
StreamingCallSettings.Builder<RequestT,ResponseT>
StubSettings<SettingsT extends StubSettings<SettingsT>>	A base settings class to configure a client stub class.
StubSettings.Builder<SettingsT extends StubSettings<SettingsT>,B extends StubSettings.Builder<SettingsT,B>>
TranslatingUnaryCallable<InnerRequestT,InnerResponseT,OuterRequestT,OuterResponseT>	A UnaryCallable that translates request types and response types using the given transformers.
UnaryCallable<RequestT,ResponseT>	A UnaryCallable is an immutable object which is capable of making RPC calls to non-streaming API methods.
UnaryCallSettings<RequestT,ResponseT>	A base settings class to configure a UnaryCallable.
UnaryCallSettings.Builder<RequestT,ResponseT>	A base builder class for UnaryCallSettings.
Watchdog	Prevents the streams from hanging indefinitely.

Enum Summary

Enum	Description
StatusCode.Code

Exception Summary

Exception	Description
AbortedException	Exception thrown when the operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.
AlreadyExistsException	Exception thrown when some entity that we attempted to create (e.g., file or directory) already exists.
ApiException	Represents an exception thrown during an RPC call.
AsyncTaskException	This exception is used to preserve the caller's stacktrace when invoking an async task in a sync context.
CancelledException	The exception thrown when the operation was cancelled (typically by the caller).
DataLossException	Exception thrown due to unrecoverable data loss or corruption.
DeadlineExceededException	Exception thrown when deadline expired before operation could complete.
FailedPreconditionException	Exception thrown when the operation was rejected because the system is not in a state required for the operation's execution.
InternalException	Exception thrown due to internal errors.
InvalidArgumentException	Exception thrown when client specified an invalid argument.
NotFoundException	Exception thrown when some requested entity (e.g., file or directory) was not found.
OutOfRangeException	Exception thrown when the operation was attempted past the valid range.
PermissionDeniedException	Exception thrown when the caller does not have permission to execute the specified operation.
ProtocolBufferParsingException	Exception thrown when parsing protocol buffer message failed
ResourceExhaustedException	Exception thrown when some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
UnauthenticatedException	Exception thrown when the request does not have valid authentication credentials for the operation.
UnavailableException	Exception thrown when the service is currently unavailable.
UnimplementedException	Exception thrown when the operation is not implemented or not supported/enabled in this service.
UnknownException	Exception thrown due to an unknown error.
WatchdogTimeoutException	The marker exception thrown when a timeout is exceeded.