public class GrpcResponseMetadata implements ResponseMetadataHandlerGrpcResponseMetadata provides a mechanism to access the headers and trailers returned by a gRPC client method.
NOTE: the GrpcResponseMetadata class is not thread-safe and should NOT be re-used for multiple calls. A new instance of GrpcResponseMetadata should be constructed for each call that requires metadata to be accessed.
Example usage:
GrpcResponseMetadata grpcResponseMetadata = new GrpcResponseMetadata();
Foo foo = client.getFooCallable().call(getFooRequest, grpcResponseMetadata.createContextWithHandlers());
Metadata headers = grpcResponseMetadata.getMetadata();
Metadata trailers = grpcResponseMetadata.getTrailingMetadata();
Implements
ResponseMetadataHandlerConstructors
GrpcResponseMetadata()
public GrpcResponseMetadata()Methods
addHandlers(ApiCallContext apiCallContext)
public GrpcCallContext addHandlers(ApiCallContext apiCallContext)Constructs a new call context from an existing ApiCallContext, and sets the CallOptions to add handlers to retrieve the headers and trailers, and make them available via the getMetadata and getTrailingMetadata methods.
| Parameter | |
|---|---|
| Name | Description |
apiCallContext |
ApiCallContext |
| Returns | |
|---|---|
| Type | Description |
GrpcCallContext |
|
createContextWithHandlers()
public GrpcCallContext createContextWithHandlers()Constructs a new call context and sets the CallOptions to add handlers to retrieve the headers and trailers, and make them available via the getMetadata and getTrailingMetadata methods.
| Returns | |
|---|---|
| Type | Description |
GrpcCallContext |
|
getMetadata()
public Metadata getMetadata()Returns the headers from the gRPC method as Metadata. If the call has not completed, will return null.
| Returns | |
|---|---|
| Type | Description |
io.grpc.Metadata |
|
getTrailingMetadata()
public Metadata getTrailingMetadata()Returns the trailers from the gRPC method as Metadata. If the call has not completed, will return null.
| Returns | |
|---|---|
| Type | Description |
io.grpc.Metadata |
|
onHeaders(Metadata metadata)
public void onHeaders(Metadata metadata)Handle the headers returned by an RPC.
| Parameter | |
|---|---|
| Name | Description |
metadata |
io.grpc.Metadata |
onTrailers(Metadata metadata)
public void onTrailers(Metadata metadata)Handle the trailers returned by an RPC.
| Parameter | |
|---|---|
| Name | Description |
metadata |
io.grpc.Metadata |