Package com.google.api.gax.httpjson (2.41.0)

GitHub Repository

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.api.gax.httpjson.HttpJsonLongRunningClient Implementation of LongRunningClient based on REST transport.

Public for technical reasons. For internal use only.

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.api.gax.httpjson.HttpJsonCallSettings HTTP-specific settings for creating callables.

Classes

Class Description
com.google.api.gax.httpjson.ApiMethodDescriptor
com.google.api.gax.httpjson.ApiMethodDescriptor.Builder
com.google.api.gax.httpjson.ForwardingHttpJsonClientCall A HttpJsonClientCall which forwards all of its methods to another HttpJsonClientCall.
com.google.api.gax.httpjson.ForwardingHttpJsonClientCall.SimpleForwardingHttpJsonClientCall A simplified version of ForwardingHttpJsonClientCall where subclasses can pass in a HttpJsonClientCall as the delegate.
com.google.api.gax.httpjson.ForwardingHttpJsonClientCallListener A HttpJsonClientCall.Listener which forwards all of its methods to another HttpJsonClientCall.Listener.
com.google.api.gax.httpjson.ForwardingHttpJsonClientCallListener.SimpleForwardingHttpJsonClientCallListener A simplified version of ForwardingHttpJsonClientCallListener where subclasses can pass in a HttpJsonClientCall.Listener as the delegate.
com.google.api.gax.httpjson.GaxHttpJsonProperties Provides properties of the GAX-HTTPJSON library.
com.google.api.gax.httpjson.HttpHeadersUtils This class is for internal use only and is public for technical reasons.
com.google.api.gax.httpjson.HttpJsonCallContext HttpJsonCallContext encapsulates context data used to make an http-json call.

HttpJsonCallContext is immutable in the sense that none of its methods modifies the HttpJsonCallContext itself or the underlying data. Methods of the form withX return

com.google.api.gax.httpjson.HttpJsonCallOptions Options for an http-json call, including deadline and credentials.
com.google.api.gax.httpjson.HttpJsonCallOptions.Builder
com.google.api.gax.httpjson.HttpJsonCallSettings.Builder
com.google.api.gax.httpjson.HttpJsonClientCall An instance of a call to a remote method. A call will send zero or more request messages to the server and receive zero or more response messages back.

Instances are created by a HttpJsonChannel and used by stubs to invoke their remote

com.google.api.gax.httpjson.HttpJsonClientCall.Listener Callbacks for receiving metadata, response messages and completion status from the server.

Implementations are discouraged to block for extended periods of time. Implementations are not required to be thread-safe, but they must not be thread-hostile. The caller is free to call

com.google.api.gax.httpjson.HttpJsonHeaderEnhancers Utility class that creates instances of HttpJsonHeaderEnhancer.
com.google.api.gax.httpjson.HttpJsonMetadata
com.google.api.gax.httpjson.HttpJsonOperationSnapshot Implementation of OperationSnapshot based on REST transport.

Public for technical reasons. For internal use only.

com.google.api.gax.httpjson.HttpJsonOperationSnapshot.Builder
com.google.api.gax.httpjson.HttpJsonOperationSnapshotCallable A UnaryCallable that wraps a UnaryCallable returning an Operation and returns an OperationSnapshot instead.

Public for technical reasons. For internal use only.

com.google.api.gax.httpjson.HttpJsonServerStreamingRequestParamCallable
com.google.api.gax.httpjson.HttpJsonStatusCode A failure code specific to an HTTP call.
com.google.api.gax.httpjson.HttpJsonTransportChannel Implementation of TransportChannel based on http/json.
com.google.api.gax.httpjson.HttpJsonTransportChannel.Builder
com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider InstantiatingHttpJsonChannelProvider is a TransportChannelProvider which constructs a ManagedHttpJsonChannel with a number of configured inputs every time getChannel(...) is called. These inputs include a port, a service address, and credentials.

The credentials can either be supplied directly (by providing a FixedCredentialsProvider to

com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
com.google.api.gax.httpjson.ManagedHttpJsonChannel Implementation of HttpJsonChannel which can issue http-json calls.
com.google.api.gax.httpjson.ManagedHttpJsonChannel.Builder
com.google.api.gax.httpjson.ProtoMessageRequestFormatter Creates parts of a HTTP request from a protobuf message.
com.google.api.gax.httpjson.ProtoMessageRequestFormatter.Builder
com.google.api.gax.httpjson.ProtoMessageResponseParser The implementation of HttpResponseParser which works with protobuf messages.
com.google.api.gax.httpjson.ProtoMessageResponseParser.Builder
com.google.api.gax.httpjson.ProtoOperationTransformers Public for technical reasons; intended for use by generated code.
com.google.api.gax.httpjson.ProtoOperationTransformers.MetadataTransformer
com.google.api.gax.httpjson.ProtoOperationTransformers.ResponseTransformer
com.google.api.gax.httpjson.ProtoRestSerializer This class serializes/deserializes protobuf Message for REST interactions. It serializes requests protobuf messages into REST messages, splitting the message into the JSON request body, URL path parameters, and query parameters. It deserializes JSON responses into response protobuf message.

Interfaces

Interface Description
com.google.api.gax.httpjson.FieldsExtractor A functional interface to be implemented for each request message to extract specific fields from it. For advanced usage only.
com.google.api.gax.httpjson.HttpJsonChannel HttpJsonChannel contains the functionality to issue http-json calls.
com.google.api.gax.httpjson.HttpJsonClientInterceptor Interface for intercepting outgoing calls before they are dispatched by a HttpJsonChannel.

The interceptor may be called for multiple calls by one or more threads without completing the previous ones first. The implementations must be thread-safe.

com.google.api.gax.httpjson.HttpJsonHeaderEnhancer Interface for functionality to enhance headers for an http-json call.
com.google.api.gax.httpjson.HttpJsonInterceptorProvider Provider of custom REST ClientInterceptors.
com.google.api.gax.httpjson.HttpRequestFormatter Interface for classes that create parts of HTTP requests from a parameterized message.
com.google.api.gax.httpjson.HttpResponseParser Interface for classes that parse parts of HTTP responses into the parameterized message type.
com.google.api.gax.httpjson.OperationSnapshotFactory A factory which creates an OperationSnapshot from an initial request message (the one which started a long running operation) and an operation response (which may be either initial request response or the polling request response).
com.google.api.gax.httpjson.PollingRequestFactory A factory which creates a subsequent polling request from a compund operation id.

Enums

Enum Description
com.google.api.gax.httpjson.ApiMethodDescriptor.MethodType

Exceptions

Exception Description
com.google.api.gax.httpjson.HttpJsonStatusRuntimeException HTTP status code in RuntimeException form, for propagating status code information via exceptions.
com.google.api.gax.httpjson.RestSerializationException An exception thrown when a protobuf message cannot be serialized/deserialized for REST interactions.