Package com.google.api.gax.grpc

Class GrpcCallContext

java.lang.Object

com.google.api.gax.grpc.GrpcCallContext

All Implemented Interfaces:

RetryingContext, ApiCallContext

@BetaApi("Reference ApiCallContext instead - this class is likely to experience breaking changes")
public final class GrpcCallContext
extends Object
implements ApiCallContext

GrpcCallContext encapsulates context data used to make a grpc call.

GrpcCallContext is immutable in the sense that none of its methods modifies the GrpcCallContext itself or the underlying data. Methods of the form withX, such as withTransportChannel(com.google.api.gax.rpc.TransportChannel), return copies of the object, but with one field changed. The immutability and thread safety of the arguments solely depends on the arguments themselves.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.api.gax.rpc.ApiCallContext

ApiCallContext.Key<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final io.grpc.CallOptions.Key<ApiTracer>	TRACER_KEY

Method Summary

Modifier and Type	Method	Description
static GrpcCallContext	createDefault()	Returns an empty instance with a null channel and default CallOptions.
boolean	equals(Object o)
io.grpc.CallOptions	getCallOptions()	The CallOptions set on this context.
io.grpc.Channel	getChannel()	The Channel set on this context.
Integer	getChannelAffinity()	The channel affinity for this context.
Map<String,List<String>>	getExtraHeaders()	The extra header for this context.
<T> T	getOption(ApiCallContext.Key<T> key)
Set<StatusCode.Code>	getRetryableCodes()
RetrySettings	getRetrySettings()
org.threeten.bp.Duration	getStreamIdleTimeout()	This method is obsolete.
Duration	getStreamIdleTimeoutDuration()	The stream idle timeout set for this context.
org.threeten.bp.Duration	getStreamWaitTimeout()	This method is obsolete.
Duration	getStreamWaitTimeoutDuration()	The stream wait timeout set for this context.
org.threeten.bp.Duration	getTimeout()	This method is obsolete.
Duration	getTimeoutDuration()
ApiTracer	getTracer()
int	hashCode()
ApiCallContext	merge(ApiCallContext inputCallContext)
GrpcCallContext	nullToSelf(ApiCallContext inputContext)	Returns inputContext cast to GrpcCallContext, or an empty GrpcCallContext if inputContext is null.
static GrpcCallContext	of(io.grpc.Channel channel, io.grpc.CallOptions callOptions)	Returns an instance with the given channel and CallOptions.
void	validateUniverseDomain()	Validate the Universe Domain to ensure that the user configured Universe Domain and the Credentials' Universe Domain match.
GrpcCallContext	withCallOptions(io.grpc.CallOptions newCallOptions)	Returns a new instance with the call options set to the given call options.
GrpcCallContext	withChannel(io.grpc.Channel newChannel)	This method is obsolete.
GrpcCallContext	withChannelAffinity(Integer affinity)
GrpcCallContext	withCredentials(com.google.auth.Credentials newCredentials)
GrpcCallContext	withEndpointContext(EndpointContext endpointContext)
GrpcCallContext	withExtraHeaders(Map<String,List<String>> extraHeaders)
<T> GrpcCallContext	withOption(ApiCallContext.Key<T> key, T value)
GrpcCallContext	withRequestParamsDynamicHeaderOption(String requestParams)
GrpcCallContext	withRetryableCodes(Set<StatusCode.Code> retryableCodes)
GrpcCallContext	withRetrySettings(RetrySettings retrySettings)
GrpcCallContext	withStreamIdleTimeout(org.threeten.bp.Duration streamIdleTimeout)	This method is obsolete.
GrpcCallContext	withStreamIdleTimeoutDuration(Duration streamIdleTimeout)
GrpcCallContext	withStreamWaitTimeout(org.threeten.bp.Duration streamWaitTimeout)	This method is obsolete.
GrpcCallContext	withStreamWaitTimeoutDuration(Duration streamWaitTimeout)
GrpcCallContext	withTimeout(org.threeten.bp.Duration timeout)	This method is obsolete.
GrpcCallContext	withTimeoutDuration(Duration timeout)
GrpcCallContext	withTracer(ApiTracer tracer)
GrpcCallContext	withTransportChannel(TransportChannel inputChannel)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

