Uses of Class
io.grpc.Metadata

Packages that use Metadata

Package	Description
io.grpc	The gRPC core public API.
io.grpc.protobuf	API for gRPC over Protocol Buffers, including tools for serializing and de-serializing protobuf messages.
io.grpc.stub	API for the Stub layer.
io.grpc.testing	API that is useful for testing gRPC.
io.grpc.util	Utilities with advanced features in the core layer that user can optionally use.
io.grpc.xds.orca

Uses of Metadata in io.grpc

Methods in io.grpc that return Metadata

Modifier and Type	Method	Description
abstract Metadata	LoadBalancer.PickSubchannelArgs.getHeaders()	Headers of the call.
Metadata	StatusException.getTrailers()	Returns the received trailers.
Metadata	StatusRuntimeException.getTrailers()	Returns the received trailers.
static Metadata	Status.trailersFromThrowable(Throwable t)	Extract an error trailers from the causal chain of a Throwable.

Methods in io.grpc with parameters of type Metadata

Modifier and Type	Method	Description
abstract void	CallCredentials.MetadataApplier.apply(Metadata headers)	Called when headers are successfully generated.
StatusException	Status.asException(Metadata trailers)	Same as Status.asException() but includes the provided trailers in the returned exception.
StatusRuntimeException	Status.asRuntimeException(Metadata trailers)	Same as Status.asRuntimeException() but includes the provided trailers in the returned exception.
protected abstract void	ClientInterceptors.CheckedForwardingClientCall.checkedStart(ClientCall.Listener<RespT> responseListener, Metadata headers)	Subclasses implement the start logic here that would normally belong to start().
abstract void	ServerCall.close(Status status, Metadata trailers)	Close the call with the provided status.
<ReqT,RespT> Executor	ServerCallExecutorSupplier.getExecutor(ServerCall<ReqT,RespT> call, Metadata metadata)	Returns an executor to handle the server call.
void	ClientStreamTracer.inboundHeaders(Metadata headers)	Headers has been received from the server.
void	ClientStreamTracer.inboundTrailers(Metadata trailers)	Trailing metadata has been received from the server.
static <ReqT,RespT> ServerCall.Listener<ReqT>	Contexts.interceptCall(Context context, ServerCall<ReqT,RespT> call, Metadata headers, ServerCallHandler<ReqT,RespT> next)	Make the provided Context Context.current() for the creation of a listener to a received call and for all events received by that listener.
<ReqT,RespT> ServerCall.Listener<ReqT>	ServerInterceptor.interceptCall(ServerCall<ReqT,RespT> call, Metadata headers, ServerCallHandler<ReqT,RespT> next)	Intercept ServerCall dispatch by the next ServerCallHandler.
void	Metadata.merge(Metadata other)	Perform a simple merge of two sets of metadata.
void	Metadata.merge(Metadata other, Set<Metadata.Key<?>> keys)	Merge values from the given set of keys into this set of metadata.
ClientStreamTracer	ClientStreamTracer.Factory.newClientStreamTracer(ClientStreamTracer.StreamInfo info, Metadata headers)	Creates a ClientStreamTracer for a new client stream.
abstract ServerStreamTracer	ServerStreamTracer.Factory.newServerStreamTracer(String fullMethodName, Metadata headers)	Creates a ServerStreamTracer for a new server stream.
void	ClientCall.Listener.onClose(Status status, Metadata trailers)	The ClientCall has been closed.
void	ClientCall.Listener.onHeaders(Metadata headers)	The response headers have been received.
abstract void	ServerCall.sendHeaders(Metadata headers)	Send response header metadata prior to sending a response message.
abstract void	ClientCall.start(ClientCall.Listener<RespT> responseListener, Metadata headers)	Start a call, using responseListener for processing response messages.
void	ClientInterceptors.CheckedForwardingClientCall.start(ClientCall.Listener<RespT> responseListener, Metadata headers)
void	ForwardingClientCall.start(ClientCall.Listener<RespT> responseListener, Metadata headers)
ServerCall.Listener<RequestT>	ServerCallHandler.startCall(ServerCall<RequestT,ResponseT> call, Metadata headers)	Starts asynchronous processing of an incoming call.
void	ClientStreamTracer.streamCreated(Attributes transportAttrs, Metadata headers)	The stream is being created on a ready transport.

Constructors in io.grpc with parameters of type Metadata

Constructor	Description
StatusException(Status status, Metadata trailers)	Constructs an exception with both a status and trailers.
StatusRuntimeException(Status status, Metadata trailers)	Constructs the exception with both a status and trailers.

Uses of Metadata in io.grpc.protobuf

Methods in io.grpc.protobuf with parameters of type Metadata

Modifier and Type	Method	Description
static com.google.rpc.Status	StatusProto.fromStatusAndTrailers(Status status, Metadata trailers)	Extracts the google.rpc.Status from trailers, and makes sure they match the gRPC status.
static StatusException	StatusProto.toStatusException(com.google.rpc.Status statusProto, Metadata metadata)	Convert a Status instance to a StatusException with additional metadata.
static StatusException	StatusProto.toStatusException(com.google.rpc.Status statusProto, Metadata metadata, Throwable cause)	Convert a Status instance to a StatusException with additional metadata and the root exception thrown.
static StatusRuntimeException	StatusProto.toStatusRuntimeException(com.google.rpc.Status statusProto, Metadata metadata)	Convert a Status instance to a StatusRuntimeException with additional metadata.

Uses of Metadata in io.grpc.stub

Methods in io.grpc.stub with parameters of type Metadata

Modifier and Type	Method	Description
static ClientInterceptor	MetadataUtils.newAttachHeadersInterceptor(Metadata extraHeaders)	Returns a client interceptor that attaches a set of headers to requests.
static ServerInterceptor	MetadataUtils.newAttachMetadataServerInterceptor(Metadata extras)	Returns a ServerInterceptor that adds the specified Metadata to every response stream, one way or another.

Method parameters in io.grpc.stub with type arguments of type Metadata

Modifier and Type	Method	Description
static ClientInterceptor	MetadataUtils.newCaptureMetadataInterceptor(AtomicReference<Metadata> headersCapture, AtomicReference<Metadata> trailersCapture)	Captures the last received metadata on a channel.

Uses of Metadata in io.grpc.testing

Method parameters in io.grpc.testing with type arguments of type Metadata

Modifier and Type	Method	Description
static ServerInterceptor	TestUtils.recordRequestHeadersInterceptor(AtomicReference<Metadata> headersCapture)	Capture the request headers from a client.

Uses of Metadata in io.grpc.util

Methods in io.grpc.util with parameters of type Metadata

Modifier and Type	Method	Description
void	ForwardingClientStreamTracer.inboundHeaders(Metadata headers)
void	ForwardingClientStreamTracer.inboundTrailers(Metadata trailers)
<ReqT,RespT> ServerCall.Listener<ReqT>	TransmitStatusRuntimeExceptionInterceptor.interceptCall(ServerCall<ReqT,RespT> call, Metadata headers, ServerCallHandler<ReqT,RespT> next)
void	ForwardingClientStreamTracer.streamCreated(Attributes transportAttrs, Metadata headers)

Uses of Metadata in io.grpc.xds.orca

Methods in io.grpc.xds.orca with parameters of type Metadata

Modifier and Type	Method	Description
<ReqT,RespT> ServerCall.Listener<ReqT>	OrcaMetricReportingServerInterceptor.interceptCall(ServerCall<ReqT,RespT> call, Metadata headers, ServerCallHandler<ReqT,RespT> next)