Modifier and Type	Class and Description
pack-priv static class	CallOptions.Builder
public static class	CallOptions.Key<T> Key for a key-value pair.

Modifier and Type	Field and Description
private final String	authority
private final String	compressorName
private final CallCredentials	credentials
private final Object[][]	customOptions
private final Deadline	deadline
public static final CallOptions	DEFAULT A blank `CallOptions` that all fields are not set.
private final Executor	executor
private final Integer	maxInboundMessageSize
private final Integer	maxOutboundMessageSize
private final List<ClientStreamTracer.Factory>	streamTracerFactories
private final Boolean	waitForReady Opposite to fail fast.

Access	Constructor and Description
private	CallOptions(CallOptions.Builder builder)

Method Summary

Modifier and Type	Method and Description
public String	getAuthority() Override the HTTP/2 authority the channel claims to be connecting to.
public String	getCompressor() Returns the compressor's name.
public CallCredentials	getCredentials() Returns the call credentials.
public Deadline	getDeadline() Returns the deadline or `null` if the deadline is not set.
public Executor	getExecutor() Returns the executor override to use for this specific call, or `null` if there is no override.
public Integer	getMaxInboundMessageSize() Gets the maximum allowed message size acceptable from the remote peer.
public Integer	getMaxOutboundMessageSize() Gets the maximum allowed message size acceptable to send the remote peer.
public <T> T	getOption(CallOptions.Key<T> Key identifying option key) Get the value for a custom option or its inherent default.
public List<ClientStreamTracer.Factory>	getStreamTracerFactories() Returns an immutable list of `ClientStreamTracerFactory`s.
pack-priv Boolean	getWaitForReady()
public boolean	isWaitForReady() Returns whether 'wait for ready' option is enabled for the call.
private static CallOptions.Builder	toBuilder(CallOptions other) Copy CallOptions.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public CallOptions	withAuthority(String authority) Override the HTTP/2 authority the channel claims to be connecting to.
public CallOptions	withCallCredentials(CallCredentials credentials) Returns a new `CallOptions` with the given call credentials.
public CallOptions	withCompression(String compressorName) Sets the compression to use for the call.
public CallOptions	withDeadline(Deadline the deadline or `null` for unsetting the deadline. deadline) Returns a new `CallOptions` with the given absolute deadline.
public CallOptions	withDeadlineAfter(long duration, TimeUnit unit) Returns a new `CallOptions` with a deadline that is after the given `duration` from now.
public CallOptions	withExecutor(Executor executor) Returns a new `CallOptions` with `executor` to be used instead of the default executor specified with `ManagedChannelBuilder#executor`.
public CallOptions	withMaxInboundMessageSize(int maxSize) Sets the maximum allowed message size acceptable from the remote peer.
public CallOptions	withMaxOutboundMessageSize(int maxSize) Sets the maximum allowed message size acceptable sent to the remote peer.
public <T> CallOptions	withOption(CallOptions.Key<T> The option key key, T The option value. value) Sets a custom option.
public CallOptions	withoutWaitForReady() Disables 'wait for ready' feature for the call.
public CallOptions	withStreamTracerFactory(ClientStreamTracer.Factory factory) Returns a new `CallOptions` with a `ClientStreamTracerFactory` in addition to the existing factories.
public CallOptions	withWaitForReady() Enables 'wait for ready' for the call.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

authority	back to summary
private final String authority Annotations @Nullable

compressorName	back to summary
private final String compressorName Annotations @Nullable

credentials	back to summary
private final CallCredentials credentials Annotations @Nullable

customOptions	back to summary
private final Object[][] customOptions

deadline	back to summary
private final Deadline deadline Annotations @Nullable

DEFAULT	back to summary
public static final CallOptions DEFAULT A blank `CallOptions` that all fields are not set.

executor	back to summary
private final Executor executor Annotations @Nullable

maxInboundMessageSize	back to summary
private final Integer maxInboundMessageSize Annotations @Nullable

maxOutboundMessageSize	back to summary
private final Integer maxOutboundMessageSize Annotations @Nullable

streamTracerFactories	back to summary
private final List<ClientStreamTracer.Factory> streamTracerFactories

waitForReady	back to summary
private final Boolean waitForReady Opposite to fail fast. Annotations @Nullable

Constructor Detail

CallOptions	back to summary
private CallOptions(CallOptions.Builder builder)