TRACER_KEY

public static final io.grpc.CallOptions.Key<ApiTracer> TRACER_KEY

Method Details

createDefault

public static GrpcCallContext createDefault()

Returns an empty instance with a null channel and default CallOptions.

of

public static GrpcCallContext of(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Returns an instance with the given channel and CallOptions.

nullToSelf

public GrpcCallContext nullToSelf(ApiCallContext inputContext)

Returns inputContext cast to GrpcCallContext, or an empty GrpcCallContext if inputContext is null.

Specified by:

nullToSelf in interface ApiCallContext

Parameters:

inputContext - the ApiCallContext to cast if it is not null

withCredentials

public GrpcCallContext withCredentials(com.google.auth.Credentials newCredentials)

Specified by:

withCredentials in interface ApiCallContext

withTransportChannel

public GrpcCallContext withTransportChannel(TransportChannel inputChannel)

Specified by:

withTransportChannel in interface ApiCallContext

withEndpointContext

public GrpcCallContext withEndpointContext(EndpointContext endpointContext)

Specified by:

withEndpointContext in interface ApiCallContext

withTimeout

@ObsoleteApi("Use withTimeoutDuration(java.time.Duration) instead")
public GrpcCallContext withTimeout(@Nullable
 org.threeten.bp.Duration timeout)

This method is obsolete. Use withTimeoutDuration(java.time.Duration) instead.

Specified by:

withTimeout in interface ApiCallContext

withTimeoutDuration

public GrpcCallContext withTimeoutDuration(@Nullable
 Duration timeout)

Specified by:

withTimeoutDuration in interface ApiCallContext

getTimeout

@Nullable
@ObsoleteApi("Use getTimeoutDuration() instead")
public org.threeten.bp.Duration getTimeout()

This method is obsolete. Use getTimeoutDuration() instead.

Specified by:

getTimeout in interface ApiCallContext

getTimeoutDuration

@Nullable
public Duration getTimeoutDuration()

Specified by:

getTimeoutDuration in interface ApiCallContext

withStreamWaitTimeout

@ObsoleteApi("Use withStreamWaitTimeoutDuration(java.time.Duration) instead")
public GrpcCallContext withStreamWaitTimeout(@Nullable
 org.threeten.bp.Duration streamWaitTimeout)

This method is obsolete. Use withStreamWaitTimeoutDuration(java.time.Duration) instead.

Specified by:

withStreamWaitTimeout in interface ApiCallContext

withStreamWaitTimeoutDuration

public GrpcCallContext withStreamWaitTimeoutDuration(@Nullable
 Duration streamWaitTimeout)

Specified by:

withStreamWaitTimeoutDuration in interface ApiCallContext

withStreamIdleTimeout

@ObsoleteApi("Use withStreamIdleTimeoutDuration(java.time.Duration) instead")
public GrpcCallContext withStreamIdleTimeout(@Nullable
 org.threeten.bp.Duration streamIdleTimeout)

This method is obsolete. Use withStreamIdleTimeoutDuration(java.time.Duration) instead.

Specified by:

withStreamIdleTimeout in interface ApiCallContext

withStreamIdleTimeoutDuration

public GrpcCallContext withStreamIdleTimeoutDuration(@Nullable
 Duration streamIdleTimeout)

Specified by:

withStreamIdleTimeoutDuration in interface ApiCallContext

withChannelAffinity

@BetaApi("The surface for channel affinity is not stable yet and may change in the future.")
public GrpcCallContext withChannelAffinity(@Nullable
 Integer affinity)

withExtraHeaders

@BetaApi("The surface for extra headers is not stable yet and may change in the future.")
public GrpcCallContext withExtraHeaders(Map<String,List<String>> extraHeaders)

Specified by:

withExtraHeaders in interface ApiCallContext

getRetrySettings

public RetrySettings getRetrySettings()

Specified by:

getRetrySettings in interface RetryingContext

withRetrySettings

public GrpcCallContext withRetrySettings(RetrySettings retrySettings)

Specified by:

withRetrySettings in interface ApiCallContext

getRetryableCodes

public Set<StatusCode.Code> getRetryableCodes()

Specified by:

getRetryableCodes in interface RetryingContext

withRetryableCodes

public GrpcCallContext withRetryableCodes(Set<StatusCode.Code> retryableCodes)

Specified by:

withRetryableCodes in interface ApiCallContext

merge

public ApiCallContext merge(ApiCallContext inputCallContext)

Specified by:

merge in interface ApiCallContext

getChannel

public io.grpc.Channel getChannel()

The Channel set on this context.

getCallOptions

public io.grpc.CallOptions getCallOptions()

The CallOptions set on this context.

getStreamWaitTimeout

@Nullable
@ObsoleteApi("Use getStreamWaitTimeoutDuration() instead")
public org.threeten.bp.Duration getStreamWaitTimeout()

This method is obsolete. Use getStreamWaitTimeoutDuration() instead.

Specified by:

getStreamWaitTimeout in interface ApiCallContext

getStreamWaitTimeoutDuration

@Nullable
public Duration getStreamWaitTimeoutDuration()

The stream wait timeout set for this context.

Specified by:

getStreamWaitTimeoutDuration in interface ApiCallContext

See Also:

• ApiCallContext.withStreamWaitTimeoutDuration(java.time.Duration)

getStreamIdleTimeout

@Nullable
@ObsoleteApi("Use getStreamIdleTimeoutDuration() instead")
public org.threeten.bp.Duration getStreamIdleTimeout()

This method is obsolete. Use getStreamIdleTimeoutDuration() instead.

Specified by:

getStreamIdleTimeout in interface ApiCallContext

getStreamIdleTimeoutDuration

@Nullable
public Duration getStreamIdleTimeoutDuration()

The stream idle timeout set for this context.

Specified by:

getStreamIdleTimeoutDuration in interface ApiCallContext

See Also:

• ApiCallContext.withStreamIdleTimeoutDuration(java.time.Duration)

getChannelAffinity

@Nullable
public Integer getChannelAffinity()

The channel affinity for this context.

getExtraHeaders

@BetaApi("The surface for extra headers is not stable yet and may change in the future.")
public Map<String,List<String>> getExtraHeaders()

The extra header for this context.

Specified by:

getExtraHeaders in interface ApiCallContext

withChannel

@ObsoleteApi("Use withTransportChannel() instead")
public GrpcCallContext withChannel(io.grpc.Channel newChannel)

This method is obsolete. Use #withTransportChannel() instead. Returns a new instance with the channel set to the given channel.

withCallOptions

public GrpcCallContext withCallOptions(io.grpc.CallOptions newCallOptions)

Returns a new instance with the call options set to the given call options.

withRequestParamsDynamicHeaderOption

public GrpcCallContext withRequestParamsDynamicHeaderOption(String requestParams)

getTracer

@Nonnull
public ApiTracer getTracer()

Specified by:

getTracer in interface ApiCallContext

Specified by:

getTracer in interface RetryingContext

withTracer

public GrpcCallContext withTracer(@Nonnull
 ApiTracer tracer)

Specified by:

withTracer in interface ApiCallContext

withOption

public <T> GrpcCallContext withOption(ApiCallContext.Key<T> key,
 T value)

Specified by:

withOption in interface ApiCallContext

getOption

public <T> T getOption(ApiCallContext.Key<T> key)

Specified by:

getOption in interface ApiCallContext

validateUniverseDomain

@InternalApi
public void validateUniverseDomain()

Validate the Universe Domain to ensure that the user configured Universe Domain and the Credentials' Universe Domain match. An exception will be raised if there are any issues when trying to validate (i.e. unable to access the universe domain).

Throws:

UnauthenticatedException - Thrown if the universe domain that the user configured does not match the Credential's universe domain.

UnavailableException - If client library is unable to retrieve the universe domain from the Credentials and the RPC is configured to retry Unavailable exceptions, the client library will attempt to retry with the RPC's defined retry bounds. If the retry bounds have been exceeded and the library is still unable to retrieve the universe domain, the exception will be thrown back to the user.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object