com.google.api.gax.rpc

Interface ApiCallContext

@BetaApi
public interface ApiCallContext

Context for an API call.

Implementations need to be immutable because default instances are stored in callable objects.

This is transport specific and each transport has an implementation with its own options.

Method Summary

Modifier and Type	Method and Description
ApiCallContext	merge(ApiCallContext inputCallContext) For any values in inputCallContext that are not null, override the corresponding values in the present instance.
ApiCallContext	nullToSelf(ApiCallContext inputContext) If inputContext is not null, returns it; if it is null, returns the present instance.
ApiCallContext	withCredentials(com.google.auth.Credentials credentials) Returns a new ApiCallContext with the given credentials set.
ApiCallContext	withTimeout(org.threeten.bp.Duration rpcTimeout) Returns a new ApiCallContext with the given timeout set.
ApiCallContext	withTransportChannel(TransportChannel channel) Returns a new ApiCallContext with the given channel set.

Method Detail

withCredentials

ApiCallContext withCredentials(com.google.auth.Credentials credentials)

Returns a new ApiCallContext with the given credentials set.

withTransportChannel

ApiCallContext withTransportChannel(TransportChannel channel)

Returns a new ApiCallContext with the given channel set.

withTimeout

ApiCallContext withTimeout(org.threeten.bp.Duration rpcTimeout)

Returns a new ApiCallContext with the given timeout set.

This timeout only applies to a single RPC call; if timeouts are configured, the overall time taken will be much higher.

nullToSelf

ApiCallContext nullToSelf(ApiCallContext inputContext)

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

merge

ApiCallContext merge(ApiCallContext inputCallContext)

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