Package io.servicetalk.grpc.api

Class DefaultGrpcClientMetadata

java.lang.Object

io.servicetalk.grpc.api.DefaultGrpcClientMetadata

All Implemented Interfaces:

GrpcClientMetadata, GrpcMetadata

Direct Known Subclasses:

Health.CheckMetadata, Health.WatchMetadata

public class DefaultGrpcClientMetadata
extends Object
implements GrpcClientMetadata

Default implementation for DefaultGrpcClientMetadata.

Field Summary

Fields

Modifier and Type	Field	Description
static final GrpcClientMetadata	INSTANCE	Deprecated. Use DefaultGrpcClientMetadata() to create a new instance instead.

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultGrpcClientMetadata()	Creates a new instance with default characteristics and empty request/response contexts.
	DefaultGrpcClientMetadata(BufferEncoder requestEncoding)	Creates a new instance.
	DefaultGrpcClientMetadata(BufferEncoder requestEncoding, Duration timeout)	Creates a new instance.
protected	DefaultGrpcClientMetadata(DefaultGrpcClientMetadata rhs)	Create a new instance, by copying an existing instance.
	DefaultGrpcClientMetadata(GrpcExecutionStrategy strategy, BufferEncoder requestEncoding)	Create a new instance.
	DefaultGrpcClientMetadata(GrpcExecutionStrategy strategy, BufferEncoder requestEncoding, Duration timeout)	Create a new instance.
protected	DefaultGrpcClientMetadata(String path)	Deprecated. Use DefaultGrpcClientMetadata().
protected	DefaultGrpcClientMetadata(String path, ContentCodec requestEncoding)	Deprecated. Use DefaultGrpcClientMetadata(BufferEncoder)
protected	DefaultGrpcClientMetadata(String path, ContentCodec requestEncoding, Duration timeout)	Deprecated. Use DefaultGrpcClientMetadata(BufferEncoder, Duration).
protected	DefaultGrpcClientMetadata(String path, GrpcClientMetadata rhs)	Deprecated. Use DefaultGrpcClientMetadata(DefaultGrpcClientMetadata).
protected	DefaultGrpcClientMetadata(String path, GrpcExecutionStrategy strategy)	Deprecated. Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder).
protected	DefaultGrpcClientMetadata(String path, GrpcExecutionStrategy strategy, ContentCodec requestEncoding)	Deprecated. Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder).
protected	DefaultGrpcClientMetadata(String path, GrpcExecutionStrategy strategy, ContentCodec requestEncoding, Duration timeout)	Deprecated. Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder, Duration).
protected	DefaultGrpcClientMetadata(String path, GrpcExecutionStrategy strategy, Duration timeout)	Deprecated. Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder, Duration).
protected	DefaultGrpcClientMetadata(String path, Duration timeout)	Deprecated. Use DefaultGrpcClientMetadata(BufferEncoder, Duration).
protected	DefaultGrpcClientMetadata(String path, Supplier<ContextMap> requestContext, Supplier<ContextMap> responseContext, GrpcExecutionStrategy strategy, ContentCodec requestEncoding, Duration timeout)	Deprecated.
	DefaultGrpcClientMetadata(Duration timeout)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
String	path()	Deprecated.
BufferEncoder	requestCompressor()	Get the BufferEncoder to use to compress the request associated with this object.
ContextMap	requestContext()	A request context associated with this GrpcMetadata that translates into HttpMetaData.context().
ContentCodec	requestEncoding()	Deprecated.
ContextMap	responseContext()	A response context associated with this GrpcMetadata that translates into HttpMetaData.context().
final GrpcExecutionStrategy	strategy()	GrpcExecutionStrategy to use for the associated gRPC method.
Duration	timeout()	Returns timeout duration after which the response is no longer wanted.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.grpc.api.GrpcMetadata

path, requestContext, responseContext

Field Details

INSTANCE

@Deprecated
public static final GrpcClientMetadata INSTANCE

Deprecated.

Use DefaultGrpcClientMetadata() to create a new instance instead. GrpcClientMetadata contains modifiable GrpcMetadata.requestContext() and GrpcMetadata.responseContext() now. Using this constant there will be no access to the actual context and both mentioned methods will throw UnsupportedOperationException.

