Package com.google.api.gax.httpjson

Class HttpJsonCallContext

java.lang.Object

com.google.api.gax.httpjson.HttpJsonCallContext

All Implemented Interfaces:

RetryingContext, ApiCallContext

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

HttpJsonCallContext encapsulates context data used to make an http-json call.

HttpJsonCallContext is immutable in the sense that none of its methods modifies the HttpJsonCallContext itself or the underlying data. Methods of the form withX 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>

Method Summary

Modifier and Type	Method	Description
static HttpJsonCallContext	createDefault()	Returns an empty instance.
boolean	equals(Object o)
HttpJsonCallOptions	getCallOptions()
HttpJsonChannel	getChannel()
com.google.auth.Credentials	getCredentials()	Deprecated.
org.threeten.bp.Instant	getDeadline()	Deprecated.
Map<String,List<String>>	getExtraHeaders()
<T> T	getOption(ApiCallContext.Key<T> key)
Set<StatusCode.Code>	getRetryableCodes()
RetrySettings	getRetrySettings()
org.threeten.bp.Duration	getStreamIdleTimeout()	The stream idle timeout set for this context.
org.threeten.bp.Duration	getStreamWaitTimeout()	The stream wait timeout set for this context.
org.threeten.bp.Duration	getTimeout()
ApiTracer	getTracer()
int	hashCode()
HttpJsonCallContext	merge(ApiCallContext inputCallContext)
HttpJsonCallContext	nullToSelf(ApiCallContext inputContext)	Returns inputContext cast to HttpJsonCallContext, or an empty HttpJsonCallContext if inputContext is null.
static HttpJsonCallContext	of(HttpJsonChannel channel, HttpJsonCallOptions options)
HttpJsonCallContext	withCallOptions(HttpJsonCallOptions newCallOptions)
HttpJsonCallContext	withChannel(HttpJsonChannel newChannel)
HttpJsonCallContext	withCredentials(com.google.auth.Credentials newCredentials)
HttpJsonCallContext	withDeadline(org.threeten.bp.Instant newDeadline)	Deprecated.
ApiCallContext	withExtraHeaders(Map<String,List<String>> extraHeaders)
<T> ApiCallContext	withOption(ApiCallContext.Key<T> key, T value)
HttpJsonCallContext	withRetryableCodes(Set<StatusCode.Code> retryableCodes)
HttpJsonCallContext	withRetrySettings(RetrySettings retrySettings)
HttpJsonCallContext	withStreamIdleTimeout(org.threeten.bp.Duration streamIdleTimeout)
HttpJsonCallContext	withStreamWaitTimeout(org.threeten.bp.Duration streamWaitTimeout)
HttpJsonCallContext	withTimeout(org.threeten.bp.Duration timeout)
HttpJsonCallContext	withTracer(ApiTracer newTracer)
HttpJsonCallContext	withTransportChannel(TransportChannel inputChannel)

Methods inherited from class java.lang.Object

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

Method Detail

createDefault

public static HttpJsonCallContext createDefault()

Returns an empty instance.

of

public static HttpJsonCallContext of(HttpJsonChannel channel,
                                     HttpJsonCallOptions options)

nullToSelf

public HttpJsonCallContext nullToSelf(ApiCallContext inputContext)

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

Specified by:

nullToSelf in interface ApiCallContext

Parameters:

inputContext - the ApiCallContext to cast if it is not null

merge

public HttpJsonCallContext merge(ApiCallContext inputCallContext)

Specified by:

merge in interface ApiCallContext

withCredentials

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

Specified by:

withCredentials in interface ApiCallContext

withTransportChannel

public HttpJsonCallContext withTransportChannel(TransportChannel inputChannel)

Specified by:

withTransportChannel in interface ApiCallContext

withTimeout

public HttpJsonCallContext withTimeout(org.threeten.bp.Duration timeout)

Specified by:

withTimeout in interface ApiCallContext

getTimeout

@Nullable
public org.threeten.bp.Duration getTimeout()

Specified by:

getTimeout in interface ApiCallContext

withStreamWaitTimeout

public HttpJsonCallContext withStreamWaitTimeout(@Nullable
                                                 org.threeten.bp.Duration streamWaitTimeout)

Specified by:

withStreamWaitTimeout in interface ApiCallContext

getStreamWaitTimeout

@Nullable
public org.threeten.bp.Duration getStreamWaitTimeout()

The stream wait timeout set for this context.

Specified by:

getStreamWaitTimeout in interface ApiCallContext

See Also:

ApiCallContext.withStreamWaitTimeout(Duration)

withStreamIdleTimeout

public HttpJsonCallContext withStreamIdleTimeout(@Nullable
                                                 org.threeten.bp.Duration streamIdleTimeout)

Specified by:

withStreamIdleTimeout in interface ApiCallContext

getStreamIdleTimeout

@Nullable
public org.threeten.bp.Duration getStreamIdleTimeout()

The stream idle timeout set for this context.

Specified by:

getStreamIdleTimeout in interface ApiCallContext

See Also:

ApiCallContext.withStreamIdleTimeout(Duration)

withExtraHeaders

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

Specified by:

withExtraHeaders in interface ApiCallContext

getExtraHeaders

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

Specified by:

getExtraHeaders in interface ApiCallContext

withOption

public <T> ApiCallContext 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

getChannel

public HttpJsonChannel getChannel()

getCallOptions

public HttpJsonCallOptions getCallOptions()

getDeadline

@Deprecated
@Nullable
public org.threeten.bp.Instant getDeadline()

Deprecated.

getCredentials

@Deprecated
@Nullable
public com.google.auth.Credentials getCredentials()

Deprecated.

getRetrySettings

public RetrySettings getRetrySettings()

Specified by:

getRetrySettings in interface RetryingContext

withRetrySettings

public HttpJsonCallContext withRetrySettings(RetrySettings retrySettings)

Specified by:

withRetrySettings in interface ApiCallContext

getRetryableCodes

public Set<StatusCode.Code> getRetryableCodes()

Specified by:

getRetryableCodes in interface RetryingContext

withRetryableCodes

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

Specified by:

withRetryableCodes in interface ApiCallContext

withChannel

public HttpJsonCallContext withChannel(HttpJsonChannel newChannel)

withCallOptions

public HttpJsonCallContext withCallOptions(HttpJsonCallOptions newCallOptions)

withDeadline

@Deprecated
public HttpJsonCallContext withDeadline(org.threeten.bp.Instant newDeadline)

Deprecated.

getTracer

@Nonnull
public ApiTracer getTracer()

Specified by:

getTracer in interface ApiCallContext

Specified by:

getTracer in interface RetryingContext

withTracer

public HttpJsonCallContext withTracer(@Nonnull
                                      ApiTracer newTracer)

Specified by:

withTracer in interface ApiCallContext

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object