Method Detail

getAuthority	back to summary
public String getAuthority() Override the HTTP/2 authority the channel claims to be connecting to. This is not generally safe. Overriding allows advanced users to re-use a single Channel for multiple services, even if those services are hosted on different domain names. That assumes the server is virtually hosting multiple domains and is guaranteed to continue doing so. It is rare for a service provider to make such a guarantee. At this time, there is no security verification of the overridden value, such as making sure the authority matches the server's TLS certificate. Annotations @Nullable @ExperimentalApi:https://github.com/grpc/grpc-java/issues/1767

getAuthority

back to summary

public String getAuthority()

Override the HTTP/2 authority the channel claims to be connecting to. This is not generally safe. Overriding allows advanced users to re-use a single Channel for multiple services, even if those services are hosted on different domain names. That assumes the server is virtually hosting multiple domains and is guaranteed to continue doing so. It is rare for a service provider to make such a guarantee. At this time, there is no security verification of the overridden value, such as making sure the authority matches the server's TLS certificate.

Annotations

@Nullable
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/1767

getCompressor	back to summary
public String getCompressor() Returns the compressor's name. Annotations @Nullable

getCompressor

back to summary

public String getCompressor()

Returns the compressor's name.

Annotations

@Nullable

getCredentials	back to summary
public CallCredentials getCredentials() Returns the call credentials. Annotations @Nullable

getCredentials

back to summary

public CallCredentials getCredentials()

Returns the call credentials.

Annotations

@Nullable

getDeadline back to summary

getDeadline	back to summary
public Deadline getDeadline() Returns the deadline or `null` if the deadline is not set. Annotations @Nullable

public Deadline getDeadline()

Returns the deadline or null if the deadline is not set.

Annotations

@Nullable

getExecutor back to summary

getExecutor	back to summary
public Executor getExecutor() Returns the executor override to use for this specific call, or `null` if there is no override. The executor is only for servicing this one call, so is not safe to use after `ClientCall.Listener#onClose`. Annotations @Nullable

public Executor getExecutor()

Returns the executor override to use for this specific call, or null if there is no override. The executor is only for servicing this one call, so is not safe to use after ClientCall.Listener#onClose.

Annotations

@Nullable

getMaxInboundMessageSize	back to summary
public Integer getMaxInboundMessageSize() Gets the maximum allowed message size acceptable from the remote peer. Annotations @Nullable @ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

getMaxInboundMessageSize

back to summary

public Integer getMaxInboundMessageSize()

Gets the maximum allowed message size acceptable from the remote peer.

Annotations

@Nullable
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

getMaxOutboundMessageSize	back to summary
public Integer getMaxOutboundMessageSize() Gets the maximum allowed message size acceptable to send the remote peer. Annotations @Nullable @ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

getMaxOutboundMessageSize

back to summary

public Integer getMaxOutboundMessageSize()

Gets the maximum allowed message size acceptable to send the remote peer.

Annotations

@Nullable
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

getOption	back to summary
public <T> T getOption(CallOptions.Key<T> key) Get the value for a custom option or its inherent default. Parameters key:CallOptions.Key<T> Key identifying option Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/1869 @SuppressWarnings:unchecked

getOption

back to summary

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

Get the value for a custom option or its inherent default.

Parameters

key:CallOptions.Key<T>: Key identifying option

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/1869
@SuppressWarnings:unchecked

getStreamTracerFactories back to summary

getStreamTracerFactories	back to summary
public List<ClientStreamTracer.Factory> getStreamTracerFactories() Returns an immutable list of `ClientStreamTracerFactory`s. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/2861

public List<ClientStreamTracer.Factory> getStreamTracerFactories()

Returns an immutable list of ClientStreamTracerFactorys.

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2861

getWaitForReady	back to summary
pack-priv Boolean getWaitForReady()

isWaitForReady	back to summary
public boolean isWaitForReady() Returns whether 'wait for ready' option is enabled for the call. 'Fail fast' is the default option for gRPC calls and 'wait for ready' is the opposite to it.

toBuilder	back to summary
private static CallOptions.Builder toBuilder(CallOptions other) Copy CallOptions.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

