A B C D E F G H I L M N O P R S T U V W

A

AbortedException - Exception in com.google.api.gax.rpc

Exception thrown when the operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.

AbortedException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.AbortedException

AbortedException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.AbortedException

AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>,CollectionT extends AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT,CollectionT>> - Class in com.google.api.gax.paging

Partial implementation of FixedSizeCollection.

AbstractFixedSizeCollection(List<PageT>, int) - Constructor for class com.google.api.gax.paging.AbstractFixedSizeCollection

AbstractPage<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>> - Class in com.google.api.gax.paging

Partial implementation of AsyncPage.

AbstractPage(PageContext<RequestT, ResponseT, ResourceT>, ResponseT) - Constructor for class com.google.api.gax.paging.AbstractPage

AbstractPagedListResponse<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>,CollectionT extends AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT,CollectionT>> - Class in com.google.api.gax.paging

Partial implementation of PagedListResponse.

AbstractPagedListResponse(PageT, CollectionT) - Constructor for class com.google.api.gax.paging.AbstractPagedListResponse

acceptsPoolSize() - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

acceptsPoolSize() - Method in interface com.google.api.gax.rpc.TransportChannelProvider

Reports whether this provider allows pool size customization.

accumulate(E) - Method in interface com.google.api.gax.batching.BatchingThreshold

Presents the element to the threshold for the attribute of interest to be accumulated.

accumulate(E) - Method in class com.google.api.gax.batching.NumericThreshold

AccumulatingBatchReceiver<T> - Class in com.google.api.gax.batching

A simple ThresholdBatchReceiver that just accumulates batches.

AccumulatingBatchReceiver(ApiFuture<?>) - Constructor for class com.google.api.gax.batching.AccumulatingBatchReceiver

add(E) - Method in class com.google.api.gax.batching.ThresholdBatcher

Adds an element to the batcher.

addListener(Runnable, Executor) - Method in class com.google.api.gax.longrunning.OperationFutureImpl

all() - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Construct a UnaryCallable that will buffer the entire stream into memory before completing.

AlreadyExistsException - Exception in com.google.api.gax.rpc

Exception thrown when some entity that we attempted to create (e.g., file or directory) already exists.

AlreadyExistsException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.AlreadyExistsException

AlreadyExistsException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.AlreadyExistsException

ApiCallContext - Interface in com.google.api.gax.rpc

Context for an API call.

ApiClientHeaderProvider - Class in com.google.api.gax.rpc

Implementation of HeaderProvider that provides headers describing the API client library making API calls.

ApiClientHeaderProvider(ApiClientHeaderProvider.Builder) - Constructor for class com.google.api.gax.rpc.ApiClientHeaderProvider

ApiClientHeaderProvider.Builder - Class in com.google.api.gax.rpc

ApiException - Exception in com.google.api.gax.rpc

Represents an exception thrown during an RPC call.

ApiException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.ApiException

ApiException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.ApiException

ApiExceptionFactory - Class in com.google.api.gax.rpc

A factory class that returns the corresponding type of exception class from the given status code.

ApiExceptions - Class in com.google.api.gax.rpc

A utility class for working with ApiException.

ApiStreamObserver<V> - Interface in com.google.api.gax.rpc

Receives notifications from an observable stream of messages.

ApiTracer - Interface in com.google.api.gax.tracing

Implementations of this class trace the logical flow of a google cloud client.

ApiTracer.Scope - Interface in com.google.api.gax.tracing

A context class to be used with ApiTracer.inScope() and a try-with-resources block.

ApiTracerFactory - Interface in com.google.api.gax.tracing

A factory to create new instances of ApiTracers.

ApiTracerFactory.OperationType - Enum in com.google.api.gax.tracing

The type of operation the ApiTracer is tracing.

appendRequest(RequestT) - Method in interface com.google.api.gax.batching.RequestBuilder

appendToken(StringBuilder, String) - Static method in class com.google.api.gax.rpc.ApiClientHeaderProvider

applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder<?, ?>>, ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>) - Static method in class com.google.api.gax.rpc.ClientSettings.Builder

Applies the given settings updater function to the given method settings builders.

applyToAllUnaryMethods(Iterable<UnaryCallSettings.Builder<?, ?>>, ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>) - Static method in class com.google.api.gax.rpc.StubSettings.Builder

Applies the given settings updater function to the given method settings builders.

AsyncPage<ResourceT> - Interface in com.google.api.gax.paging

An AsyncPage extends a Page object with a getNextPageAsync method.

AsyncTaskException - Exception in com.google.api.gax.rpc

This exception is used to preserve the caller's stacktrace when invoking an async task in a sync context.

attemptCancelled() - Method in interface com.google.api.gax.tracing.ApiTracer

Add an annotation that the attempt was cancelled by the user.

attemptCancelled() - Method in class com.google.api.gax.tracing.NoopApiTracer

attemptCancelled() - Method in class com.google.api.gax.tracing.OpencensusTracer

Add an annotation that the attempt was cancelled by the user.

attemptFailed(Throwable, Duration) - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that the attempt failed, but another attempt will be made after the delay.

attemptFailed(Throwable, Duration) - Method in class com.google.api.gax.tracing.NoopApiTracer

attemptFailed(Throwable, Duration) - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that the attempt failed, but another attempt will be made after the delay.

attemptFailedRetriesExhausted(Throwable) - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that the attempt failed and that no further attempts will be made because retry limits have been reached.

attemptFailedRetriesExhausted(Throwable) - Method in class com.google.api.gax.tracing.NoopApiTracer

attemptFailedRetriesExhausted(Throwable) - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that the attempt failed and that no further attempts will be made because retry limits have been reached.

attemptPermanentFailure(Throwable) - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that the attempt failed and that no further attempts will be made because the last error was not retryable.

attemptPermanentFailure(Throwable) - Method in class com.google.api.gax.tracing.NoopApiTracer

attemptPermanentFailure(Throwable) - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that the attempt failed and that no further attempts will be made because the last error was not retryable.

attemptStarted(int) - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that an attempt is about to start.

attemptStarted(int) - Method in class com.google.api.gax.tracing.NoopApiTracer

attemptStarted(int) - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that an attempt is about to start.

attemptSucceeded() - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that the attempt succeeded.

attemptSucceeded() - Method in class com.google.api.gax.tracing.NoopApiTracer

attemptSucceeded() - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that the attempt succeeded.

awaitTermination(long, TimeUnit) - Method in interface com.google.api.gax.core.BackgroundResource

Blocks until all work has completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

awaitTermination(long, TimeUnit) - Method in class com.google.api.gax.core.BackgroundResourceAggregation

awaitTermination(long, TimeUnit) - Method in class com.google.api.gax.core.BaseBackgroundResource

awaitTermination(long, TimeUnit) - Method in class com.google.api.gax.core.ExecutorAsBackgroundResource

B

BackgroundResource - Interface in com.google.api.gax.core

Represents a resource running in the background that needs to be shut down for resources to be released.

BackgroundResourceAggregation - Class in com.google.api.gax.core

Treats a collection of background resources as a single background resource.

BackgroundResourceAggregation(List<BackgroundResource>) - Constructor for class com.google.api.gax.core.BackgroundResourceAggregation

BaseBackgroundResource - Class in com.google.api.gax.core

A Background resource that does nothing.

BaseBackgroundResource() - Constructor for class com.google.api.gax.core.BaseBackgroundResource

BasicResultRetryAlgorithm<ResponseT> - Class in com.google.api.gax.retrying

A basic implementation of ResultRetryAlgorithm.

BasicResultRetryAlgorithm() - Constructor for class com.google.api.gax.retrying.BasicResultRetryAlgorithm

Batch<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A Batch contains a collection of requests that are to be batched into a single API call.

Batch(BatchingDescriptor<RequestT, ResponseT>, RequestT, UnaryCallable<RequestT, ResponseT>, BatchedFuture<ResponseT>) - Constructor for class com.google.api.gax.rpc.Batch

BatchedFuture<ResponseT> - Class in com.google.api.gax.rpc

An ApiFuture to be used with batching.

BatchedFuture() - Constructor for class com.google.api.gax.rpc.BatchedFuture

BatchedRequestIssuer<ResponseT> - Class in com.google.api.gax.rpc

BatchedRequestIssuer receives a response or an exception and waits to set the given batchedFuture until sendResult() is called.

BatchedRequestIssuer(BatchedFuture<ResponseT>, long) - Constructor for class com.google.api.gax.rpc.BatchedRequestIssuer

BatcherFactory<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A Factory class which, for each unique partitionKey, creates a trio including a ThresholdBatcher, BatchExecutor, and ThresholdBatchingForwarder.

BatcherFactory(BatchingDescriptor<RequestT, ResponseT>, BatchingSettings, ScheduledExecutorService, FlowController) - Constructor for class com.google.api.gax.rpc.BatcherFactory

batching(UnaryCallable<RequestT, ResponseT>, BatchingCallSettings<RequestT, ResponseT>, ClientContext) - Static method in class com.google.api.gax.rpc.Callables

Create a callable object that represents a batching API method.

BatchingCallable<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A UnaryCallable which will batch requests based on the given BatchingDescriptor and BatcherFactory.

BatchingCallable(UnaryCallable<RequestT, ResponseT>, BatchingDescriptor<RequestT, ResponseT>, BatcherFactory<RequestT, ResponseT>) - Constructor for class com.google.api.gax.rpc.BatchingCallable

BatchingCallSettings<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A settings class to configure a UnaryCallable for calls to an API method that supports batching.

BatchingCallSettings.Builder<RequestT,ResponseT> - Class in com.google.api.gax.rpc

BatchingDescriptor<RequestT,ResponseT> - Interface in com.google.api.gax.rpc

Interface which represents an object that transforms request/response data for the purposes of batching.

BatchingFlowController<T> - Class in com.google.api.gax.batching

Wraps a FlowController for use by batching.

BatchingFlowController(FlowController, ElementCounter<T>, ElementCounter<T>) - Constructor for class com.google.api.gax.batching.BatchingFlowController

BatchingSettings - Class in com.google.api.gax.batching

Represents the batching settings to use for an API method that is capable of batching.

BatchingSettings() - Constructor for class com.google.api.gax.batching.BatchingSettings

BatchingSettings.Builder - Class in com.google.api.gax.batching

See the class documentation of BatchingSettings for a description of the different values that can be set.

BatchingThreshold<E> - Interface in com.google.api.gax.batching

The interface representing a threshold to be used in ThresholdBatcher.

BatchingThresholds - Class in com.google.api.gax.batching

Factory methods for general-purpose batching thresholds.

BatchingThresholds() - Constructor for class com.google.api.gax.batching.BatchingThresholds

BatchMerger<B> - Interface in com.google.api.gax.batching

batchRequestSent(long, long) - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that a batch of writes has been flushed.

batchRequestSent(long, long) - Method in class com.google.api.gax.tracing.NoopApiTracer

batchRequestSent(long, long) - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that a batch of writes has been flushed.

BidiStream<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A wrapper around a bidirectional stream.

bidiStreamingCall(ApiStreamObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Deprecated.

Please use BidiStreamingCallable.splitCall(ResponseObserver, ApiCallContext) instead.

bidiStreamingCall(ApiStreamObserver<ResponseT>) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Deprecated.

Please use BidiStreamingCallable.splitCall(ResponseObserver) instead.

BidiStreamingCallable<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A BidiStreamingCallable is an immutable object which is capable of making RPC calls to bidirectional streaming API methods.

BidiStreamingCallable() - Constructor for class com.google.api.gax.rpc.BidiStreamingCallable

BidiStreamObserver<RequestT,ResponseT> - Interface in com.google.api.gax.rpc

blockingServerStreamingCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Deprecated.

Please use call() instead.

blockingServerStreamingCall(RequestT) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Deprecated.

Please use call() instead.

build() - Method in class com.google.api.gax.batching.BatchingSettings.Builder

Build the BatchingSettings object.

build() - Method in class com.google.api.gax.batching.FlowControlSettings.Builder

build() - Method in interface com.google.api.gax.batching.RequestBuilder

build() - Method in class com.google.api.gax.batching.ThresholdBatcher.Builder

Build the ThresholdBatcher.

build() - Method in class com.google.api.gax.core.GoogleCredentialsProvider.Builder

build() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider.Builder

build() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

build() - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

build() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

build() - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

build() - Method in class com.google.api.gax.rpc.ClientContext.Builder

build() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

build() - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

build() - Method in class com.google.api.gax.rpc.PagedCallSettings.Builder

build() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

build() - Method in class com.google.api.gax.rpc.StreamingCallSettings.Builder

build() - Method in class com.google.api.gax.rpc.StubSettings.Builder

build() - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder

Builds an instance of the containing class.

Builder() - Constructor for class com.google.api.gax.batching.BatchingSettings.Builder

Builder() - Constructor for class com.google.api.gax.batching.FlowControlSettings.Builder

Builder() - Constructor for class com.google.api.gax.core.GoogleCredentialsProvider.Builder

Builder() - Constructor for class com.google.api.gax.core.InstantiatingExecutorProvider.Builder

Builder() - Constructor for class com.google.api.gax.retrying.RetrySettings.Builder

Builder() - Constructor for class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Builder() - Constructor for class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

Builder(BatchingDescriptor<RequestT, ResponseT>) - Constructor for class com.google.api.gax.rpc.BatchingCallSettings.Builder

Builder(BatchingCallSettings<RequestT, ResponseT>) - Constructor for class com.google.api.gax.rpc.BatchingCallSettings.Builder

Builder() - Constructor for class com.google.api.gax.rpc.ClientContext.Builder

Builder(ClientSettings) - Constructor for class com.google.api.gax.rpc.ClientSettings.Builder

Create a builder from a ClientSettings object.

Builder(StubSettings.Builder) - Constructor for class com.google.api.gax.rpc.ClientSettings.Builder

Create a builder from a StubSettings object.

Builder() - Constructor for class com.google.api.gax.rpc.ClientSettings.Builder

Builder() - Constructor for class com.google.api.gax.rpc.OperationCallSettings.Builder

Builder(OperationCallSettings<RequestT, ResponseT, MetadataT>) - Constructor for class com.google.api.gax.rpc.OperationCallSettings.Builder

Builder(PagedListResponseFactory<RequestT, ResponseT, PagedListResponseT>) - Constructor for class com.google.api.gax.rpc.PagedCallSettings.Builder

Builder(PagedCallSettings<RequestT, ResponseT, PagedListResponseT>) - Constructor for class com.google.api.gax.rpc.PagedCallSettings.Builder

Builder() - Constructor for class com.google.api.gax.rpc.StreamingCallSettings.Builder

Builder(StreamingCallSettings<RequestT, ResponseT>) - Constructor for class com.google.api.gax.rpc.StreamingCallSettings.Builder

Builder(StubSettings) - Constructor for class com.google.api.gax.rpc.StubSettings.Builder

Create a builder from a StubSettings object.

Builder(ClientContext) - Constructor for class com.google.api.gax.rpc.StubSettings.Builder

Builder() - Constructor for class com.google.api.gax.rpc.StubSettings.Builder

Builder() - Constructor for class com.google.api.gax.rpc.UnaryCallSettings.Builder

Builder(UnaryCallSettings<RequestT, ResponseT>) - Constructor for class com.google.api.gax.rpc.UnaryCallSettings.Builder

C

call(BidiStreamObserver<RequestT, ResponseT>) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Listens to server responses and send requests when the network is free.

call(BidiStreamObserver<RequestT, ResponseT>, ApiCallContext) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Listens to server responses and send requests when the network is free.

call() - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Send requests and iterate over server responses.

call(ApiCallContext) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Send requests and iterate over server responses.

call(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.OperationCallable

Perform a call synchronously.

call(RequestT) - Method in class com.google.api.gax.rpc.OperationCallable

Same as OperationCallable.call(Object, ApiCallContext), with a null context.

call(RequestT) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Conduct a iteration server streaming call.

call(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Conduct a server streaming call with the given ApiCallContext.

call(RequestT, ResponseObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Conduct a server streaming call with the given ApiCallContext.

call(RequestT, ResponseObserver<ResponseT>) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Conduct a server streaming call

call(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.UnaryCallable

Perform a call synchronously.

call(RequestT) - Method in class com.google.api.gax.rpc.UnaryCallable

Same as UnaryCallable.call(Object, ApiCallContext), with a null context.

call(RequestT, ResponseObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedServerStreamingCallable

Callables - Class in com.google.api.gax.rpc

Class with utility methods to create callable objects using provided settings.

callAndTranslateApiException(ApiFuture<ResponseT>) - Static method in class com.google.api.gax.rpc.ApiExceptions

Invokes Future.get() on the given future, and if the call throws an exception (which will be UncheckedExecutionException), the exception is processed in the following way: If the exception cause is a RuntimeException, the RuntimeException is rethrown.

cancel(boolean) - Method in class com.google.api.gax.longrunning.OperationFutureImpl

cancel(boolean) - Method in class com.google.api.gax.retrying.NonCancellableFuture

cancel(String, ApiCallContext) - Method in class com.google.api.gax.rpc.OperationCallable

Sends a cancellation request to the server for the operation with name operationName.

cancel(String) - Method in class com.google.api.gax.rpc.OperationCallable

Sends a cancellation request to the server for the operation with name operationName.

cancel() - Method in class com.google.api.gax.rpc.ServerStream

Cleanly cancels a partially consumed stream.

cancel() - Method in interface com.google.api.gax.rpc.StreamController

Cancel the stream early.

cancel(String, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedOperationCallable

Wrap operation cancellation in a ApiTracerFactory.OperationType.Unary trace.

CancelledException - Exception in com.google.api.gax.rpc

The exception thrown when the operation was cancelled (typically by the caller).

CancelledException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.CancelledException

CancelledException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.CancelledException

cancelOperationCallable() - Method in interface com.google.api.gax.rpc.LongRunningClient

Returns a UnaryCallable which can issue calls to cancel an operation.

canResume() - Method in exception com.google.api.gax.retrying.ServerStreamingAttemptException

If the StreamResumptionStrategy supports resuming after this error.

canResume() - Method in class com.google.api.gax.retrying.SimpleStreamResumptionStrategy

canResume() - Method in interface com.google.api.gax.retrying.StreamResumptionStrategy

If a resume request can be created.

ClientContext - Class in com.google.api.gax.rpc

Encapsulates client state, including executor, credentials, and transport channel.

ClientContext() - Constructor for class com.google.api.gax.rpc.ClientContext

ClientContext.Builder - Class in com.google.api.gax.rpc

ClientSettings<SettingsT extends ClientSettings<SettingsT>> - Class in com.google.api.gax.rpc

A base settings class to configure a client class.

ClientSettings(ClientSettings.Builder) - Constructor for class com.google.api.gax.rpc.ClientSettings

Constructs an instance of ClientSettings.

ClientSettings.Builder<SettingsT extends ClientSettings<SettingsT>,B extends ClientSettings.Builder<SettingsT,B>> - Class in com.google.api.gax.rpc

ClientStream<RequestT> - Interface in com.google.api.gax.rpc

A wrapper used to send requests to the server.

clientStreamingCall(ApiStreamObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.rpc.ClientStreamingCallable

Conduct a client streaming call with the given ApiCallContext

clientStreamingCall(ApiStreamObserver<ResponseT>) - Method in class com.google.api.gax.rpc.ClientStreamingCallable

Conduct a client streaming call

clientStreamingCall(ApiStreamObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedClientStreamingCallable

ClientStreamingCallable<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A ClientStreamingCallable is an immutable object which is capable of making RPC calls to client streaming API methods.

ClientStreamingCallable() - Constructor for class com.google.api.gax.rpc.ClientStreamingCallable

ClientStreamReadyObserver<V> - Interface in com.google.api.gax.rpc

A callback used to report that the ClientStream is ready to send more messages.

close() - Method in class com.google.api.gax.core.BackgroundResourceAggregation

close() - Method in class com.google.api.gax.core.BaseBackgroundResource

close() - Method in class com.google.api.gax.core.ExecutorAsBackgroundResource

close() - Method in interface com.google.api.gax.tracing.ApiTracer.Scope

closeSend() - Method in class com.google.api.gax.rpc.BidiStream

Closes the sending side of the stream.

closeSend() - Method in interface com.google.api.gax.rpc.ClientStream

Closes the stream.

closeSendWithError(Throwable) - Method in class com.google.api.gax.rpc.BidiStream

Closes the sending side of the stream with error.

closeSendWithError(Throwable) - Method in interface com.google.api.gax.rpc.ClientStream

Closes the stream with an error.

com.google.api.gax.batching - package com.google.api.gax.batching

com.google.api.gax.core - package com.google.api.gax.core

com.google.api.gax.longrunning - package com.google.api.gax.longrunning

com.google.api.gax.paging - package com.google.api.gax.paging

com.google.api.gax.retrying - package com.google.api.gax.retrying

com.google.api.gax.rpc - package com.google.api.gax.rpc

com.google.api.gax.rpc.internal - package com.google.api.gax.rpc.internal

com.google.api.gax.tracing - package com.google.api.gax.tracing

connectionSelected(String) - Method in interface com.google.api.gax.tracing.ApiTracer

Annotates the operation with selected connection id from the ChannelPool.

connectionSelected(String) - Method in class com.google.api.gax.tracing.NoopApiTracer

connectionSelected(String) - Method in class com.google.api.gax.tracing.OpencensusTracer

Annotates the operation with selected connection id from the ChannelPool.

copyWithZeroedValue() - Method in interface com.google.api.gax.batching.BatchingThreshold

Make a copy of this threshold but with the accumulated value zeroed.

copyWithZeroedValue() - Method in class com.google.api.gax.batching.NumericThreshold

count(E) - Method in interface com.google.api.gax.batching.ElementCounter

Provides the numerical count associated with the given object.

countBytes(RequestT) - Method in interface com.google.api.gax.rpc.BatchingDescriptor

Returns the size in bytes of this request.

countElements(RequestT) - Method in interface com.google.api.gax.rpc.BatchingDescriptor

Returns the number of elements contained in this request.

create(long) - Static method in class com.google.api.gax.batching.BatchingThresholds

Creates an ImmutableList containing only a single threshold which counts the number of elements.

create(Credentials) - Static method in class com.google.api.gax.core.FixedCredentialsProvider

Creates a FixedCredentialsProvider.

create(ScheduledExecutorService) - Static method in class com.google.api.gax.core.FixedExecutorProvider

Creates a FixedExecutorProvider.

create() - Static method in class com.google.api.gax.core.NoCredentialsProvider

create(RetrySettings) - Static method in class com.google.api.gax.longrunning.OperationTimedPollAlgorithm

Creates the polling algorithm, using the default NanoClock for time computations.

create(RetrySettings, ApiClock) - Static method in class com.google.api.gax.longrunning.OperationTimedPollAlgorithm

create() - Static method in class com.google.api.gax.rpc.BatchedFuture

Get a new instance.

create(ClientSettings) - Static method in class com.google.api.gax.rpc.ClientContext

Instantiates the executor, credentials, and transport context based on the given client settings.

create(StubSettings) - Static method in class com.google.api.gax.rpc.ClientContext

Instantiates the executor, credentials, and transport context based on the given client settings.

create(Map<String, String>) - Static method in class com.google.api.gax.rpc.FixedHeaderProvider

Creates a FixedHeaderProvider.

create(String...) - Static method in class com.google.api.gax.rpc.FixedHeaderProvider

create(TransportChannel) - Static method in class com.google.api.gax.rpc.FixedTransportChannelProvider

Creates a FixedTransportChannelProvider.

create(Watchdog) - Static method in class com.google.api.gax.rpc.FixedWatchdogProvider

create() - Static method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

create(UnaryCallable<RequestT, ResponseT>, PagedListDescriptor<RequestT, ResponseT, ResourceT>, RequestT, ApiCallContext) - Static method in class com.google.api.gax.rpc.PageContext

create(UnaryCallable<InnerRequestT, InnerResponseT>, ApiFunction<OuterRequestT, InnerRequestT>, ApiFunction<InnerResponseT, OuterResponseT>) - Static method in class com.google.api.gax.rpc.TranslatingUnaryCallable

createCollection(List<PageT>, int) - Method in class com.google.api.gax.paging.AbstractFixedSizeCollection

createException(Throwable, StatusCode, boolean) - Static method in class com.google.api.gax.rpc.ApiExceptionFactory

createException(String, Throwable, StatusCode, boolean) - Static method in class com.google.api.gax.rpc.ApiExceptionFactory

createFirstAttempt() - Method in class com.google.api.gax.retrying.ExponentialRetryAlgorithm

Creates a first attempt TimedAttemptSettings.

createFirstAttempt() - Method in class com.google.api.gax.retrying.RetryAlgorithm

Creates a first attempt TimedAttemptSettings.

createFirstAttempt() - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithm

Creates a first attempt TimedAttemptSettings.

createFuture(Callable<ResponseT>) - Method in class com.google.api.gax.retrying.DirectRetryingExecutor

Creates a RetryingFuture, which is a facade, returned to the client code to wait for any retriable operation to complete.

createFuture(Callable<ResponseT>, RetryingContext) - Method in class com.google.api.gax.retrying.DirectRetryingExecutor

Creates a RetryingFuture, which is a facade, returned to the client code to wait for any retriable operation to complete.

createFuture(Callable<ResponseT>) - Method in interface com.google.api.gax.retrying.RetryingExecutor

Creates the RetryingFuture, which is a facade, returned to the client code to wait for any retriable operation to complete.

createFuture(Callable<ResponseT>, RetryingContext) - Method in interface com.google.api.gax.retrying.RetryingExecutorWithContext

createFuture(Callable<ResponseT>) - Method in class com.google.api.gax.retrying.ScheduledRetryingExecutor

Creates a RetryingFuture, which is a facade, returned to the client code to wait for any retriable operation to complete.

createFuture(Callable<ResponseT>, RetryingContext) - Method in class com.google.api.gax.retrying.ScheduledRetryingExecutor

Creates a RetryingFuture, which is a facade, returned to the client code to wait for any retriable operation to complete.

createNew() - Method in class com.google.api.gax.retrying.SimpleStreamResumptionStrategy

createNew() - Method in interface com.google.api.gax.retrying.StreamResumptionStrategy

Creates a new instance of this StreamResumptionStrategy without accumulated state

createNextAttempt(Throwable, OperationSnapshot, TimedAttemptSettings) - Method in class com.google.api.gax.longrunning.OperationResponsePollAlgorithm

createNextAttempt(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.BasicResultRetryAlgorithm

Always returns null, indicating that this algorithm does not provide any specific settings for the next attempt.

createNextAttempt(TimedAttemptSettings) - Method in class com.google.api.gax.retrying.ExponentialRetryAlgorithm

Creates a next attempt TimedAttemptSettings.

createNextAttempt(Throwable, ResponseT, TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.ResultRetryAlgorithm

Creates a next attempt TimedAttemptSettings.

createNextAttempt(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.RetryAlgorithm

Creates a next attempt TimedAttemptSettings.

createNextAttempt(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.StreamingRetryAlgorithm

Creates a next attempt TimedAttemptSettings.

createNextAttempt(TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithm

Creates a next attempt TimedAttemptSettings, which defines properties of the next attempt.

createPage(PageContext<RequestT, ResponseT, ResourceT>, ResponseT) - Method in class com.google.api.gax.paging.AbstractPage

createPageAsync(PageContext<RequestT, ResponseT, ResourceT>, ApiFuture<ResponseT>) - Method in class com.google.api.gax.paging.AbstractPage

CredentialsProvider - Interface in com.google.api.gax.core

Provides an interface to hold and acquire the credentials that will be used to call the service.

D

DataLossException - Exception in com.google.api.gax.rpc

Exception thrown due to unrecoverable data loss or corruption.

DataLossException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.DataLossException

DataLossException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.DataLossException

DeadlineExceededException - Exception in com.google.api.gax.rpc

Exception thrown when deadline expired before operation could complete.

DeadlineExceededException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.DeadlineExceededException

DeadlineExceededException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.DeadlineExceededException

deleteOperationCallable() - Method in interface com.google.api.gax.rpc.LongRunningClient

Returns a UnaryCallable which can issue calls to delete an operation.

DirectRetryingExecutor<ResponseT> - Class in com.google.api.gax.retrying

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.

DirectRetryingExecutor(RetryAlgorithm<ResponseT>) - Constructor for class com.google.api.gax.retrying.DirectRetryingExecutor

Creates a new direct retrying executor instance, which will be using retryAlgorithm to determine retrying strategy.

disableAutoInboundFlowControl() - Method in interface com.google.api.gax.rpc.StreamController

Disables automatic flow control.

Distribution - Class in com.google.api.gax.core

Distribution records values from 0 (inclusive) to endValue (exclusive) and computes their percentiles.

Distribution(int) - Constructor for class com.google.api.gax.core.Distribution

E

ElementCounter<E> - Interface in com.google.api.gax.batching

Interface representing an object that provides a numerical count given an object of the parameterized type.

empty() - Static method in class com.google.api.gax.paging.Pages

Returns a page that contains nothing.

emptyToken() - Method in interface com.google.api.gax.rpc.PagedListDescriptor

Delivers the empty page token.

encode(RequestT) - Method in interface com.google.api.gax.rpc.RequestParamsEncoder

Encodes request message in a string.

encode(RequestT) - Method in class com.google.api.gax.rpc.RequestUrlParamsEncoder

Encodes the request in a form of a URL parameters string, for example "param1=value+1&param2=value2%26".

equals(Object) - Method in class com.google.api.gax.batching.PartitionKey

equals(Object) - Method in class com.google.api.gax.tracing.OpencensusTracerFactory

ExecutorAsBackgroundResource - Class in com.google.api.gax.core

ExecutorAsBackgroundResource wraps an ExecutorService so that it can be used as a BackgroundResource.

ExecutorAsBackgroundResource(ExecutorService) - Constructor for class com.google.api.gax.core.ExecutorAsBackgroundResource

ExecutorProvider - Interface in com.google.api.gax.core

Provides an interface to either build a ScheduledExecutorService or provide a fixed ScheduledExecutorService that will be used to make calls to a service.

expandToFixedSizeCollection(int) - Method in class com.google.api.gax.paging.AbstractPagedListResponse

expandToFixedSizeCollection(int) - Method in interface com.google.api.gax.paging.PagedListResponse

Returns a collection of elements with a fixed size set by the collectionSize parameter.

ExponentialPollAlgorithm - Class in com.google.api.gax.retrying

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.

ExponentialPollAlgorithm(RetrySettings, ApiClock) - Constructor for class com.google.api.gax.retrying.ExponentialPollAlgorithm

Creates a new exponential poll algorithm instance.

ExponentialRetryAlgorithm - Class in com.google.api.gax.retrying

The timed retry algorithm which uses jittered exponential backoff factor for calculating the next attempt execution time.

ExponentialRetryAlgorithm(RetrySettings, ApiClock) - Constructor for class com.google.api.gax.retrying.ExponentialRetryAlgorithm

Creates a new exponential retry algorithm instance.

extract(RequestT) - Method in interface com.google.api.gax.rpc.RequestParamsExtractor

Extracts specific fields from the request and returns them in a form of key-value pairs, where a key is a field name and a value is a field's string representation.

extractNextToken(ResponseT) - Method in interface com.google.api.gax.rpc.PagedListDescriptor

Extracts the next token from the response.

extractPageSize(RequestT) - Method in interface com.google.api.gax.rpc.PagedListDescriptor

Extracts the page size setting from the request.

extractResources(ResponseT) - Method in interface com.google.api.gax.rpc.PagedListDescriptor

Extracts an iterable of resources from the response.

F

FailedPreconditionException - Exception in com.google.api.gax.rpc

Exception thrown when the operation was rejected because the system is not in a state required for the operation's execution.

FailedPreconditionException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.FailedPreconditionException

FailedPreconditionException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.FailedPreconditionException

first() - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Construct a UnaryCallable that will yield the first item in the stream and cancel it.

FixedCredentialsProvider - Class in com.google.api.gax.core

FixedCredentialsProvider is a CredentialsProvider which always provides the same credentials.

FixedCredentialsProvider() - Constructor for class com.google.api.gax.core.FixedCredentialsProvider

FixedExecutorProvider - Class in com.google.api.gax.core

FixedExecutorProvider is an ExecutorProvider which always returns the same executor.

FixedHeaderProvider - Class in com.google.api.gax.rpc

An instance of HeaderProvider that always provides the same headers.

FixedHeaderProvider() - Constructor for class com.google.api.gax.rpc.FixedHeaderProvider

FixedSizeCollection<ResourceT> - Interface in com.google.api.gax.paging

A FixedSizeCollection object wraps multiple API list method responses into a single collection with a fixed number of elements.

FixedTransportChannelProvider - Class in com.google.api.gax.rpc

An instance of TransportChannelProvider that always provides the same TransportChannel.

FixedWatchdogProvider - Class in com.google.api.gax.rpc

FlowController - Class in com.google.api.gax.batching

Provides flow control capability.

FlowController(FlowControlSettings) - Constructor for class com.google.api.gax.batching.FlowController

FlowController.FlowControlException - Exception in com.google.api.gax.batching

Base exception that signals a flow control state.

FlowController.FlowControlRuntimeException - Exception in com.google.api.gax.batching

Runtime exception that can be used in place of FlowControlException when an unchecked exception is required.

FlowController.LimitExceededBehavior - Enum in com.google.api.gax.batching

Enumeration of behaviors that FlowController can use in case the flow control limits are exceeded.

FlowController.MaxOutstandingElementCountReachedException - Exception in com.google.api.gax.batching

Exception thrown when client-side flow control is enforced based on the maximum number of outstanding in-memory elements.

FlowController.MaxOutstandingRequestBytesReachedException - Exception in com.google.api.gax.batching

Exception thrown when client-side flow control is enforced based on the maximum number of unacknowledged in-memory bytes.

FlowControlSettings - Class in com.google.api.gax.batching

Settings for FlowController.

FlowControlSettings() - Constructor for class com.google.api.gax.batching.FlowControlSettings

FlowControlSettings.Builder - Class in com.google.api.gax.batching

fromFlowControlException(FlowController.FlowControlException) - Static method in exception com.google.api.gax.batching.FlowController.FlowControlRuntimeException

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.BatchingCallable

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.OperationCallable

Initiates an operation asynchronously.

futureCall(RequestT) - Method in class com.google.api.gax.rpc.OperationCallable

Same as OperationCallable.futureCall(Object, ApiCallContext), with a null context.

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.PagedCallable

futureCall(OuterRequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.TranslatingUnaryCallable

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.rpc.UnaryCallable

Perform a call asynchronously.

futureCall(RequestT) - Method in class com.google.api.gax.rpc.UnaryCallable

Same as UnaryCallable.futureCall(Object, ApiCallContext), with a null context.

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedBatchingCallable

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedOperationCallable

Wrap the initial start polling logical operations in a single parent trace using a ApiTracerFactory.OperationType.LongRunning ApiTracer.

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedOperationInitialCallable

futureCall(RequestT, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedUnaryCallable

Calls the wrapped UnaryCallable within the context of a new trace.

G

GaxProperties - Class in com.google.api.gax.core

Provides properties of the GAX library.

get() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

get(long, TimeUnit) - Method in class com.google.api.gax.longrunning.OperationFutureImpl

getApiClientHeaderKey() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getAttemptCount() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

The attempt count.

getAttemptResult() - Method in interface com.google.api.gax.retrying.RetryingFuture

Returns the current (active on the moment of the execution of this method) attempt result future, allowing to track progress of the retrying future execution.

getAttemptSettings() - Method in interface com.google.api.gax.retrying.RetryingFuture

Returns current (active) attempt settings.

getBackgroundResources() - Method in class com.google.api.gax.rpc.ClientContext

The objects that need to be closed in order to clean up the resources created in the process of creating this ClientContext.

getBatches() - Method in class com.google.api.gax.batching.AccumulatingBatchReceiver

Returns the accumulated batches.

getBatchingDescriptor() - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

getBatchingDescriptor() - Method in class com.google.api.gax.rpc.BatchingCallSettings

getBatchingSettings() - Method in class com.google.api.gax.rpc.BatcherFactory

Returns the BatchingSettings object that is associated with this factory.

getBatchingSettings() - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

getBatchingSettings() - Method in class com.google.api.gax.rpc.BatchingCallSettings

getBatchPartitionKey(RequestT) - Method in interface com.google.api.gax.rpc.BatchingDescriptor

Returns the value of the partition key for the given request.

getByteCount() - Method in class com.google.api.gax.rpc.Batch

getCallable() - Method in interface com.google.api.gax.retrying.RetryingFuture

Returns callable tracked by this future.

getCallable() - Method in class com.google.api.gax.rpc.Batch

getCallable() - Method in class com.google.api.gax.rpc.PageContext

getCallContext() - Method in class com.google.api.gax.rpc.PageContext

getClientLibToken() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getClientName() - Method in class com.google.api.gax.tracing.SpanName

The name of the client.

getClock() - Method in class com.google.api.gax.rpc.ClientContext

getClock() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Gets the ApiClock that was previously set on this Builder.

getClock() - Method in class com.google.api.gax.rpc.ClientSettings

getClock() - Method in class com.google.api.gax.rpc.StubSettings.Builder

Gets the ApiClock that was previously set on this Builder.

getClock() - Method in class com.google.api.gax.rpc.StubSettings

getCode() - Method in interface com.google.api.gax.rpc.StatusCode

Return the code enum value.

getCollectionSize() - Method in class com.google.api.gax.paging.AbstractFixedSizeCollection

getCollectionSize() - Method in interface com.google.api.gax.paging.FixedSizeCollection

Returns the number of elements in the collection.

getCredentials() - Method in interface com.google.api.gax.core.CredentialsProvider

Gets the credentials which will be used to call the service.

getCredentials() - Method in class com.google.api.gax.core.FixedCredentialsProvider

getCredentials() - Method in class com.google.api.gax.core.GoogleCredentialsProvider

getCredentials() - Method in class com.google.api.gax.core.NoCredentialsProvider

getCredentials() - Method in class com.google.api.gax.rpc.ClientContext

getCredentialsProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Gets the CredentialsProvider that was previously set on this Builder.

getCredentialsProvider() - Method in class com.google.api.gax.rpc.ClientSettings

getCredentialsProvider() - Method in class com.google.api.gax.rpc.StubSettings.Builder

Gets the CredentialsProvider that was previously set on this Builder.

getCredentialsProvider() - Method in class com.google.api.gax.rpc.StubSettings

getCurrentMaxBatchBytes() - Method in exception com.google.api.gax.batching.FlowController.MaxOutstandingRequestBytesReachedException

getCurrentMaxBatchElementCount() - Method in exception com.google.api.gax.batching.FlowController.MaxOutstandingElementCountReachedException

getDefaultApiClientHeaderKey() - Static method in class com.google.api.gax.rpc.ApiClientHeaderProvider

getDefaultCallContext() - Method in class com.google.api.gax.rpc.ClientContext

getDefaultInstance() - Static method in class com.google.api.gax.batching.FlowControlSettings

getDefaultResourceHeaderKey() - Static method in class com.google.api.gax.rpc.ApiClientHeaderProvider

getDelayThreshold() - Method in class com.google.api.gax.batching.BatchingSettings

Get the delay threshold to use for batching.

getElementCountThreshold() - Method in class com.google.api.gax.batching.BatchingSettings

Get the element count threshold to use for batching.

getEmptyCallContext() - Method in interface com.google.api.gax.rpc.TransportChannel

Returns an empty ApiCallContext that is compatible with this TransportChannel.

getEndpoint() - Method in class com.google.api.gax.rpc.ClientContext

getEndpoint() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

getEndpoint() - Method in class com.google.api.gax.rpc.ClientSettings

getEndpoint() - Method in class com.google.api.gax.rpc.StubSettings.Builder

getEndpoint() - Method in class com.google.api.gax.rpc.StubSettings

getErrorCode() - Method in interface com.google.api.gax.longrunning.OperationSnapshot

If the operation is done and it failed, returns the failure status code; if the operation is not done or if it succeeded, returns null.

getErrorMessage() - Method in interface com.google.api.gax.longrunning.OperationSnapshot

If the operation is done and it failed, returns the error message; if the operation is not done or if it succeeded, returns null.

getExecutor() - Method in interface com.google.api.gax.core.ExecutorProvider

Gets the executor to use.

getExecutor() - Method in class com.google.api.gax.core.FixedExecutorProvider

getExecutor() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider

getExecutor() - Method in class com.google.api.gax.rpc.ClientContext

getExecutorProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Gets the ExecutorProvider that was previously set on this Builder.

getExecutorProvider() - Method in class com.google.api.gax.rpc.ClientSettings

getExecutorProvider() - Method in class com.google.api.gax.rpc.StubSettings.Builder

Gets the ExecutorProvider that was previously set on this Builder.

getExecutorProvider() - Method in class com.google.api.gax.rpc.StubSettings

getExecutorThreadCount() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider.Builder

getExecutorThreadCount() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider

The number of threads used by the executor created by this ExecutorProvider.

getExtraHeaders() - Method in interface com.google.api.gax.rpc.ApiCallContext

Return the extra headers set for this context.

getFirstAttemptStartTimeNanos() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

The start time of the first attempt.

getFlowController() - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

getFlowController() - Method in class com.google.api.gax.rpc.BatchingCallSettings

getFlowControlSettings() - Method in class com.google.api.gax.batching.BatchingSettings

Get the flow control settings to use.

getFuturePagedResponse(UnaryCallable<RequestT, ResponseT>, RequestT, ApiCallContext, ApiFuture<ResponseT>) - Method in interface com.google.api.gax.rpc.PagedListResponseFactory

getGaxVersion() - Static method in class com.google.api.gax.core.GaxProperties

Returns the current version of GAX.

getGeneratedLibToken() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getGeneratedRuntimeToken() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getGlobalSettings() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

Returns global (attempt-independent) retry settings.

getHeaderProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Gets the custom HeaderProvider that was previously set on this Builder.

getHeaderProvider() - Method in class com.google.api.gax.rpc.ClientSettings

getHeaderProvider() - Method in class com.google.api.gax.rpc.StubSettings.Builder

Gets the custom HeaderProvider that was previously set on this Builder.

getHeaderProvider() - Method in class com.google.api.gax.rpc.StubSettings

getHeaders() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider

getHeaders() - Method in class com.google.api.gax.rpc.ClientContext

getHeaders() - Method in class com.google.api.gax.rpc.FixedHeaderProvider

getHeaders() - Method in interface com.google.api.gax.rpc.HeaderProvider

Get the headers to put on http requests.

getHeaders() - Method in class com.google.api.gax.rpc.NoHeaderProvider

getHttpStatusCode() - Method in enum com.google.api.gax.rpc.StatusCode.Code

getIdleTimeout() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

getIdleTimeout() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings

See the class documentation of ServerStreamingCallSettings for a description of what the ServerStreamingCallSettings.idleTimeout does.

getInitialCallSettings() - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

Get the call settings which are used on the call to initiate the operation.

getInitialCallSettings() - Method in class com.google.api.gax.rpc.OperationCallSettings

getInitialFuture() - Method in interface com.google.api.gax.longrunning.OperationFuture

Returns the OperationSnapshot future of the initial request which started this OperationFuture.

getInitialFuture() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

getInitialRetryDelay() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

InitialRetryDelay controls the delay before the first retry.

getInitialRetryDelay() - Method in class com.google.api.gax.retrying.RetrySettings

InitialRetryDelay controls the delay before the first retry.

getInitialRpcTimeout() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

InitialRpcTimeout controls the timeout for the initial RPC.

getInitialRpcTimeout() - Method in class com.google.api.gax.retrying.RetrySettings

InitialRpcTimeout controls the timeout for the initial RPC.

getInstance() - Static method in class com.google.api.gax.tracing.NoopApiTracer

getInstance() - Static method in class com.google.api.gax.tracing.NoopApiTracerFactory

getInternalHeaderProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Gets the internal HeaderProvider that was previously set on this Builder.

getInternalHeaderProvider() - Method in class com.google.api.gax.rpc.ClientSettings

getInternalHeaderProvider() - Method in class com.google.api.gax.rpc.StubSettings.Builder

Gets the internal HeaderProvider that was previously set on this Builder.

getInternalHeaderProvider() - Method in class com.google.api.gax.rpc.StubSettings

getInternalHeaders() - Method in class com.google.api.gax.rpc.ClientContext

getIsEnabled() - Method in class com.google.api.gax.batching.BatchingSettings

Returns the Boolean object to indicate if the batching is enabled.

getJavaVersion() - Static method in class com.google.api.gax.core.GaxProperties

Returns the version of the running JVM

getJvmToken() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getJwtEnabledScopes() - Method in class com.google.api.gax.core.GoogleCredentialsProvider.Builder

The JWT enable scopes previously provided.

getJwtEnabledScopes() - Method in class com.google.api.gax.core.GoogleCredentialsProvider

getLibraryVersion(Class<?>) - Static method in class com.google.api.gax.core.GaxProperties

Returns the version of the library that the libraryClass belongs to

getLibraryVersion(Class<?>, String) - Static method in class com.google.api.gax.core.GaxProperties

Returns the version of the library that the libraryClass belongs to, or a property value in dependencies.properties resource file instead, if the version was not found.

getLimitExceededBehavior() - Method in class com.google.api.gax.batching.FlowControlSettings

The behavior of FlowController when the specified limits are exceeded.

getMaxAttempts() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

MaxAttempts defines the maximum number of attempts to perform.

getMaxAttempts() - Method in class com.google.api.gax.retrying.RetrySettings

MaxAttempts defines the maximum number of attempts to perform.

getMaxOutstandingElementCount() - Method in class com.google.api.gax.batching.FlowControlSettings

Maximum number of outstanding elements to keep in memory before enforcing flow control.

getMaxOutstandingRequestBytes() - Method in class com.google.api.gax.batching.FlowControlSettings

Maximum number of outstanding bytes to keep in memory before enforcing flow control.

getMaxRetryDelay() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

MaxRetryDelay puts a limit on the value of the retry delay, so that the RetryDelayMultiplier can't increase the retry delay higher than this amount.

getMaxRetryDelay() - Method in class com.google.api.gax.retrying.RetrySettings

MaxRetryDelay puts a limit on the value of the retry delay, so that the RetryDelayMultiplier can't increase the retry delay higher than this amount.

getMaxRpcTimeout() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

MaxRpcTimeout puts a limit on the value of the RPC timeout, so that the RpcTimeoutMultiplier can't increase the RPC timeout higher than this amount.

getMaxRpcTimeout() - Method in class com.google.api.gax.retrying.RetrySettings

MaxRpcTimeout puts a limit on the value of the RPC timeout, so that the RpcTimeoutMultiplier can't increase the RPC timeout higher than this amount.

getMessageCount() - Method in class com.google.api.gax.rpc.BatchedRequestIssuer

getMetadata() - Method in interface com.google.api.gax.longrunning.OperationFuture

Gets the metadata of the operation tracked by this OperationFuture.

getMetadata() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

getMetadata() - Method in interface com.google.api.gax.longrunning.OperationSnapshot

Get metadata for the operation, which can change over the course of the operation.

getMetadataTransformer() - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

getMetadataTransformer() - Method in class com.google.api.gax.rpc.OperationCallSettings

getMethodName() - Method in class com.google.api.gax.tracing.SpanName

The name of the logical operation being traced.

getName() - Method in interface com.google.api.gax.longrunning.OperationFuture

Returns the value of the name of the operation from the initial operation object returned from the initial call to start the operation.

getName() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

getName() - Method in interface com.google.api.gax.longrunning.OperationSnapshot

The name of the operation.

getNextCollection() - Method in class com.google.api.gax.paging.AbstractFixedSizeCollection

getNextCollection() - Method in interface com.google.api.gax.paging.FixedSizeCollection

Retrieves the next FixedSizeCollection using one or more API calls.

getNextPage() - Method in class com.google.api.gax.paging.AbstractPage

getNextPage(int) - Method in class com.google.api.gax.paging.AbstractPage

getNextPage() - Method in interface com.google.api.gax.paging.Page

Retrieves the next Page object using the next page token, or null if there are no more pages.

getNextPageAsync() - Method in class com.google.api.gax.paging.AbstractPage

getNextPageAsync() - Method in interface com.google.api.gax.paging.AsyncPage

Returns a future for the Page object, retrieved using the next page token.

getNextPageToken() - Method in class com.google.api.gax.paging.AbstractFixedSizeCollection

getNextPageToken() - Method in class com.google.api.gax.paging.AbstractPage

getNextPageToken() - Method in class com.google.api.gax.paging.AbstractPagedListResponse

getNextPageToken() - Method in interface com.google.api.gax.paging.FixedSizeCollection

Returns a page token that can be passed into the API list method to retrieve additional elements.

getNextPageToken() - Method in interface com.google.api.gax.paging.Page

Returns the next page token from the response, or an empty string if there are no more pages.

getNextPageToken() - Method in interface com.google.api.gax.paging.PagedListResponse

Returns the token for the next page or an empty string if no more results.

getNthPercentile(double) - Method in class com.google.api.gax.core.Distribution

Deprecated.

getOperationCallable() - Method in interface com.google.api.gax.rpc.LongRunningClient

Returns a UnaryCallable which can issue calls to get the latest state of an operation.

getOverallAttemptCount() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

The overall attempt count.

getPage() - Method in class com.google.api.gax.paging.AbstractPagedListResponse

getPage() - Method in interface com.google.api.gax.paging.PagedListResponse

Returns the current page of results.

getPageDescriptor() - Method in class com.google.api.gax.rpc.PageContext

getPagedListResponseFactory() - Method in class com.google.api.gax.rpc.PagedCallSettings.Builder

getPagedListResponseFactory() - Method in class com.google.api.gax.rpc.PagedCallSettings

getPageElementCount() - Method in class com.google.api.gax.paging.AbstractPage

getPercentile(double) - Method in class com.google.api.gax.core.Distribution

Get the percentile of recorded values.

getPollingAlgorithm() - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

Get the polling algorithm of the operation.

getPollingAlgorithm() - Method in class com.google.api.gax.rpc.OperationCallSettings

getPollingFuture() - Method in interface com.google.api.gax.longrunning.OperationFuture

Returns the RetryingFuture which continues to poll OperationSnapshot.

getPollingFuture() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

getPushingBatcher(PartitionKey) - Method in class com.google.api.gax.rpc.BatcherFactory

Provides the ThresholdBatcher corresponding to the given partitionKey, or constructs one if it doesn't exist yet.

getRandomizedRetryDelay() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

Returns randomized attempt delay.

getRequest() - Method in class com.google.api.gax.paging.AbstractPage

getRequest() - Method in class com.google.api.gax.rpc.Batch

getRequest() - Method in class com.google.api.gax.rpc.PageContext

getRequestBuilder() - Method in interface com.google.api.gax.rpc.BatchingDescriptor

Get the Builder object for the request type RequestT.

getRequestByteThreshold() - Method in class com.google.api.gax.batching.BatchingSettings

Get the request byte threshold to use for batching.

getRequestIssuerList() - Method in class com.google.api.gax.rpc.Batch

getResourceHeaderKey() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getResourceToken() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getResponse() - Method in interface com.google.api.gax.longrunning.OperationSnapshot

If the operation is done and successful, returns the response; if the operation is not done or if it is failed, returns null.

getResponse() - Method in class com.google.api.gax.paging.AbstractPage

getResponseTransformer() - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

getResponseTransformer() - Method in class com.google.api.gax.rpc.OperationCallSettings

getResultAlgorithm() - Method in class com.google.api.gax.retrying.RetryAlgorithm

getResumeRequest(RequestT) - Method in class com.google.api.gax.retrying.SimpleStreamResumptionStrategy

getResumeRequest(RequestT) - Method in interface com.google.api.gax.retrying.StreamResumptionStrategy

Called when a stream needs to be restarted, the implementation should generate a request that will yield a new stream whose first response would come right after the last response received by processResponse.

getResumptionStrategy() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

getResumptionStrategy() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings

See the class documentation of ServerStreamingCallSettings and StreamResumptionStrategy for a description of what the StreamResumptionStrategy does.

getRetryableCodes() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

getRetryableCodes() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings

See the class documentation of ServerStreamingCallSettings for a description of what retryableCodes do.

getRetryableCodes() - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder

See the class documentation of UnaryCallSettings for a description of what retryable codes do.

getRetryableCodes() - Method in class com.google.api.gax.rpc.UnaryCallSettings

See the class documentation of UnaryCallSettings for a description of what retryable codes do.

getRetryDelay() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

Returns the calculated retry delay.

getRetryDelayMultiplier() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

RetryDelayMultiplier controls the change in retry delay.

getRetryDelayMultiplier() - Method in class com.google.api.gax.retrying.RetrySettings

RetryDelayMultiplier controls the change in retry delay.

getRetrySettings() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

getRetrySettings() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings

See the class documentation of ServerStreamingCallSettings for a description of what retrySettings do.

getRetrySettings() - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder

getRetrySettings() - Method in class com.google.api.gax.rpc.UnaryCallSettings

See the class documentation of UnaryCallSettings for a description of what retry settings do.

getRpcTimeout() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

Returns rpc timeout used for this attempt.

getRpcTimeoutMultiplier() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

See the class documentation of RetrySettings for a description of what this value does.

getRpcTimeoutMultiplier() - Method in class com.google.api.gax.retrying.RetrySettings

RpcTimeoutMultiplier controls the change in RPC timeout.

getScopesToApply() - Method in class com.google.api.gax.core.GoogleCredentialsProvider.Builder

The scopes previously provided.

getScopesToApply() - Method in class com.google.api.gax.core.GoogleCredentialsProvider

getStatusCode() - Method in exception com.google.api.gax.rpc.ApiException

Returns the status code of the underlying exception.

getStreamIdleTimeout() - Method in interface com.google.api.gax.rpc.ApiCallContext

The stream idle timeout set for this context.

getStreamWaitTimeout() - Method in interface com.google.api.gax.rpc.ApiCallContext

Return the stream wait timeout set for this context.

getStreamWatchdog() - Method in class com.google.api.gax.rpc.ClientContext

getStreamWatchdogCheckInterval() - Method in class com.google.api.gax.rpc.ClientContext

getStreamWatchdogCheckInterval() - Method in class com.google.api.gax.rpc.StubSettings.Builder

getStreamWatchdogCheckInterval() - Method in class com.google.api.gax.rpc.StubSettings

getStreamWatchdogProvider() - Method in class com.google.api.gax.rpc.StubSettings.Builder

Gets the WatchdogProviderthat was previously set on this Builder.

getStreamWatchdogProvider() - Method in class com.google.api.gax.rpc.StubSettings

getStubSettings() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

getStubSettings() - Method in class com.google.api.gax.rpc.ClientSettings

getThreadFactory() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider.Builder

getThreadFactory() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider

Return a thread-factory to create gax processing threads so we can name them appropriately

getTimedAlgorithm() - Method in class com.google.api.gax.retrying.RetryAlgorithm

getTimeout() - Method in interface com.google.api.gax.rpc.ApiCallContext

Returns the configured per-RPC timeout.

getTotalTimeout() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

TotalTimeout has ultimate control over how long the logic should keep trying the remote call until it gives up completely.

getTotalTimeout() - Method in class com.google.api.gax.retrying.RetrySettings

TotalTimeout has ultimate control over how long the logic should keep trying the remote call until it gives up completely.

getTracer() - Method in interface com.google.api.gax.retrying.RetryingContext

Returns the ApiTracer associated with the current operation.

getTracer() - Method in interface com.google.api.gax.rpc.ApiCallContext

The ApiTracer that was previously set for this context.

getTracerFactory() - Method in class com.google.api.gax.rpc.ClientContext

Gets the ApiTracerFactory that will be used to generate traces for operations.

getTracerFactory() - Method in class com.google.api.gax.rpc.StubSettings.Builder

getTracerFactory() - Method in class com.google.api.gax.rpc.StubSettings

Gets the configured ApiTracerFactory that will be used to generate traces for operations.

getTransportChannel() - Method in class com.google.api.gax.rpc.ClientContext

getTransportChannel() - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

getTransportChannel() - Method in interface com.google.api.gax.rpc.TransportChannelProvider

Provides a Transport, which could either be a new instance for every call, or the same instance, depending on the implementation.

getTransportChannelProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Gets the TransportProvider that was previously set on this Builder.

getTransportChannelProvider() - Method in class com.google.api.gax.rpc.ClientSettings

getTransportChannelProvider() - Method in class com.google.api.gax.rpc.StubSettings.Builder

Gets the TransportProvider that was previously set on this Builder.

getTransportChannelProvider() - Method in class com.google.api.gax.rpc.StubSettings

getTransportCode() - Method in interface com.google.api.gax.rpc.StatusCode

Return the transport-specific status code value.

getTransportName() - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

getTransportName() - Method in interface com.google.api.gax.rpc.TransportChannel

The name of the transport.

getTransportName() - Method in interface com.google.api.gax.rpc.TransportChannelProvider

The name of the transport.

getTransportToken() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

getValues() - Method in class com.google.api.gax.paging.AbstractFixedSizeCollection

getValues() - Method in class com.google.api.gax.paging.AbstractPage

getValues() - Method in interface com.google.api.gax.paging.FixedSizeCollection

Returns an iterable over the elements in this FixedSizeCollection.

getValues() - Method in interface com.google.api.gax.paging.Page

Returns an iterable over the elements in this page.

getWatchdog() - Method in class com.google.api.gax.rpc.FixedWatchdogProvider

getWatchdog() - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

getWatchdog() - Method in interface com.google.api.gax.rpc.WatchdogProvider

getWatchdogCheckInterval() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

getWatchdogCheckInterval() - Method in class com.google.api.gax.rpc.ClientSettings

getWatchdogProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

getWatchdogProvider() - Method in class com.google.api.gax.rpc.ClientSettings

GoogleCredentialsProvider - Class in com.google.api.gax.core

GoogleCredentialsProvider acquires credentials using Application Default Credentials.

GoogleCredentialsProvider() - Constructor for class com.google.api.gax.core.GoogleCredentialsProvider

GoogleCredentialsProvider.Builder - Class in com.google.api.gax.core

H

hashCode() - Method in class com.google.api.gax.batching.PartitionKey

hashCode() - Method in class com.google.api.gax.tracing.OpencensusTracerFactory

hasNextCollection() - Method in class com.google.api.gax.paging.AbstractFixedSizeCollection

hasNextCollection() - Method in interface com.google.api.gax.paging.FixedSizeCollection

Returns true if there are more elements that can be retrieved from the API.

hasNextPage() - Method in class com.google.api.gax.paging.AbstractPage

hasNextPage() - Method in interface com.google.api.gax.paging.Page

Returns true if there are more pages that can be retrieved from the API.

hasSeenResponses() - Method in exception com.google.api.gax.retrying.ServerStreamingAttemptException

If the current RPC attempt has seen any streamed messages.

HeaderProvider - Interface in com.google.api.gax.rpc

Provider of headers to put on http requests.

Headers - Class in com.google.api.gax.rpc.internal

Headers() - Constructor for class com.google.api.gax.rpc.internal.Headers

I

immediateOperationFuture(OperationSnapshot) - Static method in class com.google.api.gax.longrunning.OperationFutures

Creates an already-completed OperationFuture, useful for testing.

injectPageSize(RequestT, int) - Method in interface com.google.api.gax.rpc.PagedListDescriptor

Injects page size setting into the request.

injectToken(RequestT, String) - Method in interface com.google.api.gax.rpc.PagedListDescriptor

Injects a page token into the request.

inScope() - Method in interface com.google.api.gax.tracing.ApiTracer

Asks the underlying implementation to install itself as a thread local.

inScope() - Method in class com.google.api.gax.tracing.NoopApiTracer

inScope() - Method in class com.google.api.gax.tracing.OpencensusTracer

Asks the underlying implementation to install itself as a thread local.

InstantiatingExecutorProvider - Class in com.google.api.gax.core

InstantiatingChannelProvider is an ExecutorProvider which constructs a new ScheduledExecutorService every time getExecutor() is called.

InstantiatingExecutorProvider.Builder - Class in com.google.api.gax.core

InstantiatingWatchdogProvider - Class in com.google.api.gax.rpc

internalCall(ResponseObserver<ResponseT>, ClientStreamReadyObserver<RequestT>, ApiCallContext) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

The "base" method from which other forms of calls are derived.

internalCall(ResponseObserver<ResponseT>, ClientStreamReadyObserver<RequestT>, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedBidiCallable

InternalException - Exception in com.google.api.gax.rpc

Exception thrown due to internal errors.

InternalException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.InternalException

InternalException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.InternalException

InvalidArgumentException - Exception in com.google.api.gax.rpc

Exception thrown when client specified an invalid argument.

InvalidArgumentException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.InvalidArgumentException

InvalidArgumentException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.InvalidArgumentException

isCancelled() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

isDone() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

isDone() - Method in interface com.google.api.gax.longrunning.OperationSnapshot

Returns true if the operation is complete or failed, false otherwise.

isJittered() - Method in class com.google.api.gax.retrying.RetrySettings.Builder

Jitter determines if the delay time should be randomized.

isJittered() - Method in class com.google.api.gax.retrying.RetrySettings

Jitter determines if the delay time should be randomized.

isReceiveReady() - Method in class com.google.api.gax.rpc.ServerStream

Returns true if the next call to the iterator's hasNext() or next() is guaranteed to be nonblocking.

isRetryable() - Method in exception com.google.api.gax.rpc.ApiException

Returns whether the failed request can be retried.

isSendReady() - Method in class com.google.api.gax.rpc.BidiStream

Reports whether a message can be sent without requiring excessive buffering internally.

isSendReady() - Method in interface com.google.api.gax.rpc.ClientStream

Reports whether a new request can be sent without excessive buffering.

isShutdown() - Method in interface com.google.api.gax.core.BackgroundResource

Returns true if this background resource has been shut down.

isShutdown() - Method in class com.google.api.gax.core.BackgroundResourceAggregation

isShutdown() - Method in class com.google.api.gax.core.BaseBackgroundResource

isShutdown() - Method in class com.google.api.gax.core.ExecutorAsBackgroundResource

isTerminated() - Method in interface com.google.api.gax.core.BackgroundResource

Returns true if all work has completed following shut down.

isTerminated() - Method in class com.google.api.gax.core.BackgroundResourceAggregation

isTerminated() - Method in class com.google.api.gax.core.BaseBackgroundResource

isTerminated() - Method in class com.google.api.gax.core.ExecutorAsBackgroundResource

isThresholdReached() - Method in interface com.google.api.gax.batching.BatchingThreshold

Any calls into this function from ThresholdBatcher will be under a lock.

isThresholdReached() - Method in class com.google.api.gax.batching.NumericThreshold

iterateAll() - Method in class com.google.api.gax.paging.AbstractPage

iterateAll() - Method in class com.google.api.gax.paging.AbstractPagedListResponse

iterateAll() - Method in interface com.google.api.gax.paging.Page

Returns an iterable that traverses all of the elements of the underlying data source.

iterateAll() - Method in interface com.google.api.gax.paging.PagedListResponse

Returns an iterable that traverses all of the elements of the underlying data source.

iterateFixedSizeCollections(int) - Method in class com.google.api.gax.paging.AbstractPagedListResponse

iterateFixedSizeCollections(int) - Method in interface com.google.api.gax.paging.PagedListResponse

Returns an iterable over fixed size collections of results.

iteratePages() - Method in class com.google.api.gax.paging.AbstractPagedListResponse

iteratePages() - Method in interface com.google.api.gax.paging.PagedListResponse

Return an iterable over all Page objects.

iterator() - Method in class com.google.api.gax.rpc.ServerStream

L

LOCAL_ABORTED_STATUS_CODE - Static variable in exception com.google.api.gax.rpc.WatchdogTimeoutException

LongRunningClient - Interface in com.google.api.gax.rpc

Implementation-agnostic interface for managing long-running operations.

longRunningOperation(UnaryCallable<RequestT, OperationSnapshot>, OperationCallSettings<RequestT, ResponseT, MetadataT>, ClientContext, LongRunningClient) - Static method in class com.google.api.gax.rpc.Callables

Creates a callable object that represents a long-running operation.

lroStartFailed(Throwable) - Method in interface com.google.api.gax.tracing.ApiTracer

Signals that the initial RPC for the long running operation failed.

lroStartFailed(Throwable) - Method in class com.google.api.gax.tracing.NoopApiTracer

lroStartFailed(Throwable) - Method in class com.google.api.gax.tracing.OpencensusTracer

Signals that the initial RPC for the long running operation failed.

lroStartSucceeded() - Method in interface com.google.api.gax.tracing.ApiTracer

Signals that the initial RPC successfully started the long running operation.

lroStartSucceeded() - Method in class com.google.api.gax.tracing.NoopApiTracer

lroStartSucceeded() - Method in class com.google.api.gax.tracing.OpencensusTracer

Signals that the initial RPC successfully started the long running operation.

M

MaxOutstandingElementCountReachedException(long) - Constructor for exception com.google.api.gax.batching.FlowController.MaxOutstandingElementCountReachedException

MaxOutstandingRequestBytesReachedException(long) - Constructor for exception com.google.api.gax.batching.FlowController.MaxOutstandingRequestBytesReachedException

merge(B, B) - Method in interface com.google.api.gax.batching.BatchMerger

merge(RetrySettings.Builder) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

merge(ApiCallContext) - Method in interface com.google.api.gax.rpc.ApiCallContext

For any values in inputCallContext that are not null, override the corresponding values in the present instance.

merge(Batch<RequestT, ResponseT>) - Method in class com.google.api.gax.rpc.Batch

Merge the given batch into this batch.

mergeHeaders(Map<String, List<String>>, Map<String, List<String>>) - Static method in class com.google.api.gax.rpc.internal.Headers

N

needsCheckInterval() - Method in class com.google.api.gax.rpc.FixedWatchdogProvider

needsCheckInterval() - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

needsCheckInterval() - Method in interface com.google.api.gax.rpc.WatchdogProvider

needsClock() - Method in class com.google.api.gax.rpc.FixedWatchdogProvider

needsClock() - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

needsClock() - Method in interface com.google.api.gax.rpc.WatchdogProvider

needsEndpoint() - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

needsEndpoint() - Method in interface com.google.api.gax.rpc.TransportChannelProvider

True if the TransportProvider has no endpoint set.

needsExecutor() - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

needsExecutor() - Method in class com.google.api.gax.rpc.FixedWatchdogProvider

needsExecutor() - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

needsExecutor() - Method in interface com.google.api.gax.rpc.TransportChannelProvider

True if the TransportProvider needs an executor.

needsExecutor() - Method in interface com.google.api.gax.rpc.WatchdogProvider

needsHeaders() - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

needsHeaders() - Method in interface com.google.api.gax.rpc.TransportChannelProvider

True if the TransportProvider has no headers provided.

newBuilder() - Static method in class com.google.api.gax.batching.BatchingSettings

Get a new builder.

newBuilder() - Static method in class com.google.api.gax.batching.FlowControlSettings

newBuilder() - Static method in class com.google.api.gax.batching.ThresholdBatcher

Get a new builder for a ThresholdBatcher.

newBuilder() - Static method in class com.google.api.gax.core.GoogleCredentialsProvider

newBuilder() - Static method in class com.google.api.gax.core.InstantiatingExecutorProvider

newBuilder() - Static method in class com.google.api.gax.retrying.RetrySettings

newBuilder() - Static method in class com.google.api.gax.retrying.TimedAttemptSettings

newBuilder() - Static method in class com.google.api.gax.rpc.ApiClientHeaderProvider

newBuilder(BatchingDescriptor<RequestT, ResponseT>) - Static method in class com.google.api.gax.rpc.BatchingCallSettings

newBuilder() - Static method in class com.google.api.gax.rpc.ClientContext

newBuilder() - Static method in class com.google.api.gax.rpc.OperationCallSettings

Create a new builder which can construct an instance of OperationCallSettings.

newBuilder(PagedListResponseFactory<RequestT, ResponseT, PagedListResponseT>) - Static method in class com.google.api.gax.rpc.PagedCallSettings

newBuilder() - Static method in class com.google.api.gax.rpc.ServerStreamingCallSettings

newBuilder() - Static method in class com.google.api.gax.rpc.StreamingCallSettings

newTracer(ApiTracer, SpanName, ApiTracerFactory.OperationType) - Method in interface com.google.api.gax.tracing.ApiTracerFactory

Create a new ApiTracer that will be a child of the current context.

newTracer(ApiTracer, SpanName, ApiTracerFactory.OperationType) - Method in class com.google.api.gax.tracing.NoopApiTracerFactory

Create a new ApiTracer that will be a child of the current context.

newTracer(ApiTracer, SpanName, ApiTracerFactory.OperationType) - Method in class com.google.api.gax.tracing.OpencensusTracerFactory

Create a new ApiTracer that will be a child of the current context.

newUnaryCallSettingsBuilder() - Static method in class com.google.api.gax.rpc.UnaryCallSettings

nextRandomLong(long) - Method in class com.google.api.gax.retrying.ExponentialRetryAlgorithm

NoCredentialsProvider - Class in com.google.api.gax.core

NoCredentialsProvider is a CredentialsProvider which always returns null.

NoCredentialsProvider() - Constructor for class com.google.api.gax.core.NoCredentialsProvider

NoHeaderProvider - Class in com.google.api.gax.rpc

Implementation of HeaderProvider that provides empty headers.

NoHeaderProvider() - Constructor for class com.google.api.gax.rpc.NoHeaderProvider

NonCancellableFuture<ResponseT> - Class in com.google.api.gax.retrying

A future which cannot be cancelled from the external package.

NonCancellableFuture() - Constructor for class com.google.api.gax.retrying.NonCancellableFuture

NoopApiTracer - Class in com.google.api.gax.tracing

An implementation of ApiTracer that does nothing.

NoopApiTracerFactory - Class in com.google.api.gax.tracing

Factory that will build ApiTracers that do nothing.

NotFoundException - Exception in com.google.api.gax.rpc

Exception thrown when some requested entity (e.g., file or directory) was not found.

NotFoundException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.NotFoundException

NotFoundException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.NotFoundException

nullToSelf(ApiCallContext) - Method in interface com.google.api.gax.rpc.ApiCallContext

If inputContext is not null, returns it; if it is null, returns the present instance.

NumericThreshold<E> - Class in com.google.api.gax.batching

A threshold which accumulates a count based on the provided ElementCounter.

NumericThreshold(long, ElementCounter<E>) - Constructor for class com.google.api.gax.batching.NumericThreshold

Constructs a NumericThreshold.

O

of(String, String) - Static method in class com.google.api.gax.tracing.SpanName

Creates a new instance of the name.

onComplete() - Method in interface com.google.api.gax.rpc.ResponseObserver

Receives a notification of successful stream completion.

onComplete() - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

Receives a notification of successful stream completion.

onCompleted() - Method in interface com.google.api.gax.rpc.ApiStreamObserver

Receives a notification of successful stream completion.

onCompleteImpl() - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

onError(Throwable) - Method in interface com.google.api.gax.rpc.ApiStreamObserver

Receives a terminating error from the stream.

onError(Throwable) - Method in interface com.google.api.gax.rpc.ResponseObserver

Receives a terminating error from the stream.

onError(Throwable) - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

Receives a terminating error from the stream.

onErrorImpl(Throwable) - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

onNext(V) - Method in interface com.google.api.gax.rpc.ApiStreamObserver

Receives a value from the stream.

onReady(ClientStream<V>) - Method in interface com.google.api.gax.rpc.ClientStreamReadyObserver

onResponse(V) - Method in interface com.google.api.gax.rpc.ResponseObserver

Receives a value from the stream.

onResponse(V) - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

Receives a value from the stream.

onResponseImpl(V) - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

onStart(StreamController) - Method in interface com.google.api.gax.rpc.ResponseObserver

Called before the stream is started.

onStart(StreamController) - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

Called before the stream is started.

onStartImpl(StreamController) - Method in class com.google.api.gax.rpc.StateCheckingResponseObserver

OpencensusTracer - Class in com.google.api.gax.tracing

Implementation of ApiTracer that uses OpenCensus.

OpencensusTracerFactory - Class in com.google.api.gax.tracing

A ApiTracerFactory to build instances of OpencensusTracer.

OpencensusTracerFactory() - Constructor for class com.google.api.gax.tracing.OpencensusTracerFactory

Instantiates a new instance capturing the Tracer in Tracing.getTracer.

OpencensusTracerFactory(Map<String, String>) - Constructor for class com.google.api.gax.tracing.OpencensusTracerFactory

Instantiates a new instance capturing the Tracer in Tracing.getTracer.

OperationCallable<RequestT,ResponseT,MetadataT> - Class in com.google.api.gax.rpc

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.

OperationCallable() - Constructor for class com.google.api.gax.rpc.OperationCallable

OperationCallSettings<RequestT,ResponseT,MetadataT> - Class in com.google.api.gax.rpc

A settings class to configure an OperationCallable for calls to initiate, resume, and cancel a long-running operation.

OperationCallSettings.Builder<RequestT,ResponseT,MetadataT> - Class in com.google.api.gax.rpc

operationCancelled() - Method in interface com.google.api.gax.tracing.ApiTracer

Signals that the operation was cancelled by the user.

operationCancelled() - Method in class com.google.api.gax.tracing.NoopApiTracer

operationCancelled() - Method in class com.google.api.gax.tracing.OpencensusTracer

Signals that the operation was cancelled by the user.

operationFailed(Throwable) - Method in interface com.google.api.gax.tracing.ApiTracer

Signals that the overall operation has failed and no further attempts will be made.

operationFailed(Throwable) - Method in class com.google.api.gax.tracing.NoopApiTracer

operationFailed(Throwable) - Method in class com.google.api.gax.tracing.OpencensusTracer

Signals that the overall operation has failed and no further attempts will be made.

OperationFuture<ResponseT,MetadataT> - Interface in com.google.api.gax.longrunning

An ApiFuture which tracks polling of a service.

OperationFutureImpl<ResponseT,MetadataT> - Class in com.google.api.gax.longrunning

An ApiFuture which tracks polling of a service.

OperationFutureImpl(RetryingFuture<OperationSnapshot>, ApiFuture<OperationSnapshot>, ApiFunction<OperationSnapshot, ResponseT>, ApiFunction<OperationSnapshot, MetadataT>) - Constructor for class com.google.api.gax.longrunning.OperationFutureImpl

Creates a new operation future instance.

OperationFutureImpl(RetryingFuture<OperationSnapshot>, ApiFuture<OperationSnapshot>, ApiFunction<OperationSnapshot, ResponseT>, ApiFunction<OperationSnapshot, MetadataT>, ApiFunction<Exception, ResponseT>) - Constructor for class com.google.api.gax.longrunning.OperationFutureImpl

OperationFutures - Class in com.google.api.gax.longrunning

OperationResponsePollAlgorithm - Class in com.google.api.gax.longrunning

Operation polling algorithm, which keeps retrying until OperationSnapshot.isDone() is true.

OperationResponsePollAlgorithm() - Constructor for class com.google.api.gax.longrunning.OperationResponsePollAlgorithm

OperationSnapshot - Interface in com.google.api.gax.longrunning

A snapshot of a long-running operation.

operationSucceeded() - Method in interface com.google.api.gax.tracing.ApiTracer

Signals that the overall operation has finished successfully.

operationSucceeded() - Method in class com.google.api.gax.tracing.NoopApiTracer

operationSucceeded() - Method in class com.google.api.gax.tracing.OpencensusTracer

Signals that the overall operation has finished successfully.

OperationTimedPollAlgorithm - Class in com.google.api.gax.longrunning

Operation timed polling algorithm, which uses exponential backoff factor for determining when the next polling operation should be executed.

OutOfRangeException - Exception in com.google.api.gax.rpc

Exception thrown when the operation was attempted past the valid range.

OutOfRangeException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.OutOfRangeException

OutOfRangeException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.OutOfRangeException

P

Page<ResourceT> - Interface in com.google.api.gax.paging

A Page object wraps an API list method response.

PageContext<RequestT,ResponseT,ResourceT> - Class in com.google.api.gax.rpc

The context for a page call.

PageContext() - Constructor for class com.google.api.gax.rpc.PageContext

paged(UnaryCallable<RequestT, ResponseT>, PagedCallSettings<RequestT, ResponseT, PagedListResponseT>) - Static method in class com.google.api.gax.rpc.Callables

Create a paged callable object that represents a paged API method.

PagedCallable<RequestT,ResponseT,PagedListResponseT> - Class in com.google.api.gax.rpc

A UnaryCallable which provides page streaming functionality for unary calls.

PagedCallable(UnaryCallable<RequestT, ResponseT>, PagedListResponseFactory<RequestT, ResponseT, PagedListResponseT>) - Constructor for class com.google.api.gax.rpc.PagedCallable

PagedCallSettings<RequestT,ResponseT,PagedListResponseT> - Class in com.google.api.gax.rpc

A settings class to configure a UnaryCallable for calls to an API method that supports page streaming.

PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT> - Class in com.google.api.gax.rpc

PagedListDescriptor<RequestT,ResponseT,ResourceT> - Interface in com.google.api.gax.rpc

An interface which provides the functionality to extract data from requests and inject data into requests for the purposes of page streaming.

PagedListResponse<ResourceT> - Interface in com.google.api.gax.paging

Response for paged results from a list API method

PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT> - Interface in com.google.api.gax.rpc

Interface for constructing futures which return PagedListResponse objects.

Pages - Class in com.google.api.gax.paging

Utility class for Pages.

PartitionKey - Class in com.google.api.gax.batching

PartitionKey(Object...) - Constructor for class com.google.api.gax.batching.PartitionKey

peekAttemptResult() - Method in interface com.google.api.gax.retrying.RetryingFuture

Returns latest completed attempt result or null if the first attempt hasn't completed yet.

peekMetadata() - Method in interface com.google.api.gax.longrunning.OperationFuture

Peeks at the metadata of the operation tracked by this OperationFuture.

peekMetadata() - Method in class com.google.api.gax.longrunning.OperationFutureImpl

PermissionDeniedException - Exception in com.google.api.gax.rpc

Exception thrown when the caller does not have permission to execute the specified operation.

PermissionDeniedException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.PermissionDeniedException

PermissionDeniedException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.PermissionDeniedException

PollException - Exception in com.google.api.gax.retrying

PollException is thrown when polling algorithm exceeds total timeout or total number of attempts.

PollException() - Constructor for exception com.google.api.gax.retrying.PollException

Constructs a PollException with no specified detail message.

PollException(String) - Constructor for exception com.google.api.gax.retrying.PollException

Constructs a new poll timeout exception with the specified detail message.

processBatch(T) - Method in class com.google.api.gax.batching.AccumulatingBatchReceiver

processBatch(BatchT) - Method in interface com.google.api.gax.batching.ThresholdBatchReceiver

Process the given batch asynchronously.

processResponse(ResponseT) - Method in class com.google.api.gax.retrying.SimpleStreamResumptionStrategy

processResponse(ResponseT) - Method in interface com.google.api.gax.retrying.StreamResumptionStrategy

Called by the ServerStreamingAttemptCallable when a response has been successfully received.

pushCurrentBatch() - Method in class com.google.api.gax.batching.ThresholdBatcher

Push the current batch to the batch receiver.

R

record(int) - Method in class com.google.api.gax.core.Distribution

Records a new value.

release(T) - Method in class com.google.api.gax.batching.BatchingFlowController

release(long, long) - Method in class com.google.api.gax.batching.FlowController

request(int) - Method in interface com.google.api.gax.rpc.StreamController

Requests up to the given number of responses from the call to be delivered to ResponseObserver.onResponse(Object).

RequestBuilder<RequestT> - Interface in com.google.api.gax.batching

RequestParamsEncoder<RequestT> - Interface in com.google.api.gax.rpc

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> - Interface in com.google.api.gax.rpc

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.

requestSent() - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that a streaming request has been sent.

requestSent() - Method in class com.google.api.gax.tracing.NoopApiTracer

requestSent() - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that a streaming request has been sent.

RequestUrlParamsEncoder<RequestT> - Class in com.google.api.gax.rpc

The request params encoder, which encodes URL-encoded parameters in one URL parameters string.

RequestUrlParamsEncoder(RequestParamsExtractor<RequestT>, boolean) - Constructor for class com.google.api.gax.rpc.RequestUrlParamsEncoder

Creates the encoder.

reserve(T) - Method in class com.google.api.gax.batching.BatchingFlowController

reserve(long, long) - Method in class com.google.api.gax.batching.FlowController

ResourceCloseException - Exception in com.google.api.gax.core

An exception occurs when some background resource is not able to close properly.

ResourceCloseException(Exception) - Constructor for exception com.google.api.gax.core.ResourceCloseException

ResourceExhaustedException - Exception in com.google.api.gax.rpc

Exception thrown when some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.

ResourceExhaustedException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.ResourceExhaustedException

ResourceExhaustedException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.ResourceExhaustedException

ResponseObserver<V> - Interface in com.google.api.gax.rpc

Receives notifications from server-streaming calls.

responseReceived() - Method in interface com.google.api.gax.tracing.ApiTracer

Adds an annotation that a streaming response has been received.

responseReceived() - Method in class com.google.api.gax.tracing.NoopApiTracer

responseReceived() - Method in class com.google.api.gax.tracing.OpencensusTracer

Adds an annotation that a streaming response has been received.

ResultRetryAlgorithm<ResponseT> - Interface in com.google.api.gax.retrying

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.

resumeFutureCall(String, ApiCallContext) - Method in class com.google.api.gax.rpc.OperationCallable

Creates a new OperationFuture to watch an operation that has been initiated previously.

resumeFutureCall(String) - Method in class com.google.api.gax.rpc.OperationCallable

Creates a new OperationFuture to watch an operation that has been initiated previously.

resumeFutureCall(String, ApiCallContext) - Method in class com.google.api.gax.tracing.TracedOperationCallable

Wrap the polling logical operations in a single parent trace using a ApiTracerFactory.OperationType.LongRunning ApiTracer.

RetryAlgorithm<ResponseT> - Class in com.google.api.gax.retrying

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.

RetryAlgorithm(ResultRetryAlgorithm<ResponseT>, TimedRetryAlgorithm) - Constructor for class com.google.api.gax.retrying.RetryAlgorithm

Creates a new retry algorithm instance, which uses thrown exception or returned response and timed algorithms to make a decision.

retrying(UnaryCallable<RequestT, ResponseT>, UnaryCallSettings<?, ?>, ClientContext) - Static method in class com.google.api.gax.rpc.Callables

retrying(ServerStreamingCallable<RequestT, ResponseT>, ServerStreamingCallSettings<RequestT, ResponseT>, ClientContext) - Static method in class com.google.api.gax.rpc.Callables

RetryingContext - Interface in com.google.api.gax.retrying

Context for a retryable operation.

RetryingExecutor<ResponseT> - Interface in com.google.api.gax.retrying

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.

RetryingExecutorWithContext<ResponseT> - Interface in com.google.api.gax.retrying

A RetryingExecutor that accepts a per-operation context.

RetryingFuture<ResponseT> - Interface in com.google.api.gax.retrying

Represents a retrying future.

RetrySettings - Class in com.google.api.gax.retrying

Holds the parameters for retry or poll logic with jitter, timeout and exponential backoff.

RetrySettings() - Constructor for class com.google.api.gax.retrying.RetrySettings

RetrySettings.Builder - Class in com.google.api.gax.retrying

A base builder class for RetrySettings.

run() - Method in class com.google.api.gax.rpc.Watchdog

S

ScheduledRetryingExecutor<ResponseT> - Class in com.google.api.gax.retrying

The retry executor which uses ScheduledExecutorService to schedule an attempt tasks.

ScheduledRetryingExecutor(RetryAlgorithm<ResponseT>, ScheduledExecutorService) - Constructor for class com.google.api.gax.retrying.ScheduledRetryingExecutor

Creates a new scheduled retry executor, which will be using scheduler for actual attempts scheduling and retryAlgorithm for retrying strategy.

self() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

self() - Method in class com.google.api.gax.rpc.StubSettings.Builder

send(RequestT) - Method in class com.google.api.gax.rpc.BidiStream

Send req to the server.

send(RequestT) - Method in interface com.google.api.gax.rpc.ClientStream

Sends a request to the server.

sendResult() - Method in class com.google.api.gax.rpc.BatchedRequestIssuer

Sends back the result that was stored by either setResponse or setException

ServerStream<V> - Class in com.google.api.gax.rpc

A blocking Iterable-style wrapper around server stream responses.

ServerStreamingAttemptException - Exception in com.google.api.gax.retrying

A wrapper exception thrown by ServerStreamingAttemptCallable to communicate additional context to the StreamingRetryAlgorithm and to pass the original cancellation stack trace to RetryingServerStreamingCallable.

ServerStreamingAttemptException(Throwable, boolean, boolean) - Constructor for exception com.google.api.gax.retrying.ServerStreamingAttemptException

serverStreamingCall(RequestT, ApiStreamObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Deprecated.

Please use the ResponseObserver variant instead.

serverStreamingCall(RequestT, ApiStreamObserver<ResponseT>) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Deprecated.

Please use the ResponseObserver variant instead.

ServerStreamingCallable<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A ServerStreamingCallable is an immutable object which is capable of making RPC calls to server streaming API methods.

ServerStreamingCallable() - Constructor for class com.google.api.gax.rpc.ServerStreamingCallable

ServerStreamingCallSettings<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A settings class to configure a ServerStreamingCallable.

ServerStreamingCallSettings.Builder<RequestT,ResponseT> - Class in com.google.api.gax.rpc

set(ResponseT) - Method in class com.google.api.gax.rpc.BatchedFuture

setApiClientHeaderKey(String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setAttemptCount(int) - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Set the attempt count.

setAttemptFuture(ApiFuture<ResponseT>) - Method in interface com.google.api.gax.retrying.RetryingFuture

Sets the attempt in a form of a future.

setBackgroundResources(List<BackgroundResource>) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setBatchingSettings(BatchingSettings) - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

setBatchMerger(BatchMerger<E>) - Method in class com.google.api.gax.batching.ThresholdBatcher.Builder

Set the batch merger for the ThresholdBatcher.

setClientLibToken(String, String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setClientRuntimeToken(String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setClock(ApiClock) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setClock(ApiClock) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Sets the clock to use for retry logic.

setClock(ApiClock) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets the clock to use for retry logic.

setCredentials(Credentials) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setCredentialsProvider(CredentialsProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Sets the CredentialsProvider to use for getting the credentials to make calls with.

setCredentialsProvider(CredentialsProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets the CredentialsProvider to use for getting the credentials to make calls with.

setDefaultCallContext(ApiCallContext) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setDelayThreshold(Duration) - Method in class com.google.api.gax.batching.BatchingSettings.Builder

Set the delay threshold to use for batching.

setElementCountThreshold(Long) - Method in class com.google.api.gax.batching.BatchingSettings.Builder

Set the element count threshold to use for batching.

setEndpoint(String) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setEndpoint(String) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

setEndpoint(String) - Method in class com.google.api.gax.rpc.StubSettings.Builder

setException(Throwable) - Method in class com.google.api.gax.rpc.BatchedFuture

setException(Throwable) - Method in class com.google.api.gax.rpc.BatchedRequestIssuer

Set the exception to set on the batched future.

setExecutor(ScheduledExecutorService) - Method in class com.google.api.gax.batching.ThresholdBatcher.Builder

Set the executor for the ThresholdBatcher.

setExecutor(ScheduledExecutorService) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setExecutorProvider(ExecutorProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Sets the ExecutorProvider to use for getting the executor to use for running asynchronous API call logic (such as retries and long-running operations), and also to pass to the transport settings if an executor is needed for the transport and it doesn't have its own executor provider.

setExecutorProvider(ExecutorProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets the ExecutorProvider to use for getting the executor to use for running asynchronous API call logic (such as retries and long-running operations), and also to pass to the transport settings if an executor is needed for the transport and it doesn't have its own executor provider.

setExecutorThreadCount(int) - Method in class com.google.api.gax.core.InstantiatingExecutorProvider.Builder

setFirstAttemptStartTimeNanos(long) - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Set the start time of the first attempt.

setFlowController(BatchingFlowController<E>) - Method in class com.google.api.gax.batching.ThresholdBatcher.Builder

Set the flow controller for the ThresholdBatcher.

setFlowController(FlowController) - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

setFlowControlSettings(FlowControlSettings) - Method in class com.google.api.gax.batching.BatchingSettings.Builder

Set the flow control settings to be used.

setGeneratedLibToken(String, String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setGlobalSettings(RetrySettings) - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Sets global (attempt-independent) retry settings.

setHeaderProvider(HeaderProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Sets the HeaderProvider for getting custom static headers for http requests.

setHeaderProvider(HeaderProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets the HeaderProvider for getting custom static headers for http requests.

setHeaders(Map<String, String>) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setIdleTimeout(Duration) - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

See the class documentation of ServerStreamingCallSettings for a description of what the ServerStreamingCallSettings.Builder.idleTimeout does.

setInitialCallSettings(UnaryCallSettings<RequestT, OperationSnapshot>) - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

Set the call settings which are used on the call to initiate the operation.

setInitialRetryDelay(Duration) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

InitialRetryDelay controls the delay before the first retry.

setInitialRpcTimeout(Duration) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

InitialRpcTimeout controls the timeout for the initial RPC.

setInternalHeaderProvider(HeaderProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Sets the HeaderProvider for getting internal (library-defined) static headers for http requests.

setInternalHeaderProvider(HeaderProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets the HeaderProvider for getting internal (library-defined) static headers for http requests.

setInternalHeaders(Map<String, String>) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setIsEnabled(Boolean) - Method in class com.google.api.gax.batching.BatchingSettings.Builder

Set if the batch should be enabled.

setJittered(boolean) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

Jitter determines if the delay time should be randomized.

setJvmToken(String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setJwtEnabledScopes(List<String>) - Method in class com.google.api.gax.core.GoogleCredentialsProvider.Builder

Sets the scopes that are compatible with JWT tokens.

setLimitExceededBehavior(FlowController.LimitExceededBehavior) - Method in class com.google.api.gax.batching.FlowControlSettings.Builder

setMaxAttempts(int) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

MaxAttempts defines the maximum number of attempts to perform.

setMaxDelay(Duration) - Method in class com.google.api.gax.batching.ThresholdBatcher.Builder

Set the max delay for a batch.

setMaxOutstandingElementCount(Long) - Method in class com.google.api.gax.batching.FlowControlSettings.Builder

setMaxOutstandingRequestBytes(Long) - Method in class com.google.api.gax.batching.FlowControlSettings.Builder

setMaxRetryDelay(Duration) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

MaxRetryDelay puts a limit on the value of the retry delay, so that the RetryDelayMultiplier can't increase the retry delay higher than this amount.

setMaxRpcTimeout(Duration) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

MaxRpcTimeout puts a limit on the value of the RPC timeout, so that the RpcTimeoutMultiplier can't increase the RPC timeout higher than this amount.

setMetadataTransformer(ApiFunction<OperationSnapshot, MetadataT>) - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

setOverallAttemptCount(int) - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Set the overall attempt count.

setPollingAlgorithm(TimedRetryAlgorithm) - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

Set the polling algorithm of the operation.

setRandomizedRetryDelay(Duration) - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Sets randomized attempt delay.

setReceiver(ThresholdBatchReceiver<E>) - Method in class com.google.api.gax.batching.ThresholdBatcher.Builder

Set the threshold batch receiver for the ThresholdBatcher.

setRequestByteThreshold(Long) - Method in class com.google.api.gax.batching.BatchingSettings.Builder

Set the request byte threshold to use for batching.

setResourceHeaderKey(String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setResourceToken(String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setResponse(ResponseT) - Method in class com.google.api.gax.rpc.BatchedRequestIssuer

Set the response to set on the batched future.

setResponseTransformer(ApiFunction<OperationSnapshot, ResponseT>) - Method in class com.google.api.gax.rpc.OperationCallSettings.Builder

setResumptionStrategy(StreamResumptionStrategy<RequestT, ResponseT>) - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

See the class documentation of ServerStreamingCallSettings for a description of what StreamResumptionStrategy does.

setRetryableCodes(Set<StatusCode.Code>) - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

setRetryableCodes(StatusCode.Code...) - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

setRetryableCodes(Set<StatusCode.Code>) - Method in class com.google.api.gax.rpc.PagedCallSettings.Builder

setRetryableCodes(StatusCode.Code...) - Method in class com.google.api.gax.rpc.PagedCallSettings.Builder

setRetryableCodes(StatusCode.Code...) - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

See the class documentation of ServerStreamingCallSettings for a description of what retryableCodes do.

setRetryableCodes(Set<StatusCode.Code>) - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

See the class documentation of ServerStreamingCallSettings for a description of what retryableCodes do.

setRetryableCodes(Set<StatusCode.Code>) - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder

See the class documentation of UnaryCallSettings for a description of what retryable codes do.

setRetryableCodes(StatusCode.Code...) - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder

See the class documentation of UnaryCallSettings for a description of what retryable codes do.

setRetryDelay(Duration) - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Sets the calculated retry delay.

setRetryDelayMultiplier(double) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

RetryDelayMultiplier controls the change in retry delay.

setRetrySettings(RetrySettings) - Method in class com.google.api.gax.rpc.BatchingCallSettings.Builder

setRetrySettings(RetrySettings) - Method in class com.google.api.gax.rpc.PagedCallSettings.Builder

setRetrySettings(RetrySettings) - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

See the class documentation of ServerStreamingCallSettings for a description of what retrySettings do.

setRetrySettings(RetrySettings) - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder

setRpcTimeout(Duration) - Method in class com.google.api.gax.retrying.TimedAttemptSettings.Builder

Sets rpc timeout used for this attempt.

setRpcTimeoutMultiplier(double) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

See the class documentation of RetrySettings for a description of what this value does.

setScopesToApply(List<String>) - Method in class com.google.api.gax.core.GoogleCredentialsProvider.Builder

Sets the scopes to apply to the credentials that are acquired from Application Default Credentials, before the credentials are sent to the service.

setSimpleTimeoutNoRetries(Duration) - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder

Disables retries and sets the overall timeout.

setSimpleTimeoutNoRetries(Duration) - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder

Disables retries and sets the RPC timeout.

setStreamWatchdog(Watchdog) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setStreamWatchdogCheckInterval(Duration) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setStreamWatchdogCheckInterval(Duration) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets how often the Watchdog will check ongoing streaming RPCs.

setStreamWatchdogProvider(WatchdogProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets the WatchdogProvider to use for streaming RPC.

setThreadFactory(ThreadFactory) - Method in class com.google.api.gax.core.InstantiatingExecutorProvider.Builder

setThresholds(Collection<BatchingThreshold<E>>) - Method in class com.google.api.gax.batching.ThresholdBatcher.Builder

Set the thresholds for the ThresholdBatcher.

setTotalTimeout(Duration) - Method in class com.google.api.gax.retrying.RetrySettings.Builder

TotalTimeout has ultimate control over how long the logic should keep trying the remote call until it gives up completely.

setTracerFactory(ApiTracerFactory) - Method in class com.google.api.gax.rpc.ClientContext.Builder

Set the ApiTracerFactory that will be used to generate traces for operations.

setTracerFactory(ApiTracerFactory) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Configures the ApiTracerFactory that will be used to generate traces.

setTransportChannel(TransportChannel) - Method in class com.google.api.gax.rpc.ClientContext.Builder

setTransportChannelProvider(TransportChannelProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

Sets the TransportProvider to use for getting the transport-specific context to make calls with.

setTransportChannelProvider(TransportChannelProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder

Sets the TransportProvider to use for getting the transport-specific context to make calls with.

setTransportToken(String, String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder

setWatchdogCheckInterval(Duration) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

setWatchdogProvider(WatchdogProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder

shouldAutoClose() - Method in interface com.google.api.gax.core.ExecutorProvider

Indicates whether the executor should be closed by the containing client class.

shouldAutoClose() - Method in class com.google.api.gax.core.FixedExecutorProvider

shouldAutoClose() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider

shouldAutoClose() - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

shouldAutoClose() - Method in interface com.google.api.gax.rpc.TransportChannelProvider

Indicates whether the TransportChannel should be closed by the containing client class.

shouldRetry(Throwable, OperationSnapshot) - Method in class com.google.api.gax.longrunning.OperationResponsePollAlgorithm

shouldRetry(TimedAttemptSettings) - Method in class com.google.api.gax.longrunning.OperationTimedPollAlgorithm

Returns true if another poll operation should be made or throws CancellationException otherwise.

shouldRetry(Throwable, ResponseT) - Method in class com.google.api.gax.retrying.BasicResultRetryAlgorithm

Returns true if an exception was thrown (prevThrowable != null), false otherwise.

shouldRetry(TimedAttemptSettings) - Method in class com.google.api.gax.retrying.ExponentialPollAlgorithm

Returns true if another poll operation should be made or throws PollException, if either total timeout or total number of attempts is exceeded.

shouldRetry(TimedAttemptSettings) - Method in class com.google.api.gax.retrying.ExponentialRetryAlgorithm

Returns true if another attempt should be made, or false otherwise.

shouldRetry(Throwable, ResponseT) - Method in interface com.google.api.gax.retrying.ResultRetryAlgorithm

Returns true if another attempt should be made, or false otherwise.

shouldRetry(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.RetryAlgorithm

Returns true if another attempt should be made, or false otherwise.

shouldRetry(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.StreamingRetryAlgorithm

Returns true if another attempt should be made, or false otherwise.

shouldRetry(TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithm

Returns true if another attempt should be made, or false otherwise.

shutdown() - Method in interface com.google.api.gax.core.BackgroundResource

Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted.

shutdown() - Method in class com.google.api.gax.core.BackgroundResourceAggregation

shutdown() - Method in class com.google.api.gax.core.BaseBackgroundResource

shutdown() - Method in class com.google.api.gax.core.ExecutorAsBackgroundResource

shutdownNow() - Method in interface com.google.api.gax.core.BackgroundResource

Attempts to stop all actively executing work and halts the processing of waiting work.

shutdownNow() - Method in class com.google.api.gax.core.BackgroundResourceAggregation

shutdownNow() - Method in class com.google.api.gax.core.BaseBackgroundResource

shutdownNow() - Method in class com.google.api.gax.core.ExecutorAsBackgroundResource

SimpleStreamResumptionStrategy<RequestT,ResponseT> - Class in com.google.api.gax.retrying

Simplest implementation of a StreamResumptionStrategy which returns the initial request for unstarted streams.

SimpleStreamResumptionStrategy() - Constructor for class com.google.api.gax.retrying.SimpleStreamResumptionStrategy

sleep(Duration) - Method in class com.google.api.gax.retrying.DirectRetryingExecutor

This method simply calls Thread.sleep(long).

SpanName - Class in com.google.api.gax.tracing

A value class to represent the name of the operation in an ApiTracer.

SpanName() - Constructor for class com.google.api.gax.tracing.SpanName

splitCall(ResponseObserver<ResponseT>) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Send requests to the server and listens to responses.

splitCall(ResponseObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Send requests to the server and listens to responses.

splitException(Throwable, Collection<? extends BatchedRequestIssuer<ResponseT>>) - Method in interface com.google.api.gax.rpc.BatchingDescriptor

Splits the exception that resulted from a batched call into an individual setException call on each RequestIssuer.

splitResponse(ResponseT, Collection<? extends BatchedRequestIssuer<ResponseT>>) - Method in interface com.google.api.gax.rpc.BatchingDescriptor

Splits the result from a batched call into an individual setResponse call on each RequestIssuer.

StateCheckingResponseObserver<V> - Class in com.google.api.gax.rpc

Base implementation of ResponseObserver that performs state sanity checks.

StateCheckingResponseObserver() - Constructor for class com.google.api.gax.rpc.StateCheckingResponseObserver

StatusCode - Interface in com.google.api.gax.rpc

Transport-specific status code.

StatusCode.Code - Enum in com.google.api.gax.rpc

StreamController - Interface in com.google.api.gax.rpc

Allows the implementer of ResponseObserver to control the flow of responses.

StreamingCallSettings<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A settings class to configure a streaming callable object for calls to a streaming API method.

StreamingCallSettings() - Constructor for class com.google.api.gax.rpc.StreamingCallSettings

StreamingCallSettings.Builder<RequestT,ResponseT> - Class in com.google.api.gax.rpc

StreamingRetryAlgorithm<ResponseT> - Class in com.google.api.gax.retrying

The streaming retry algorithm, which makes decision based either on the thrown exception and the execution time settings of the previous attempt.

StreamingRetryAlgorithm(ResultRetryAlgorithm<ResponseT>, TimedRetryAlgorithm) - Constructor for class com.google.api.gax.retrying.StreamingRetryAlgorithm

StreamResumptionStrategy<RequestT,ResponseT> - Interface in com.google.api.gax.retrying

This is part of the server streaming retry api.

StubSettings<SettingsT extends StubSettings<SettingsT>> - Class in com.google.api.gax.rpc

A base settings class to configure a client stub class.

StubSettings(StubSettings.Builder) - Constructor for class com.google.api.gax.rpc.StubSettings

Constructs an instance of StubSettings.

StubSettings.Builder<SettingsT extends StubSettings<SettingsT>,B extends StubSettings.Builder<SettingsT,B>> - Class in com.google.api.gax.rpc

submit(RetryingFuture<ResponseT>) - Method in class com.google.api.gax.retrying.DirectRetryingExecutor

Submits an attempt for execution in the current thread, causing the current thread to sleep for the specified by the RetryingFuture.getAttemptSettings() amount of time.

submit(RetryingFuture<ResponseT>) - Method in interface com.google.api.gax.retrying.RetryingExecutor

Submits an attempt for execution.

submit(RetryingFuture<ResponseT>) - Method in class com.google.api.gax.retrying.ScheduledRetryingExecutor

Submits an attempt for execution in a different thread.

T

ThresholdBatcher<E> - Class in com.google.api.gax.batching

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.

ThresholdBatcher.Builder<E> - Class in com.google.api.gax.batching

Builder for a ThresholdBatcher.

ThresholdBatchReceiver<BatchT> - Interface in com.google.api.gax.batching

Interface representing an object that receives batches from a ThresholdBatcher and takes action on them.

TimedAttemptSettings - Class in com.google.api.gax.retrying

Timed attempt execution settings.

TimedAttemptSettings() - Constructor for class com.google.api.gax.retrying.TimedAttemptSettings

TimedAttemptSettings.Builder - Class in com.google.api.gax.retrying

TimedRetryAlgorithm - Interface in com.google.api.gax.retrying

A timed retry algorithm is responsible for the following operations, based on the previous attempt settings and current time: Creating first attempt TimedAttemptSettings.

toBuilder() - Method in class com.google.api.gax.batching.BatchingSettings

Get a builder with the same values as this object.

toBuilder() - Method in class com.google.api.gax.batching.FlowControlSettings

toBuilder() - Method in class com.google.api.gax.core.GoogleCredentialsProvider

toBuilder() - Method in class com.google.api.gax.core.InstantiatingExecutorProvider

toBuilder() - Method in class com.google.api.gax.retrying.RetrySettings

toBuilder() - Method in class com.google.api.gax.retrying.TimedAttemptSettings

toBuilder() - Method in class com.google.api.gax.rpc.BatchingCallSettings

toBuilder() - Method in class com.google.api.gax.rpc.ClientContext

toBuilder() - Method in class com.google.api.gax.rpc.ClientSettings

toBuilder() - Method in class com.google.api.gax.rpc.OperationCallSettings

toBuilder() - Method in class com.google.api.gax.rpc.PagedCallSettings

toBuilder() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings

toBuilder() - Method in class com.google.api.gax.rpc.StreamingCallSettings

toBuilder() - Method in class com.google.api.gax.rpc.StubSettings

toBuilder() - Method in class com.google.api.gax.rpc.UnaryCallSettings

toString() - Method in exception com.google.api.gax.batching.FlowController.MaxOutstandingElementCountReachedException

toString() - Method in exception com.google.api.gax.batching.FlowController.MaxOutstandingRequestBytesReachedException

toString() - Method in class com.google.api.gax.core.Distribution

toString() - Method in class com.google.api.gax.rpc.ClientSettings.Builder

toString() - Method in class com.google.api.gax.rpc.ClientSettings

toString() - Method in class com.google.api.gax.rpc.PagedCallable

toString() - Method in class com.google.api.gax.rpc.StubSettings.Builder

toString() - Method in class com.google.api.gax.rpc.StubSettings

toString() - Method in class com.google.api.gax.tracing.SpanName

TracedBatchingCallable<RequestT,ResponseT> - Class in com.google.api.gax.tracing

This callable wraps a batching callable chain in a ApiTracer.

TracedBatchingCallable(UnaryCallable<RequestT, ResponseT>, ApiTracerFactory, SpanName, BatchingDescriptor<RequestT, ResponseT>) - Constructor for class com.google.api.gax.tracing.TracedBatchingCallable

TracedBidiCallable<RequestT,ResponseT> - Class in com.google.api.gax.tracing

A wrapper callable that will wrap a callable chain in a trace.

TracedBidiCallable(BidiStreamingCallable<RequestT, ResponseT>, ApiTracerFactory, SpanName) - Constructor for class com.google.api.gax.tracing.TracedBidiCallable

TracedClientStreamingCallable<RequestT,ResponseT> - Class in com.google.api.gax.tracing

A wrapper callable that will wrap a callable chain in a trace.

TracedClientStreamingCallable(ClientStreamingCallable<RequestT, ResponseT>, ApiTracerFactory, SpanName) - Constructor for class com.google.api.gax.tracing.TracedClientStreamingCallable

TracedOperationCallable<RequestT,ResponseT,MetadataT> - Class in com.google.api.gax.tracing

This callable wraps a OperationCallable in a ApiTracer.

TracedOperationCallable(OperationCallable<RequestT, ResponseT, MetadataT>, ApiTracerFactory, SpanName) - Constructor for class com.google.api.gax.tracing.TracedOperationCallable

TracedOperationInitialCallable<RequestT> - Class in com.google.api.gax.tracing

Traces the initial RPC of a long running operation.

TracedOperationInitialCallable(UnaryCallable<RequestT, OperationSnapshot>, ApiTracerFactory, SpanName) - Constructor for class com.google.api.gax.tracing.TracedOperationInitialCallable

TracedServerStreamingCallable<RequestT,ResponseT> - Class in com.google.api.gax.tracing

A wrapper callable that will wrap a callable chain in a trace.

TracedServerStreamingCallable(ServerStreamingCallable<RequestT, ResponseT>, ApiTracerFactory, SpanName) - Constructor for class com.google.api.gax.tracing.TracedServerStreamingCallable

TracedUnaryCallable<RequestT,ResponseT> - Class in com.google.api.gax.tracing

This callable wraps a callable chain in a ApiTracer.

TracedUnaryCallable(UnaryCallable<RequestT, ResponseT>, ApiTracerFactory, SpanName) - Constructor for class com.google.api.gax.tracing.TracedUnaryCallable

TranslatingUnaryCallable<InnerRequestT,InnerResponseT,OuterRequestT,OuterResponseT> - Class in com.google.api.gax.rpc

A UnaryCallable that translates request types and response types using the given transformers.

TransportChannel - Interface in com.google.api.gax.rpc

Class whose instances can issue RPCs on a particular transport.

TransportChannelProvider - Interface in com.google.api.gax.rpc

Provides an interface to either build a TransportChannel or provide a fixed TransportChannel that will be used to make calls to a service.

U

UnaryCallable<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A UnaryCallable is an immutable object which is capable of making RPC calls to non-streaming API methods.

UnaryCallable() - Constructor for class com.google.api.gax.rpc.UnaryCallable

UnaryCallSettings<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A base settings class to configure a UnaryCallable.

UnaryCallSettings(UnaryCallSettings.Builder<RequestT, ResponseT>) - Constructor for class com.google.api.gax.rpc.UnaryCallSettings

UnaryCallSettings.Builder<RequestT,ResponseT> - Class in com.google.api.gax.rpc

A base builder class for UnaryCallSettings.

UnauthenticatedException - Exception in com.google.api.gax.rpc

Exception thrown when the request does not have valid authentication credentials for the operation.

UnauthenticatedException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnauthenticatedException

UnauthenticatedException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnauthenticatedException

UnavailableException - Exception in com.google.api.gax.rpc

Exception thrown when the service is currently unavailable.

UnavailableException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnavailableException

UnavailableException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnavailableException

UnimplementedException - Exception in com.google.api.gax.rpc

Exception thrown when the operation is not implemented or not supported/enabled in this service.

UnimplementedException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnimplementedException

UnimplementedException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnimplementedException

UnknownException - Exception in com.google.api.gax.rpc

Exception thrown due to an unknown error.

UnknownException(Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnknownException

UnknownException(String, Throwable, StatusCode, boolean) - Constructor for exception com.google.api.gax.rpc.UnknownException

V

validateBatch(T) - Method in class com.google.api.gax.batching.AccumulatingBatchReceiver

validateBatch(BatchT) - Method in interface com.google.api.gax.batching.ThresholdBatchReceiver

Validate that the batch can be received by this ThresholdBatchReceiver.

valueOf(String) - Static method in enum com.google.api.gax.batching.FlowController.LimitExceededBehavior

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.api.gax.rpc.StatusCode.Code

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.api.gax.tracing.ApiTracerFactory.OperationType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.google.api.gax.batching.FlowController.LimitExceededBehavior

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.api.gax.rpc.StatusCode.Code

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.api.gax.tracing.ApiTracerFactory.OperationType

Returns an array containing the constants of this enum type, in the order they are declared.

W

watch(ResponseObserver<ResponseT>, Duration, Duration) - Method in class com.google.api.gax.rpc.Watchdog

Wraps the target observer with timing constraints.

Watchdog - Class in com.google.api.gax.rpc

Prevents the streams from hanging indefinitely.

Watchdog(ApiClock) - Constructor for class com.google.api.gax.rpc.Watchdog

WatchdogProvider - Interface in com.google.api.gax.rpc

WatchdogTimeoutException - Exception in com.google.api.gax.rpc

The marker exception thrown when a timeout is exceeded.

watched(ServerStreamingCallable<RequestT, ResponseT>, ServerStreamingCallSettings<RequestT, ResponseT>, ClientContext) - Static method in class com.google.api.gax.rpc.Callables

withCheckInterval(Duration) - Method in class com.google.api.gax.rpc.FixedWatchdogProvider

withCheckInterval(Duration) - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

withCheckInterval(Duration) - Method in interface com.google.api.gax.rpc.WatchdogProvider

withClock(ApiClock) - Method in class com.google.api.gax.rpc.FixedWatchdogProvider

withClock(ApiClock) - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

withClock(ApiClock) - Method in interface com.google.api.gax.rpc.WatchdogProvider

withCredentials(Credentials) - Method in interface com.google.api.gax.rpc.ApiCallContext

Returns a new ApiCallContext with the given credentials set.

withDefaultCallContext(ApiCallContext) - Method in class com.google.api.gax.rpc.BidiStreamingCallable

Returns a new BidiStreamingCallable with an ApiCallContext that is used as a default when none is supplied in individual calls.

withDefaultCallContext(ApiCallContext) - Method in class com.google.api.gax.rpc.ClientStreamingCallable

Returns a new ClientStreamingCallable with an ApiCallContext that is used as a default when none is supplied in individual calls.

withDefaultCallContext(ApiCallContext) - Method in class com.google.api.gax.rpc.OperationCallable

Returns a new OperationCallable with an ApiCallContext that is used as a default when none is supplied in individual calls.

withDefaultCallContext(ApiCallContext) - Method in class com.google.api.gax.rpc.ServerStreamingCallable

Returns a new ServerStreamingCallable with an ApiCallContext that is used as a default when none is supplied in individual calls.

withDefaultCallContext(ApiCallContext) - Method in class com.google.api.gax.rpc.UnaryCallable

Returns a new UnaryCallable with an ApiCallContext that is used as a default when none is supplied in individual calls.

withEndpoint(String) - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

withEndpoint(String) - Method in interface com.google.api.gax.rpc.TransportChannelProvider

Sets the endpoint to use when constructing a new TransportChannel.

withExecutor(ScheduledExecutorService) - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

withExecutor(ScheduledExecutorService) - Method in class com.google.api.gax.rpc.FixedWatchdogProvider

withExecutor(ScheduledExecutorService) - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider

withExecutor(ScheduledExecutorService) - Method in interface com.google.api.gax.rpc.TransportChannelProvider

Sets the executor to use when constructing a new TransportChannel..

withExecutor(ScheduledExecutorService) - Method in interface com.google.api.gax.rpc.WatchdogProvider

withExtraHeaders(Map<String, List<String>>) - Method in interface com.google.api.gax.rpc.ApiCallContext

Return a new ApiCallContext with the extraHeaders merged into the present instance.

withHeaders(Map<String, String>) - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

withHeaders(Map<String, String>) - Method in interface com.google.api.gax.rpc.TransportChannelProvider

Sets the headers to use when constructing a new TransportChannel..

withPoolSize(int) - Method in class com.google.api.gax.rpc.FixedTransportChannelProvider

withPoolSize(int) - Method in interface com.google.api.gax.rpc.TransportChannelProvider

Number of underlying transport channels to open.

withRequest(RequestT) - Method in class com.google.api.gax.rpc.PageContext

withStreamIdleTimeout(Duration) - Method in interface com.google.api.gax.rpc.ApiCallContext

Returns a new ApiCallContext with the given stream idle timeout set.

withStreamWaitTimeout(Duration) - Method in interface com.google.api.gax.rpc.ApiCallContext

Returns a new ApiCallContext with the given stream timeout set.

withTimeout(Duration) - Method in interface com.google.api.gax.rpc.ApiCallContext

Returns a new ApiCallContext with the given timeout set.

withTracer(ApiTracer) - Method in interface com.google.api.gax.rpc.ApiCallContext

Returns a new ApiCallContext with the given ApiTracer.

withTransportChannel(TransportChannel) - Method in interface com.google.api.gax.rpc.ApiCallContext

Returns a new ApiCallContext with the given channel set.

A B C D E F G H I L M N O P R S T U V W