Constant with a default characteristics.

Constructor Details

DefaultGrpcClientMetadata

public DefaultGrpcClientMetadata()

Creates a new instance with default characteristics and empty request/response contexts.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path)

Deprecated.

Use DefaultGrpcClientMetadata().

Creates a new instance using provided parameters and defaults for DefaultGrpcClientMetadata(String, GrpcExecutionStrategy, ContentCodec, Duration).

Parameters:

path - for the associated gRPC method.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 ContentCodec requestEncoding)

Deprecated.

Use DefaultGrpcClientMetadata(BufferEncoder)

Creates a new instance using provided parameters and defaults for DefaultGrpcClientMetadata(String, GrpcExecutionStrategy, ContentCodec, Duration).

Parameters:

path - for the associated gRPC method.

requestEncoding - ContentCodec to use for the associated gRPC method.

DefaultGrpcClientMetadata

public DefaultGrpcClientMetadata(BufferEncoder requestEncoding)

Creates a new instance.

Parameters:

requestEncoding - Used to compress the request.

DefaultGrpcClientMetadata

public DefaultGrpcClientMetadata(Duration timeout)

Create a new instance.

Parameters:

timeout - A timeout after which the response is no longer wanted.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 ContentCodec requestEncoding,
 Duration timeout)

Deprecated.

Use DefaultGrpcClientMetadata(BufferEncoder, Duration).

Creates a new instance using provided parameters and defaults for DefaultGrpcClientMetadata(String, GrpcExecutionStrategy, ContentCodec, Duration).

Parameters:

path - for the associated gRPC method.

requestEncoding - ContentCodec to use for the associated gRPC method.

timeout - A timeout after which the response is no longer wanted.

DefaultGrpcClientMetadata

public DefaultGrpcClientMetadata(BufferEncoder requestEncoding,
 Duration timeout)

Creates a new instance.

Parameters:

requestEncoding - Used to compress the request.

timeout - A timeout after which the response is no longer wanted.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 @Nullable
 GrpcExecutionStrategy strategy)

Deprecated.

Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder).

Creates a new instance using provided parameters and defaults for DefaultGrpcClientMetadata(String, GrpcExecutionStrategy, ContentCodec, Duration).

Parameters:

path - for the associated gRPC method.

strategy - GrpcExecutionStrategy to use for the associated gRPC method.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 @Nullable
 GrpcExecutionStrategy strategy,
 ContentCodec requestEncoding)

Deprecated.

Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder).

Creates a new instance using provided parameters and defaults for DefaultGrpcClientMetadata(String, GrpcExecutionStrategy, ContentCodec, Duration).

Parameters:

path - for the associated gRPC method.

strategy - GrpcExecutionStrategy to use for the associated gRPC method.

requestEncoding - ContentCodec to use for the associated gRPC method.

DefaultGrpcClientMetadata

public DefaultGrpcClientMetadata(@Nullable
 GrpcExecutionStrategy strategy,
 BufferEncoder requestEncoding)

Create a new instance.

Parameters:

strategy - GrpcExecutionStrategy to use for the associated gRPC call.

requestEncoding - Used to compress the request.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 @Nullable
 Duration timeout)

Deprecated.

Use DefaultGrpcClientMetadata(BufferEncoder, Duration).

Creates a new instance using provided parameters and defaults for DefaultGrpcClientMetadata(String, GrpcExecutionStrategy, ContentCodec, Duration).

Parameters:

path - for the associated gRPC method.

timeout - A timeout after which the response is no longer wanted.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 @Nullable
 GrpcExecutionStrategy strategy,
 @Nullable
 Duration timeout)

Deprecated.

Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder, Duration).

Creates a new instance using provided parameters and defaults for DefaultGrpcClientMetadata(String, GrpcExecutionStrategy, ContentCodec, Duration).

Parameters:

path - for the associated gRPC method.

strategy - GrpcExecutionStrategy to use for the associated gRPC method.