withAuthority	back to summary
public CallOptions withAuthority(String authority) Override the HTTP/2 authority the channel claims to be connecting to. This is not generally safe. Overriding allows advanced users to re-use a single Channel for multiple services, even if those services are hosted on different domain names. That assumes the server is virtually hosting multiple domains and is guaranteed to continue doing so. It is rare for a service provider to make such a guarantee. At this time, there is no security verification of the overridden value, such as making sure the authority matches the server's TLS certificate. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/1767

withAuthority

back to summary

public CallOptions withAuthority(String authority)

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/1767

withCallCredentials	back to summary
public CallOptions withCallCredentials(CallCredentials credentials) Returns a new `CallOptions` with the given call credentials.

withCompression back to summary

withCompression	back to summary
public CallOptions withCompression(String compressorName) Sets the compression to use for the call. The compressor must be a valid name known in the `CompressorRegistry`. By default, the "gzip" compressor will be available. It is only safe to call this if the server supports the compression format chosen. There is no negotiation performed; if the server does not support the compression chosen, the call will fail.

public CallOptions withCompression(String compressorName)

Sets the compression to use for the call. The compressor must be a valid name known in the CompressorRegistry. By default, the "gzip" compressor will be available.

It is only safe to call this if the server supports the compression format chosen. There is no negotiation performed; if the server does not support the compression chosen, the call will fail.

withDeadline back to summary

withDeadline	back to summary
public CallOptions withDeadline(Deadline deadline) Returns a new `CallOptions` with the given absolute deadline. This is mostly used for propagating an existing deadline. `withDeadlineAfter` is the recommended way of setting a new deadline, Parameters deadline:Deadline the deadline or `null` for unsetting the deadline.

public CallOptions withDeadline(Deadline deadline)

Returns a new CallOptions with the given absolute deadline.

This is mostly used for propagating an existing deadline. withDeadlineAfter is the recommended way of setting a new deadline,

Parameters

deadline:Deadline: the deadline or null for unsetting the deadline.

withDeadlineAfter	back to summary
public CallOptions withDeadlineAfter(long duration, TimeUnit unit) Returns a new `CallOptions` with a deadline that is after the given `duration` from now.

withExecutor	back to summary
public CallOptions withExecutor(Executor executor) Returns a new `CallOptions` with `executor` to be used instead of the default executor specified with `ManagedChannelBuilder#executor`.

withMaxInboundMessageSize back to summary

withMaxInboundMessageSize	back to summary
public CallOptions withMaxInboundMessageSize(int maxSize) Sets the maximum allowed message size acceptable from the remote peer. If unset, this will default to the value set on the `ManagedChannelBuilder#maxInboundMessageSize(int)`. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

public CallOptions withMaxInboundMessageSize(int maxSize)

Sets the maximum allowed message size acceptable from the remote peer. If unset, this will default to the value set on the ManagedChannelBuilder#maxInboundMessageSize(int).

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

withMaxOutboundMessageSize	back to summary
public CallOptions withMaxOutboundMessageSize(int maxSize) Sets the maximum allowed message size acceptable sent to the remote peer. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

withMaxOutboundMessageSize

back to summary

public CallOptions withMaxOutboundMessageSize(int maxSize)

Sets the maximum allowed message size acceptable sent to the remote peer.

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2563

withOption	back to summary
public <T> CallOptions withOption(CallOptions.Key<T> key, T value) Sets a custom option. Any existing value for the key is overwritten. Parameters key:CallOptions.Key<T> The option key value:T The option value. Since 1.13.0

withOption

back to summary

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

Sets a custom option. Any existing value for the key is overwritten.

Parameters

key:CallOptions.Key<T>: The option key
value:T: The option value.

Since

1.13.0

withoutWaitForReady	back to summary
public CallOptions withoutWaitForReady() Disables 'wait for ready' feature for the call. This method should be rarely used because the default is without 'wait for ready'.

withStreamTracerFactory back to summary

withStreamTracerFactory	back to summary
public CallOptions withStreamTracerFactory(ClientStreamTracer.Factory factory) Returns a new `CallOptions` with a `ClientStreamTracerFactory` in addition to the existing factories. This method doesn't replace existing factories, or try to de-duplicate factories. Annotations @ExperimentalApi:https://github.com/grpc/grpc-java/issues/2861

public CallOptions withStreamTracerFactory(ClientStreamTracer.Factory factory)

Returns a new CallOptions with a ClientStreamTracerFactory in addition to the existing factories.

This method doesn't replace existing factories, or try to de-duplicate factories.

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2861

