GrpcCallContext (gax-grpc 1.16.0 API)

java.lang.Object
- com.google.api.gax.grpc.GrpcCallContext

All Implemented Interfaces:

com.google.api.gax.rpc.ApiCallContext
```
@BetaApi(value="Reference ApiCallContext instead - this class is likely to experience breaking changes")
 @InternalExtensionOnly
public final class GrpcCallContext
extends Object
implements com.google.api.gax.rpc.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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`int`	`hashCode()`
`com.google.api.gax.rpc.ApiCallContext`	`merge(com.google.api.gax.rpc.ApiCallContext inputCallContext)`
`GrpcCallContext`	`nullToSelf(com.google.api.gax.rpc.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`.
`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)` Returns a new instance with the channel set to the given channel.
`GrpcCallContext`	`withCredentials(com.google.auth.Credentials newCredentials)`
`GrpcCallContext`	`withRequestParamsDynamicHeaderOption(String requestParams)`
`GrpcCallContext`	`withTimeout(org.threeten.bp.Duration rpcTimeout)`
`GrpcCallContext`	`withTransportChannel(com.google.api.gax.rpc.TransportChannel inputChannel)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - 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(com.google.api.gax.rpc.ApiCallContext inputContext)
```
    Returns inputContext cast to GrpcCallContext, or an empty GrpcCallContext if inputContext is null.
    
    Specified by:
    
    nullToSelf in interface com.google.api.gax.rpc.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 com.google.api.gax.rpc.ApiCallContext
  - withTransportChannel
```
public GrpcCallContext withTransportChannel(com.google.api.gax.rpc.TransportChannel inputChannel)
```
    Specified by:
    
    withTransportChannel in interface com.google.api.gax.rpc.ApiCallContext
  - withTimeout
```
public GrpcCallContext withTimeout(org.threeten.bp.Duration rpcTimeout)
```
    Specified by:
    
    withTimeout in interface com.google.api.gax.rpc.ApiCallContext
  - merge
```
public com.google.api.gax.rpc.ApiCallContext merge(com.google.api.gax.rpc.ApiCallContext inputCallContext)
```
    Specified by:
    
    merge in interface com.google.api.gax.rpc.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.
  - withChannel
```
public GrpcCallContext withChannel(io.grpc.Channel newChannel)
```
    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)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class GrpcCallContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createDefault

of

nullToSelf

withCredentials

withTransportChannel

withTimeout

merge

getChannel

getCallOptions

withChannel

withCallOptions

withRequestParamsDynamicHeaderOption

equals

hashCode