timeout - A timeout after which the response is no longer wanted.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 @Nullable
 GrpcExecutionStrategy strategy,
 ContentCodec requestEncoding,
 @Nullable
 Duration timeout)

Deprecated.

Use DefaultGrpcClientMetadata(GrpcExecutionStrategy, BufferEncoder, Duration).

Creates a new instance which uses the provided path, execution strategy, content codec, and timeout.

Parameters:

path - for the associated gRPC method.

strategy - GrpcExecutionStrategy to use for the associated gRPC method.

requestEncoding - ContentCodec to use for the associated gRPC method.

timeout - A timeout after which the response is no longer wanted.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 Supplier<ContextMap> requestContext,
 Supplier<ContextMap> responseContext,
 @Nullable
 GrpcExecutionStrategy strategy,
 ContentCodec requestEncoding,
 @Nullable
 Duration timeout)

Deprecated.

DefaultGrpcClientMetadata

@Deprecated
protected DefaultGrpcClientMetadata(String path,
 GrpcClientMetadata rhs)

Deprecated.

Use DefaultGrpcClientMetadata(DefaultGrpcClientMetadata).

Create a new instance.

Parameters:

path - for the associated gRPC method.

rhs - Copy everything except the path from this object.

DefaultGrpcClientMetadata

protected DefaultGrpcClientMetadata(DefaultGrpcClientMetadata rhs)

Create a new instance, by copying an existing instance.

Parameters:

rhs - Right hand side to copy from.

DefaultGrpcClientMetadata

public DefaultGrpcClientMetadata(@Nullable
 GrpcExecutionStrategy strategy,
 @Nullable
 BufferEncoder requestEncoding,
 @Nullable
 Duration timeout)

Create a new instance.

Parameters:

strategy - GrpcExecutionStrategy to use for the associated gRPC call.

requestEncoding - Used to compress the request.

timeout - A timeout after which the response is no longer wanted.

Method Details

strategy

public final GrpcExecutionStrategy strategy()

Description copied from interface: GrpcClientMetadata

GrpcExecutionStrategy to use for the associated gRPC method.

Specified by:

strategy in interface GrpcClientMetadata

Returns:

GrpcExecutionStrategy to use for the associated gRPC method.

requestEncoding

@Deprecated
public ContentCodec requestEncoding()

Deprecated.

Description copied from interface: GrpcClientMetadata

ContentCodec to use for the associated gRPC method.

Specified by:

requestEncoding in interface GrpcClientMetadata

Returns:

ContentCodec to use for the associated gRPC method.

requestCompressor

@Nullable
public BufferEncoder requestCompressor()

Description copied from interface: GrpcClientMetadata

Get the BufferEncoder to use to compress the request associated with this object.

Specified by:

requestCompressor in interface GrpcClientMetadata

Returns:

the BufferEncoder to use to compress the request associated with this object.

timeout

@Nullable
public Duration timeout()

Description copied from interface: GrpcClientMetadata

Returns timeout duration after which the response is no longer wanted.

Specified by:

timeout in interface GrpcClientMetadata

Returns:

Duration of associated timeout or null for no timeout

See Also:

• gRPC Deadlines

path

@Deprecated
public String path()

Deprecated.

Description copied from interface: GrpcMetadata

Returns the path for the associated gRPC method.

Specified by:

path in interface GrpcMetadata

Returns:

The path for the associated gRPC method.

requestContext

public ContextMap requestContext()

Description copied from interface: GrpcMetadata

A request context associated with this GrpcMetadata that translates into HttpMetaData.context().

Context can be used to associate a state with a request without serializing its state on the wire or transmit a state between HTTP and gRPC layers.

Specified by:

requestContext in interface GrpcMetadata

Returns:

a request context associated with this GrpcMetadata that translates into HttpMetaData.context().

responseContext

public ContextMap responseContext()

Description copied from interface: GrpcMetadata

A response context associated with this GrpcMetadata that translates into HttpMetaData.context().

Context can be used to associate a state with a response without serializing its state on the wire or transmit a state between HTTP and gRPC layers.

Specified by:

responseContext in interface GrpcMetadata

Returns:

a response context associated with this GrpcMetadata that translates into HttpMetaData.context().