withWaitForReady	back to summary
public CallOptions withWaitForReady() Enables 'wait for ready' for the call. Wait-for-ready queues the RPC until a connection is available. This may dramatically increase the latency of the RPC, but avoids failing "unnecessarily." The default queues the RPC until an attempt to connect has completed, but fails RPCs without sending them if unable to connect.

io.grpc back to summary

pack-priv Class CallOptions.Builder

Class Inheritance

extends Object

java.lang.Object
io.grpc.CallOptions.Builder

Field Summary

Modifier and Type	Field and Description
pack-priv String	authority
pack-priv String	compressorName
pack-priv CallCredentials	credentials
pack-priv Object[][]	customOptions
pack-priv Deadline	deadline
pack-priv Executor	executor
pack-priv Integer	maxInboundMessageSize
pack-priv Integer	maxOutboundMessageSize
pack-priv List<ClientStreamTracer.Factory>	streamTracerFactories
pack-priv Boolean	waitForReady

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()

Method Summary

Modifier and Type	Method and Description
private CallOptions	build()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

authority	back to summary
pack-priv String authority

compressorName	back to summary
pack-priv String compressorName

credentials	back to summary
pack-priv CallCredentials credentials

customOptions	back to summary
pack-priv Object[][] customOptions

deadline	back to summary
pack-priv Deadline deadline

executor	back to summary
pack-priv Executor executor

maxInboundMessageSize	back to summary
pack-priv Integer maxInboundMessageSize

maxOutboundMessageSize	back to summary
pack-priv Integer maxOutboundMessageSize

streamTracerFactories	back to summary
pack-priv List<ClientStreamTracer.Factory> streamTracerFactories

waitForReady	back to summary
pack-priv Boolean waitForReady

Constructor Detail

Builder	back to summary
pack-priv Builder()

Method Detail

build	back to summary
private CallOptions build()

io.grpc back to summary

public final Class CallOptions.Key<T>

Class Inheritance

extends Object

java.lang.Object
io.grpc.CallOptions.Key

Key for a key-value pair. Uses reference equality.

Field Summary

Modifier and Type	Field and Description
private final String	debugString
private final T	defaultValue

Constructor Summary

Access	Constructor and Description
private	Key(String debugString, T defaultValue)

Method Summary

Modifier and Type	Method and Description
public static < Key type T> CallOptions.Key<T>	Returns: Key object create(String a debug string that describes this key. debugString) Factory method for creating instances of `Key`.
public static < Key type T> CallOptions.Key<T>	Returns: Key object createWithDefault(String a debug string that describes this key. debugString, T default value to return when value for key not set defaultValue) Factory method for creating instances of `Key`.
public T	getDefault() Returns the user supplied default value for this key.
public static < Key type T> CallOptions.Key<T>	Returns: Key object of(String a string used to describe this key, used for debugging. debugString, T default value to return when value for key not set defaultValue) Deprecated Use `create` or `createWithDefault` instead. Factory method for creating instances of `Key`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

debugString	back to summary
private final String debugString

defaultValue	back to summary
private final T defaultValue

Constructor Detail

Key	back to summary
private Key(String debugString, T defaultValue)

Method Detail

create back to summary

public static <T> CallOptions.Key<T> create(String debugString)

Factory method for creating instances of Key. The default value of the key is null.

Parameters

<T>: Key type
debugString:String: a debug string that describes this key.

Returns:CallOptions.Key<T>

Key object

Since

1.13.0

createWithDefault back to summary

public static <T> CallOptions.Key<T> createWithDefault(String debugString, T defaultValue)

Factory method for creating instances of Key.

Parameters

<T>: Key type
debugString:String: a debug string that describes this key.
defaultValue:T: default value to return when value for key not set

Returns:CallOptions.Key<T>

Key object

Since

1.13.0

getDefault	back to summary
public T getDefault() Returns the user supplied default value for this key.

of back to summary

public static <T> CallOptions.Key<T> of(String debugString, T defaultValue)

Deprecated

Use create or createWithDefault instead. This method will be removed.

Factory method for creating instances of Key.

Parameters

<T>: Key type
debugString:String: a string used to describe this key, used for debugging.
defaultValue:T: default value to return when value for key not set

Returns:CallOptions.Key<T>

Key object

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/1869
@Deprecated

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public final Class CallOptions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class CallOptions.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class CallOptions.Key<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail