- 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
-
- 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
-
- 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
-
- 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(ElementT) - Method in interface com.google.api.gax.batching.Batcher
-
Queues the passed in element to be sent at some point in the future.
- add(ElementT) - Method in class com.google.api.gax.batching.BatcherImpl
-
Queues the passed in element to be sent at some point in the future.
- add(ElementT) - Method in interface com.google.api.gax.batching.BatchingRequestBuilder
-
Adds element object into client specific batch request.
- add(E) - Method in class com.google.api.gax.batching.ThresholdBatcher
-
Adds an element to the batcher.
- add(String, String, PathTemplate) - Method in class com.google.api.gax.rpc.RequestParamsBuilder
-
Add an entry to paramsBuilder by match-and-extract field values from requests based on
pre-configured path templates.
- 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.
- ApiCallContext.Key<T> - Class in com.google.api.gax.rpc
-
Key for api call context options key-value pair.
- ApiCallContextOptions - Class in com.google.api.gax.rpc.internal
-
ApiCallContextOptions encapsulates additional call options to pass in a
ApiCallContext
- 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
-
- 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
-
- 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.BaseApiTracer
-
- 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.BaseApiTracer
-
- 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.BaseApiTracer
-
- 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.BaseApiTracer
-
- 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
-
- attemptStarted(Object, int) - Method in interface com.google.api.gax.tracing.ApiTracer
-
Adds an annotation that an attempt is about to start with additional information from the
request.
- attemptStarted(int) - Method in class com.google.api.gax.tracing.BaseApiTracer
-
- attemptStarted(Object, int) - Method in class com.google.api.gax.tracing.BaseApiTracer
-
- attemptStarted(int) - Method in class com.google.api.gax.tracing.OpencensusTracer
-
Adds an annotation that an attempt is about to start.
- attemptStarted(Object, int) - Method in class com.google.api.gax.tracing.OpencensusTracer
-
Adds an annotation that an attempt is about to start with additional information from the
request.
- 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.BaseApiTracer
-
- 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
-
- awaitTermination(long, TimeUnit) - Method in class com.google.api.gax.rpc.Watchdog
-
- 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
-
- 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
-
- call(RequestT, ResponseObserver<ResponseT>, ApiCallContext) - Method in class com.google.api.gax.rpc.ServerStreamingCallable
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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 interface com.google.api.gax.batching.Batcher
-
Closes this Batcher by preventing new elements from being added, and then flushing the existing
elements.
- close() - Method in class com.google.api.gax.batching.BatcherImpl
-
Closes this Batcher by preventing new elements from being added, and then flushing the existing
elements.
- 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 class com.google.api.gax.rpc.Watchdog
-
- close() - Method in interface com.google.api.gax.tracing.ApiTracer.Scope
-
- closeAsync() - Method in interface com.google.api.gax.batching.Batcher
-
Closes this Batcher by preventing new elements from being added, and then sending outstanding
elements.
- closeAsync() - Method in class com.google.api.gax.batching.BatcherImpl
-
- 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.rpc.mtls - package com.google.api.gax.rpc.mtls
-
- com.google.api.gax.tracing - package com.google.api.gax.tracing
-
- compareTo(FlowControlEventStats.FlowControlEvent) - Method in class com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent
-
- 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.BaseApiTracer
-
- connectionSelected(String) - Method in class com.google.api.gax.tracing.OpencensusTracer
-
Annotates the operation with selected connection id from the ChannelPool.
- ContextAwareMetadataJson - Class in com.google.api.gax.rpc.mtls
-
Data class representing context_aware_metadata.json file.
- ContextAwareMetadataJson() - Constructor for class com.google.api.gax.rpc.mtls.ContextAwareMetadataJson
-
- 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(ElementT) - Method in interface com.google.api.gax.batching.BatchingDescriptor
-
Returns the size of the passed element object in bytes.
- 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(ElementT, SettableApiFuture<ElementResultT>) - Static method in class com.google.api.gax.batching.BatchEntry
-
Returns a new BatchEntry
- 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(String) - Static method in class com.google.api.gax.rpc.ApiCallContext.Key
-
- 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() - Static method in class com.google.api.gax.rpc.RequestParamsBuilder
-
- create(UnaryCallable<InnerRequestT, InnerResponseT>, ApiFunction<OuterRequestT, InnerRequestT>, ApiFunction<InnerResponseT, OuterResponseT>) - Static method in class com.google.api.gax.rpc.TranslatingUnaryCallable
-
- create(ApiClock, Duration, ScheduledExecutorService) - Static method in class com.google.api.gax.rpc.Watchdog
-
returns a Watchdog which is scheduled at the provided interval.
- 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
-
- createFirstAttempt(RetryingContext) - Method in class com.google.api.gax.retrying.ExponentialRetryAlgorithm
-
- createFirstAttempt() - Method in class com.google.api.gax.retrying.RetryAlgorithm
-
- createFirstAttempt(RetryingContext) - Method in class com.google.api.gax.retrying.RetryAlgorithm
-
- createFirstAttempt() - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithm
-
- createFirstAttempt(RetryingContext) - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithmWithContext
-
- 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(RetryingContext, 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
-
- createNextAttempt(RetryingContext, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.ExponentialRetryAlgorithm
-
- createNextAttempt(Throwable, ResponseT, TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.ResultRetryAlgorithm
-
- createNextAttempt(RetryingContext, Throwable, ResponseT, TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.ResultRetryAlgorithmWithContext
-
- createNextAttempt(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.RetryAlgorithm
-
- createNextAttempt(RetryingContext, Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.RetryAlgorithm
-
- createNextAttempt(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.StreamingRetryAlgorithm
-
- createNextAttempt(RetryingContext, Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.StreamingRetryAlgorithm
-
- createNextAttempt(TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithm
-
- createNextAttempt(RetryingContext, TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithmWithContext
-
- 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.
- 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.
- getAuthenticationType() - Method in class com.google.api.gax.rpc.internal.QuotaProjectIdHidingCredentials
-
- getBackgroundExecutorProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder
-
Gets the ExecutorProvider that was previously set on this Builder.
- getBackgroundExecutorProvider() - Method in class com.google.api.gax.rpc.ClientSettings
-
- getBackgroundExecutorProvider() - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
Gets the ExecutorProvider that was previously set on this Builder.
- getBackgroundExecutorProvider() - Method in class com.google.api.gax.rpc.StubSettings
-
- 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.batching.BatchingCallSettings
-
- 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.batching.BatchingCallSettings.Builder
-
- getBatchingSettings() - Method in class com.google.api.gax.batching.BatchingCallSettings
-
Returns batching settings which contains multiple batch threshold levels.
- 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.
- getCommands() - Method in class com.google.api.gax.rpc.mtls.ContextAwareMetadataJson
-
Returns the cert provider command.
- 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
-
- getCurrentElementCountLimit() - Method in class com.google.api.gax.batching.FlowController
-
- getCurrentMaxBatchBytes() - Method in exception com.google.api.gax.batching.FlowController.MaxOutstandingRequestBytesReachedException
-
- getCurrentMaxBatchElementCount() - Method in exception com.google.api.gax.batching.FlowController.MaxOutstandingElementCountReachedException
-
- getCurrentRequestBytesLimit() - Method in class com.google.api.gax.batching.FlowController
-
- 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
-
- getDefaultOptions() - Static method in class com.google.api.gax.rpc.internal.ApiCallContextOptions
-
- 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.
- getElement() - Method in class com.google.api.gax.batching.BatchEntry
-
- 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
-
- getenv(String) - Method in interface com.google.api.gax.rpc.internal.EnvironmentProvider
-
Returns the environment variable value.
- 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.
- getException() - Method in class com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent
-
- 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
-
Gets the executor to use for running scheduled API call logic (such as retries and long-running
operations).
- getExecutorProvider() - Method in class com.google.api.gax.rpc.ClientSettings.Builder
-
- getExecutorProvider() - Method in class com.google.api.gax.rpc.ClientSettings
-
- getExecutorProvider() - Method in class com.google.api.gax.rpc.StubSettings.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.
- getFlowControlEventStats() - Method in class com.google.api.gax.batching.FlowController
-
- getFlowController() - Method in class com.google.api.gax.batching.BatcherImpl
-
- 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
-
- 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
-
- getInitialOutstandingElementCount() - Method in class com.google.api.gax.batching.DynamicFlowControlSettings
-
Number of outstanding elements that
FlowController allows when it's initiated.
- getInitialOutstandingRequestBytes() - Method in class com.google.api.gax.batching.DynamicFlowControlSettings
-
Number of outstanding bytes that
FlowController allows when it's initiated.
- 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.BaseApiTracer
-
- getInstance() - Static method in class com.google.api.gax.tracing.BaseApiTracerFactory
-
- 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
-
- getKeyStore() - Method in class com.google.api.gax.rpc.mtls.MtlsProvider
-
The mutual TLS key store created with the default client certificate on device.
- getLastFlowControlEvent() - Method in class com.google.api.gax.batching.FlowControlEventStats
-
- 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.DynamicFlowControlSettings
-
- 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.
- getMaxElementCountLimit() - Method in class com.google.api.gax.batching.FlowController
-
- getMaxOutstandingElementCount() - Method in class com.google.api.gax.batching.DynamicFlowControlSettings
-
Maximum number of outstanding elements
FlowController allows before enforcing flow
control.
- 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.DynamicFlowControlSettings
-
Maximum number of outstanding bytes
FlowController allows 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.
- getMaxRequestBytesLimit() - Method in class com.google.api.gax.batching.FlowController
-
- 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
-
- 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.
- getMinElementCountLimit() - Method in class com.google.api.gax.batching.FlowController
-
- getMinOutstandingElementCount() - Method in class com.google.api.gax.batching.DynamicFlowControlSettings
-
Minimum number of outstanding elements
FlowController allows before enforcing flow
control.
- getMinOutstandingRequestBytes() - Method in class com.google.api.gax.batching.DynamicFlowControlSettings
-
Minimum number of outstanding bytes
FlowController allows before enforcing flow
control.
- getMinRequestBytesLimit() - Method in class com.google.api.gax.batching.FlowController
-
- getMtlsEndpoint() - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
- getMtlsEndpoint() - Method in class com.google.api.gax.rpc.StubSettings
-
- getMtlsEndpointUsagePolicy() - Method in class com.google.api.gax.rpc.mtls.MtlsProvider
-
Returns the current mutual TLS endpoint usage policy.
- 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.
- getOption(ApiCallContext.Key<T>) - Method in interface com.google.api.gax.rpc.ApiCallContext
-
Return the api call context option set for this context.
- getOption(ApiCallContext.Key<T>) - Method in class com.google.api.gax.rpc.internal.ApiCallContextOptions
-
Get an option.
- 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
-
- 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.
- getQuotaProjectId() - Method in class com.google.api.gax.rpc.ClientContext
-
- getQuotaProjectId() - Method in class com.google.api.gax.rpc.ClientSettings.Builder
-
Gets the QuotaProjectId that was previously set on this Builder.
- getQuotaProjectId() - Method in class com.google.api.gax.rpc.ClientSettings
-
- getQuotaProjectId() - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
Gets the QuotaProjectId that was previously set on this Builder.
- getQuotaProjectId() - Method in class com.google.api.gax.rpc.StubSettings
-
- getQuotaProjectIdToken() - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
-
- 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
-
- getRequestMetadata(URI) - Method in class com.google.api.gax.rpc.internal.QuotaProjectIdHidingCredentials
-
- getRequestMetadata() - Method in class com.google.api.gax.rpc.internal.QuotaProjectIdHidingCredentials
-
- 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
-
- getResultFuture() - Method in class com.google.api.gax.batching.BatchEntry
-
- 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
-
- getRetryableCodes() - Method in interface com.google.api.gax.retrying.RetryingContext
-
Returns the retryable codes to use with this context, or null if the default
retryable codes should be used.
- getRetryableCodes() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder
-
- getRetryableCodes() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings
-
- 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 interface com.google.api.gax.retrying.RetryingContext
-
- getRetrySettings() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder
-
- getRetrySettings() - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings
-
- getRetrySettings() - Method in class com.google.api.gax.rpc.UnaryCallSettings.Builder
-
Returns an immutable
RetrySettings currently set in this 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
-
- 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
- getThrottledTime(TimeUnit) - Method in class com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent
-
- 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.
- getTimestampMs() - Method in class com.google.api.gax.batching.FlowControlEventStats.FlowControlEvent
-
- 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
-
- 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
-
- getUseJwtAccessWithScope() - Method in class com.google.api.gax.core.GoogleCredentialsProvider.Builder
-
The UseJwtAccessWithScope value previously provided.
- getUseJwtAccessWithScope() - Method in class com.google.api.gax.core.GoogleCredentialsProvider
-
- 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
-
- immediateOperationFuture(OperationSnapshot) - Static method in class com.google.api.gax.longrunning.OperationFutures
-
Creates an already-completed OperationFuture, useful for testing.
- increaseThresholds(long, long) - Method in class com.google.api.gax.batching.FlowController
-
Increase flow control limits to allow extra elementSteps elements and byteSteps request bytes
before enforcing flow control.
- 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.BaseApiTracer
-
- 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
-
A watchdog provider which instantiates a new provider on every request.
- 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
-
- 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
-
- isShutdown() - Method in class com.google.api.gax.rpc.Watchdog
-
- 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
-
- isTerminated() - Method in class com.google.api.gax.rpc.Watchdog
-
- 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
- ScheduledRetryingExecutor<ResponseT> - Class in com.google.api.gax.retrying
-
- 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.
- sendOutstanding() - Method in interface com.google.api.gax.batching.Batcher
-
Sends accumulated elements asynchronously for batching.
- sendOutstanding() - Method in class com.google.api.gax.batching.BatcherImpl
-
Sends accumulated elements asynchronously for batching.
- 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
-
- serverStreamingCall(RequestT, ApiStreamObserver<ResponseT>) - Method in class com.google.api.gax.rpc.ServerStreamingCallable
-
- 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
-
- 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.
- setBackgroundExecutorProvider(ExecutorProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder
-
Sets the ExecutorProvider to use for getting the executor to use for running scheduled API
call logic (such as retries and long-running operations).
- setBackgroundExecutorProvider(ExecutorProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
Sets the executor to use for running scheduled API call logic (such as retries and
long-running operations).
- setBackgroundResources(List<BackgroundResource>) - Method in class com.google.api.gax.rpc.ClientContext.Builder
-
- setBatchingSettings(BatchingSettings) - Method in class com.google.api.gax.batching.BatchingCallSettings.Builder
-
Sets the batching settings with various thresholds.
- 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
-
Sets the executor to use for running scheduled API call logic (such as retries and
long-running operations).
- setExecutorProvider(ExecutorProvider) - Method in class com.google.api.gax.rpc.ClientSettings.Builder
-
- setExecutorProvider(ExecutorProvider) - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
- 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
-
- 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.
- setInitialOutstandingElementCount(Long) - Method in class com.google.api.gax.batching.DynamicFlowControlSettings.Builder
-
- setInitialOutstandingRequestBytes(Long) - Method in class com.google.api.gax.batching.DynamicFlowControlSettings.Builder
-
- 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
-
- 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.DynamicFlowControlSettings.Builder
-
- setLimitExceededBehavior(FlowController.LimitExceededBehavior) - Method in class com.google.api.gax.batching.FlowControlSettings.Builder
-
- setLogicalTimeout(Duration) - Method in class com.google.api.gax.retrying.RetrySettings.Builder
-
Configures the timeout settings with the given timeout such that the logical call will take
no longer than the given timeout and each RPC attempt will use only the time remaining in the
logical call as a timeout.
- 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.DynamicFlowControlSettings.Builder
-
- setMaxOutstandingElementCount(Long) - Method in class com.google.api.gax.batching.FlowControlSettings.Builder
-
- setMaxOutstandingRequestBytes(Long) - Method in class com.google.api.gax.batching.DynamicFlowControlSettings.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
-
- setMinOutstandingElementCount(Long) - Method in class com.google.api.gax.batching.DynamicFlowControlSettings.Builder
-
- setMinOutstandingRequestBytes(Long) - Method in class com.google.api.gax.batching.DynamicFlowControlSettings.Builder
-
- setMtlsEndpoint(String) - Method in class com.google.api.gax.rpc.StubSettings.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.
- setQuotaProjectId(String) - Method in class com.google.api.gax.rpc.ClientContext.Builder
-
- setQuotaProjectId(String) - Method in class com.google.api.gax.rpc.ClientSettings.Builder
-
- setQuotaProjectId(String) - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
- setQuotaProjectIdToken(String) - Method in class com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
-
Sets the project ID used for quota and billing purposes.
- 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
-
- setRetryableCodes(StatusCode.Code...) - Method in class com.google.api.gax.batching.BatchingCallSettings.Builder
-
Sets the rpc failure code, for which retries should be performed.
- setRetryableCodes(Set<StatusCode.Code>) - Method in class com.google.api.gax.batching.BatchingCallSettings.Builder
-
Sets the rpc failure code, for which retries should be performed.
- 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
-
- setRetryableCodes(Set<StatusCode.Code>) - Method in class com.google.api.gax.rpc.ServerStreamingCallSettings.Builder
-
- 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.batching.BatchingCallSettings.Builder
-
- 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
-
- 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
-
- setSwitchToMtlsEndpointAllowed(boolean) - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
- 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
-
- setTracerFactory(ApiTracerFactory) - Method in class com.google.api.gax.rpc.StubSettings.Builder
-
- 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
-
- setUseJwtAccessWithScope(boolean) - Method in class com.google.api.gax.core.GoogleCredentialsProvider.Builder
-
Whether self signed JWT with scopes should be used for service account credentials.
- 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 class com.google.api.gax.rpc.FixedWatchdogProvider
-
- shouldAutoClose() - Method in class com.google.api.gax.rpc.InstantiatingWatchdogProvider
-
- shouldAutoClose() - Method in interface com.google.api.gax.rpc.TransportChannelProvider
-
Indicates whether the TransportChannel should be closed by the containing client class.
- shouldAutoClose() - Method in interface com.google.api.gax.rpc.WatchdogProvider
-
- shouldRetry(Throwable, OperationSnapshot) - Method in class com.google.api.gax.longrunning.OperationResponsePollAlgorithm
-
- shouldRetry(TimedAttemptSettings) - Method in class com.google.api.gax.longrunning.OperationTimedPollAlgorithm
-
- shouldRetry(Throwable, ResponseT) - Method in class com.google.api.gax.retrying.BasicResultRetryAlgorithm
-
Returns true if an exception was thrown (previousThrowable != null), false otherwise.
- shouldRetry(RetryingContext, Throwable, ResponseT) - Method in class com.google.api.gax.retrying.BasicResultRetryAlgorithm
-
Returns true if an exception was thrown (previousThrowable != 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(RetryingContext, 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
-
- shouldRetry(RetryingContext, Throwable, ResponseT) - Method in interface com.google.api.gax.retrying.ResultRetryAlgorithmWithContext
-
Returns true if another attempt should be made, or false otherwise.
- shouldRetry(Throwable, ResponseT, TimedAttemptSettings) - Method in class com.google.api.gax.retrying.RetryAlgorithm
-
- shouldRetry(RetryingContext, 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(RetryingContext, 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
-
- shouldRetry(RetryingContext, TimedAttemptSettings) - Method in interface com.google.api.gax.retrying.TimedRetryAlgorithmWithContext
-
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
-
- shutdown() - Method in class com.google.api.gax.rpc.Watchdog
-
- 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
-
- shutdownNow() - Method in class com.google.api.gax.rpc.Watchdog
-
- SimpleStreamResumptionStrategy<RequestT,ResponseT> - Class in com.google.api.gax.retrying
-
- SimpleStreamResumptionStrategy() - Constructor for class com.google.api.gax.retrying.SimpleStreamResumptionStrategy
-
- sleep(Duration) - Method in class com.google.api.gax.retrying.DirectRetryingExecutor
-
- 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, List<BatchEntry<ElementT, ElementResultT>>) - Method in interface com.google.api.gax.batching.BatchingDescriptor
-
Unpacks the batch response error into individual element errors.
- 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, List<BatchEntry<ElementT, ElementResultT>>) - Method in interface com.google.api.gax.batching.BatchingDescriptor
-
Unpacks the batch response into individual elements results.
- 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
-
- 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
-
- 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
-
- StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext<ResponseT>, TimedRetryAlgorithmWithContext) - 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
-
- 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.