This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Return the api call context option set for this context.

This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Return a new ApiCallContext with additional option merged into the present instance. Any existing value of the key is overwritten.

This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Return the extra headers set for this context.

The stream idle timeout set for this context.See Also:#withStreamIdleTimeout(Duration)

Return the stream wait timeout set for this context.See Also:#withStreamWaitTimeout(Duration)

Returns the configured per-RPC timeout.

This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

TheApiTracer that was previously set for this context.

TheApiTracer will be used to trace the current operation and to annotate various events like retries.

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

If inputContext is not null, returns it; if it is null, returns the present instance.

Returns a new ApiCallContext with the given credentials set.

Returns a new ApiCallContext with the given Endpoint Context.

This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Return a new ApiCallContext with the extraHeaders merged into the present instance.

This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a new ApiCallContext with the givenRetrySettings set.

This sets theRetrySettings to use for the RPC. These settings will work in combination with either the default retryable codes for the RPC, or the retryable codes supplied through#withRetryableCodes(Set). Calling#withRetrySettings(RetrySettings) on an RPC that does not includeCode#DEADLINE_EXCEEDED as one of its retryable codes (or without calling#withRetryableCodes(Set) with a set that includes at leastCode#DEADLINE_EXCEEDED) will effectively only set a single timeout that is equal toRetrySettings#getInitialRpcTimeout(). If this timeout is exceeded, the RPC will not be retried and will fail withCode#DEADLINE_EXCEEDED.

Example usage:

ApiCallContextcontext=GrpcCallContext.createDefault().withRetrySettings(RetrySettings.newBuilder().setInitialRetryDelay(Duration.ofMillis(10L)).setInitialRpcTimeout(Duration.ofMillis(100L)).setMaxAttempts(10).setMaxRetryDelay(Duration.ofSeconds(10L)).setMaxRpcTimeout(Duration.ofSeconds(30L)).setRetryDelayMultiplier(1.4).setRpcTimeoutMultiplier(1.5).setTotalTimeout(Duration.ofMinutes(10L)).build()).withRetryableCodes(Sets.newSet(StatusCode.Code.UNAVAILABLE,StatusCode.Code.DEADLINE_EXCEEDED));

Setting a logical call timeout for the context can be done similarly withRetrySettings.Builder#setLogicalTimeout(Duration timeout).

Example usage:

ApiCallContextcontext=GrpcCallContext.createDefault().withRetrySettings(RetrySettings.newBuilder().setInitialRetryDelay(Duration.ofMillis(10L)).setMaxRetryDelay(Duration.ofSeconds(10L)).setRetryDelayMultiplier(1.4).setMaxAttempts(10).setLogicalTimeout(Duration.ofSeconds(30L)).build());

This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a new ApiCallContext with the given retryable codes set.

This sets the retryable codes to use for the RPC. These settings will work in combination with either the defaultRetrySettings for the RPC, or theRetrySettings supplied through#withRetrySettings(RetrySettings).

Setting a non-empty set of retryable codes for an RPC that is not already retryable by default, will not have any effect and the RPC will NOT be retried. This option can only be used to change which codes are considered retryable for an RPC that already has at least one retryable code in its default settings.

Returns a new ApiCallContext with the given stream idle timeout set.

This timeout only applies to aServerStreamingCallables. It limits the maximum amount of timeout that can pass between a message being received byResponseObserver#onResponse(Object) and demand being signaled viaStreamController#request(int). Please note that this timeout is best effort and the maximum resolution configured inStubSettings#getStreamWatchdogCheckInterval(). This is useful to clean up streams that were partially read but never closed. When the timeout has been reached, the stream will be closed with a nonretryableWatchdogTimeoutException and a status ofStatusCode.Code#ABORTED.

A value ofDuration#ZERO, disables the streaming idle timeout and a null value will use the default in the callable.

Please note that this timeout is best effort and the maximum resolution is configured inStubSettings#getStreamWatchdogCheckInterval().

Returns a new ApiCallContext with the given stream timeout set.

This timeout only applies to aServerStreamingCallables. It limits the maximum amount of time that can pass between demand being signaled viaStreamController#request(int) and actual message delivery toResponseObserver#onResponse(Object). Or, in the case of automatic flow control, since the last message was delivered toResponseObserver#onResponse(Object). This is useful to detect server or connection stalls. When the timeout has been reached, the stream will be closed with a retryableWatchdogTimeoutException and a status ofStatusCode.Code#ABORTED.

A value ofDuration#ZERO, disables the streaming wait timeout and a null value will use the default in the callable.

Please note that this timeout is best effort and the maximum resolution is configured inStubSettings#getStreamWatchdogCheckInterval().

Returns a new ApiCallContext with the given timeout set.

This sets the maximum amount of time a single unary RPC attempt can take. If retries are enabled, then this can take much longer, as each RPC attempt will have the same constant timeout. Unlike a deadline, timeouts are relative durations that are measure from the beginning of each RPC attempt. Please note that this limits the duration of a server streaming RPC as well.

If a method has defaultcom.google.api.gax.retrying.RetrySettings, the max attempts and/or total timeout is still respected when scheduling each RPC attempt.

This feature is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a newApiCallContext with the givenApiTracer.

TheApiTracer will be used to trace the current operation and to annotate various events like retries.

Returns a new ApiCallContext with the given channel set.