Uses of Annotation Interface
io.grpc.ExperimentalApi

Packages that use ExperimentalApi

Package	Description
io.grpc	The gRPC core public API.
io.grpc.inprocess	The in-process transport which is for when a server is in the same process as the client.
io.grpc.netty	The main transport implementation based on Netty, for both the client and the server.
io.grpc.protobuf	API for gRPC over Protocol Buffers, including tools for serializing and de-serializing protobuf messages.
io.grpc.protobuf.lite	API for gRPC over Protocol Buffers with proto message classes generated by the Lite Runtime library.
io.grpc.stub	API for the Stub layer.
io.grpc.util	Utilities with advanced features in the core layer that user can optionally use.

Uses of ExperimentalApi in io.grpc

Classes in io.grpc with annotations of type ExperimentalApi

Modifier and Type	Class	Description
final class	Attributes	An immutable type-safe container of attributes.
class	BinaryLog	A binary log that can be installed on a channel or server.
class	ChannelLogger	A Channel-specific logger provided by GRPC library to LoadBalancer implementations.
class	ClientStreamTracer	StreamTracer for the client-side.
static final class	ClientStreamTracer.StreamInfo	Information about a stream.
class	ClientTransportFilter	Listens on the client transport life-cycle events.
interface	Codec	Encloses classes related to the compression and decompression of messages.
final class	CompositeCallCredentials	Uses multiple CallCredentials as if they were one.
interface	Compressor	Represents a message compressor.
final class	CompressorRegistry	Encloses classes related to the compression and decompression of messages.
enum	ConnectivityState	The connectivity states.
final class	ConnectivityStateInfo	A tuple of a ConnectivityState and its associated Status.
interface	Decompressor	Represents a message decompressor.
final class	DecompressorRegistry	Encloses classes related to the compression and decompression of messages.
final class	EquivalentAddressGroup	A group of SocketAddresses that are considered equivalent when channel makes connections.
static @interface	EquivalentAddressGroup.Attr	Annotation for EquivalentAddressGroup's attributes.
static @interface	Grpc.TransportAttr	Annotation for transport attributes.
class	LoadBalancer	A pluggable component that receives resolved addresses from NameResolver and provides the channel a usable subchannel when asked.
static final class	LoadBalancer.CreateSubchannelArgs	Arguments for creating a LoadBalancer.Subchannel.
static final class	LoadBalancer.CreateSubchannelArgs.Builder
static final class	LoadBalancer.CreateSubchannelArgs.Key<T>	Key for a key-value pair.
static class	LoadBalancer.Factory	Factory to create LoadBalancer instance.
static class	LoadBalancer.Helper	Provides essentials for LoadBalancer implementations.
static final class	LoadBalancer.PickResult	A balancing decision made by SubchannelPicker for an RPC.
static class	LoadBalancer.PickSubchannelArgs	Provides arguments for a LoadBalancer.SubchannelPicker.pickSubchannel(LoadBalancer.PickSubchannelArgs).
static final class	LoadBalancer.ResolvedAddresses	Represents a combination of the resolved server address, associated attributes and a load balancing policy config.
static final class	LoadBalancer.ResolvedAddresses.Builder	Builder for LoadBalancer.ResolvedAddresses.
static class	LoadBalancer.Subchannel	A logical connection to a server, or a group of equivalent servers represented by an EquivalentAddressGroup.
static class	LoadBalancer.SubchannelPicker	The main balancing logic.
class	LoadBalancerProvider	Provider of LoadBalancers.
final class	LoadBalancerRegistry	Registry of LoadBalancerProviders.
static interface	Metadata.BinaryStreamMarshaller<T>	Marshaller for metadata values that are serialized to an InputStream.
static interface	MethodDescriptor.PrototypeMarshaller<T>	A marshaller that uses a fixed instance of the type it produces.
static interface	MethodDescriptor.ReflectableMarshaller<T>	A marshaller that supports retrieving its type parameter T at runtime.
class	NameResolver	A pluggable component that resolves a target URI and return addresses to the caller.
static final class	NameResolver.Args	Information that a NameResolver.Factory uses to create a NameResolver.
static final class	NameResolver.ConfigOrError	Represents either a successfully parsed service config, containing all necessary parts to be later applied by the channel, or a Status containing the error encountered while parsing.
static class	NameResolver.Factory	Factory that creates NameResolver instances.
static interface	NameResolver.Listener	Receives address updates.
static class	NameResolver.Listener2	Receives address updates.
static final class	NameResolver.ResolutionResult	Represents the results from a Name Resolver.
static final class	NameResolver.ResolutionResult.Builder	A builder for NameResolver.ResolutionResult.
static @interface	NameResolver.ResolutionResultAttr	Annotation for name resolution result attributes.
static class	NameResolver.ServiceConfigParser	Parses and validates service configuration.
class	NameResolverProvider	Provider of name resolvers for name agnostic consumption.
final class	NameResolverRegistry	Registry of NameResolverProviders.
enum	SecurityLevel	The level of security guarantee in communications.
interface	ServerCallExecutorSupplier	Defines what executor handles the server call, based on each RPC call information at runtime.
class	ServerStreamTracer	Listens to events on a stream to collect metrics.
class	ServerTransportFilter	Listens on server transport life-cycle events, with the capability to read and/or change transport attributes.
class	StatusOr<T>	Either a Status or a value.
class	StreamTracer	Listens to events on a stream to collect metrics.

Fields in io.grpc with annotations of type ExperimentalApi

Modifier and Type	Field	Description
static final Attributes.Key<String>	EquivalentAddressGroup.ATTR_AUTHORITY_OVERRIDE	The authority to be used when constructing Subchannels for this EquivalentAddressGroup.
static final Attributes.Key<SocketAddress>	Grpc.TRANSPORT_ATTR_LOCAL_ADDR	Attribute key for the local address of a transport.
static final Attributes.Key<SocketAddress>	Grpc.TRANSPORT_ATTR_REMOTE_ADDR	Attribute key for the remote address of a transport.
static final Attributes.Key<SSLSession>	Grpc.TRANSPORT_ATTR_SSL_SESSION	Attribute key for SSL session of a transport.

Methods in io.grpc with annotations of type ExperimentalApi

Modifier and Type	Method	Description
T	ServerBuilder.addStreamTracerFactory(ServerStreamTracer.Factory factory)	Adds a ServerStreamTracer.Factory to measure server-side traffic.
T	ManagedChannelBuilder.addTransportFilter(ClientTransportFilter filter)	Adds a ClientTransportFilter.
T	ServerBuilder.addTransportFilter(ServerTransportFilter filter)	Adds a ServerTransportFilter.
T	ServerBuilder.callExecutor(ServerCallExecutorSupplier executorSupplier)	Allows for defining a way to provide a custom executor to handle the server call.
CallOptions	CallOptions.clearOnReadyThreshold()	Resets to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.
abstract T	ManagedChannelBuilder.compressorRegistry(CompressorRegistry registry)	Set the compression registry for use in the channel.
abstract T	ServerBuilder.compressorRegistry(CompressorRegistry registry)	Set the compression registry for use in the channel.
abstract T	ManagedChannelBuilder.decompressorRegistry(DecompressorRegistry registry)	Set the decompression registry for use in the channel.
abstract T	ServerBuilder.decompressorRegistry(DecompressorRegistry registry)	Set the decompression registry for use in the channel.
T	ManagedChannelBuilder.defaultLoadBalancingPolicy(String policy)	Sets the default load-balancing policy that will be used if the service config doesn't specify one.
T	ManagedChannelBuilder.defaultServiceConfig(Map<String,?> serviceConfig)	Provides a service config to the channel.
T	ManagedChannelBuilder.disableServiceConfigLookUp()	Disables service config look-up from the naming system, which is enabled by default.
<T> void	Metadata.discardAll(Metadata.Key<T> key)	Remove all values for the given key without returning them.
void	ManagedChannel.enterIdle()	Invoking this method moves the channel into the IDLE state and triggers tear-down of the channel's name resolver and load balancer, while still allowing on-going RPCs on the channel to continue.
static String	MethodDescriptor.extractBareMethodName(String fullMethodName)	Extract the method name out of a fully qualified method name.
Set<String>	DecompressorRegistry.getAdvertisedMessageEncodings()	Provides a list of all message encodings that have decompressors available and should be advertised.
Attributes	ClientCall.getAttributes()	Returns additional properties of the call.
Attributes	ServerCall.getAttributes()	Returns properties of a single call.
String	CallOptions.getAuthority()	Override the HTTP/2 authority the channel claims to be connecting to.
String	LoadBalancer.PickResult.getAuthorityOverride()	Returns the authority override if any.
String	MethodDescriptor.getBareMethodName()	A convenience method for extractBareMethodName(getFullMethodName()).
ChannelLogger	NameResolver.Args.getChannelLogger()	Returns the ChannelLogger for the Channel served by this NameResolver.
List<ServerServiceDefinition>	Server.getImmutableServices()	Returns immutable services registered with the server, or an empty list if not supported by the implementation.
Integer	CallOptions.getMaxInboundMessageSize()	Gets the maximum allowed message size acceptable from the remote peer.
Integer	CallOptions.getMaxOutboundMessageSize()	Gets the maximum allowed message size acceptable to send the remote peer.
List<ServerServiceDefinition>	Server.getMutableServices()	Returns mutable services registered with the server, or an empty list if not supported by the implementation.
Integer	CallOptions.getOnReadyThreshold()	Returns to the default number of bytes that must be queued before the call will leave the 'wait for ready' state.
<T> T	CallOptions.getOption(CallOptions.Key<T> key)	Get the value for a custom option or its inherent default.
String	NameResolver.Args.getOverrideAuthority()	Returns the overrideAuthority from channel ManagedChannelBuilder.overrideAuthority(java.lang.String).
ScheduledExecutorService	NameResolver.Args.getScheduledExecutorService()	Returns a ScheduledExecutorService for scheduling delayed tasks.
Object	ServiceDescriptor.getSchemaDescriptor()	Returns the schema descriptor for this service.
SecurityLevel	ServerCall.getSecurityLevel()	Returns the level of security guarantee in communications
String	MethodDescriptor.getServiceName()	A convenience method for extractFullServiceName(getFullMethodName()).
List<ServerServiceDefinition>	HandlerRegistry.getServices()	Returns the ServerServiceDefinitions provided by the registry, or an empty list if not supported by the implementation.
List<ServerServiceDefinition>	Server.getServices()	Returns all services registered with the server, or an empty list if not supported by the implementation.
ConnectivityState	ManagedChannel.getState(boolean requestConnection)	Gets the current connectivity state.
List<ClientStreamTracer.Factory>	CallOptions.getStreamTracerFactories()	Returns an immutable list of ClientStreamTracerFactorys.
abstract T	ManagedChannelBuilder.idleTimeout(long value, TimeUnit unit)	Set the duration without ongoing RPCs before going to idle mode.
void	LoadBalancer.Helper.ignoreRefreshNameResolutionCheck()	Deprecated. Warning has been removed
T	ServerBuilder.keepAliveTime(long keepAliveTime, TimeUnit timeUnit)	Sets the time without read activity before sending a keepalive ping.
T	ServerBuilder.keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit)	Sets a time waiting for read activity after sending a keepalive ping.
T	ServerBuilder.maxConnectionAge(long maxConnectionAge, TimeUnit timeUnit)	Sets the maximum connection age, connections lasting longer than which will be gracefully terminated.
T	ServerBuilder.maxConnectionAgeGrace(long maxConnectionAgeGrace, TimeUnit timeUnit)	Sets the grace time for the graceful connection termination.
T	ServerBuilder.maxConnectionIdle(long maxConnectionIdle, TimeUnit timeUnit)	Sets the maximum connection idle time, connections being idle for longer than which will be gracefully terminated.
T	ManagedChannelBuilder.maxHedgedAttempts(int maxHedgedAttempts)	Sets the maximum number of hedged attempts that may be configured by the service config.
T	ManagedChannelBuilder.maxRetryAttempts(int maxRetryAttempts)	Sets the maximum number of retry attempts that may be configured by the service config.
T	ManagedChannelBuilder.maxTraceEvents(int maxTraceEvents)	Sets the maximum number of channel trace events to keep in the tracer for each channel or subchannel.
abstract T	ManagedChannelBuilder.nameResolverFactory(NameResolver.Factory resolverFactory)	Deprecated. Most usages should use a globally-registered NameResolverProvider instead, with either the SPI mechanism or NameResolverRegistry.register(io.grpc.NameResolverProvider).
void	ManagedChannel.notifyWhenStateChanged(ConnectivityState source, Runnable callback)	Registers a one-off callback that will be run if the connectivity state of the channel diverges from the given source, which is typically what has just been returned by ManagedChannel.getState(boolean).
static <T> CallOptions.Key<T>	CallOptions.Key.of(String debugString, T defaultValue)	Deprecated. Use CallOptions.Key.create(java.lang.String) or CallOptions.Key.createWithDefault(java.lang.String, T) instead.
static <T> Metadata.Key<T>	Metadata.Key.of(String name, Metadata.BinaryStreamMarshaller<T> marshaller)	Creates a key for a binary header, serializing to input streams.
T	ServerBuilder.permitKeepAliveTime(long keepAliveTime, TimeUnit timeUnit)	Specify the most aggressive keep-alive time clients are permitted to configure.
T	ServerBuilder.permitKeepAliveWithoutCalls(boolean permit)	Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.
T	ManagedChannelBuilder.perRpcBufferLimit(long bytes)	Sets the per RPC buffer limit in bytes used for retry.
void	ManagedChannel.resetConnectBackoff()	For subchannels that are in TRANSIENT_FAILURE state, short-circuit the backoff timer and make them reconnect immediately.
T	ManagedChannelBuilder.retryBufferSize(long bytes)	Sets the retry buffer size in bytes.
final SynchronizationContext.ScheduledHandle	SynchronizationContext.schedule(Runnable task, Duration delay, ScheduledExecutorService timerService)
final SynchronizationContext.ScheduledHandle	SynchronizationContext.scheduleWithFixedDelay(Runnable task, Duration initialDelay, Duration delay, ScheduledExecutorService timerService)
T	ManagedChannelBuilder.setBinaryLog(BinaryLog binaryLog)	Sets the BinaryLog object that this channel should log to.
T	ServerBuilder.setBinaryLog(BinaryLog binaryLog)	Sets the BinaryLog object that this server should log to.
NameResolver.Args.Builder	NameResolver.Args.Builder.setChannelLogger(ChannelLogger channelLogger)	See NameResolver.Args.getChannelLogger().
ServiceDescriptor.Builder	ServiceDescriptor.Builder.setName(String name)	Sets the name.
void	ServerCall.setOnReadyThreshold(int numBytes)	A hint to the call that specifies how many bytes must be queued before ServerCall.isReady() will return false.
NameResolver.Args.Builder	NameResolver.Args.Builder.setOverrideAuthority(String authority)	See NameResolver.Args.getOverrideAuthority().
NameResolver.Args.Builder	NameResolver.Args.Builder.setScheduledExecutorService(ScheduledExecutorService scheduledExecutorService)	See NameResolver.Args.getScheduledExecutorService().
static Status	Contexts.statusFromCancelled(Context context)	Returns the Status of a cancelled context or null if the context is not cancelled.
void	CallCredentials.thisUsesUnstableApi()	Deprecated.
static ServerServiceDefinition	ServerInterceptors.useInputStreamMessages(ServerServiceDefinition serviceDef)	Create a new ServerServiceDefinition whose MethodDescriptor serializes to and from InputStream for all methods.
static <ReqT, RespT> ServerServiceDefinition	ServerInterceptors.useMarshalledMessages(ServerServiceDefinition serviceDef, MethodDescriptor.Marshaller<ReqT> requestMarshaller, MethodDescriptor.Marshaller<RespT> responseMarshaller)	Create a new ServerServiceDefinition with MethodDescriptor for deserializing requests and separate MethodDescriptor for serializing responses.
static <T> ServerServiceDefinition	ServerInterceptors.useMarshalledMessages(ServerServiceDefinition serviceDef, MethodDescriptor.Marshaller<T> marshaller)	Create a new ServerServiceDefinition whose MethodDescriptor serializes to and from T for all methods.
CallOptions	CallOptions.withAuthority(String authority)	Override the HTTP/2 authority the channel claims to be connecting to.
CallOptions	CallOptions.withDeadlineAfter(Duration duration)
CallOptions	CallOptions.withMaxInboundMessageSize(int maxSize)	Sets the maximum allowed message size acceptable from the remote peer.
CallOptions	CallOptions.withMaxOutboundMessageSize(int maxSize)	Sets the maximum allowed message size acceptable sent to the remote peer.
CallOptions	CallOptions.withOnReadyThreshold(int numBytes)	Specifies how many bytes must be queued before the call is considered not ready to send more messages.
CallOptions	CallOptions.withStreamTracerFactory(ClientStreamTracer.Factory factory)	Returns a new CallOptions with a ClientStreamTracerFactory in addition to the existing factories.
static LoadBalancer.PickResult	LoadBalancer.PickResult.withSubchannel(LoadBalancer.Subchannel subchannel, ClientStreamTracer.Factory streamTracerFactory, String authorityOverride)	Same as withSubchannel(subchannel, streamTracerFactory) but with an authority name to override in the host header.

Uses of ExperimentalApi in io.grpc.inprocess

Classes in io.grpc.inprocess with annotations of type ExperimentalApi

Modifier and Type	Class	Description
final class	AnonymousInProcessSocketAddress	Custom SocketAddress class for InProcessTransport, for a server which can only be referenced via this address instance.
final class	InProcessChannelBuilder	Builder for a channel that issues in-process requests.
final class	InProcessServerBuilder	Builder for a server that services in-process requests.

Uses of ExperimentalApi in io.grpc.netty

Classes in io.grpc.netty with annotations of type ExperimentalApi

Modifier and Type	Class	Description
class	GrpcSslContexts	Utility for configuring SslContext for gRPC.
final class	InsecureFromHttp1ChannelCredentials	An insecure credential that upgrades from HTTP/1 to HTTP/2.
enum	NegotiationType	Identifies the negotiation used for starting up HTTP/2.
final class	NettyChannelBuilder	A builder to help simplify construction of channels using the Netty transport.
static class	NettyChannelBuilder.LocalSocketPicker	This class is meant to be overriden with a custom implementation of NettyChannelBuilder.LocalSocketPicker.createSocketAddress(java.net.SocketAddress, io.grpc.Attributes).
final class	NettyServerBuilder	A builder to help simplify the construction of a Netty-based GRPC server.
final class	NettySslContextChannelCredentials	A credential that performs TLS with Netty's SslContext as configuration.
final class	NettySslContextServerCredentials	A credential that performs TLS with Netty's SslContext as configuration.

Methods in io.grpc.netty with annotations of type ExperimentalApi

Modifier and Type	Method	Description
static io.netty.handler.ssl.SslContextBuilder	GrpcSslContexts.configure(io.netty.handler.ssl.SslContextBuilder builder, io.netty.handler.ssl.SslProvider provider)	Set ciphers and APN appropriate for gRPC.

Uses of ExperimentalApi in io.grpc.protobuf

Classes in io.grpc.protobuf with annotations of type ExperimentalApi

Modifier and Type	Class	Description
final class	StatusProto	Utility methods for working with Status.

Methods in io.grpc.protobuf with annotations of type ExperimentalApi

Modifier and Type	Method	Description
static <T extends Message> MethodDescriptor.Marshaller<T>	ProtoUtils.marshallerWithRecursionLimit(T defaultInstance, int recursionLimit)	Creates a MethodDescriptor.Marshaller for protos of the same type as defaultInstance and a custom limit for the recursion depth.

Uses of ExperimentalApi in io.grpc.protobuf.lite

Classes in io.grpc.protobuf.lite with annotations of type ExperimentalApi

Modifier and Type	Class	Description
final class	ProtoLiteUtils	Utility methods for using protobuf with grpc.

Methods in io.grpc.protobuf.lite with annotations of type ExperimentalApi

Modifier and Type	Method	Description
static <T extends com.google.protobuf.MessageLite> MethodDescriptor.Marshaller<T>	ProtoLiteUtils.marshallerWithRecursionLimit(T defaultInstance, int recursionLimit)	Creates a MethodDescriptor.Marshaller for protos of the same type as defaultInstance and a custom limit for the recursion depth.

Uses of ExperimentalApi in io.grpc.stub

Classes in io.grpc.stub with annotations of type ExperimentalApi

Modifier and Type	Class	Description
class	CallStreamObserver<V>	A refinement of StreamObserver provided by the GRPC runtime to the application (the client or the server) that allows for more complex interactions with call behavior.
final class	StreamObservers	Deprecated. Of questionable utility and generally not used.

Methods in io.grpc.stub with annotations of type ExperimentalApi

Modifier and Type	Method	Description
static ServerInterceptor	MetadataUtils.newAttachMetadataServerInterceptor(Metadata extras)	Returns a ServerInterceptor that adds the specified Metadata to every response stream, one way or another.
void	ServerCallStreamObserver.setOnCloseHandler(Runnable onCloseHandler)	Sets a Runnable to be executed when the call is closed cleanly from the server's point of view: either StreamObserver.onCompleted() or StreamObserver.onError(Throwable) has been called, all the messages and trailing metadata have been sent and the stream has been closed.
void	ServerCallStreamObserver.setOnReadyThreshold(int numBytes)	A hint to the call that specifies how many bytes must be queued before ServerCallStreamObserver.isReady() will return false.
final S	AbstractStub.withDeadlineAfter(Duration duration)
final S	AbstractStub.withMaxInboundMessageSize(int maxSize)	Returns a new stub that limits the maximum acceptable message size from a remote peer.
final S	AbstractStub.withMaxOutboundMessageSize(int maxSize)	Returns a new stub that limits the maximum acceptable message size to send a remote peer.
final S	AbstractStub.withOnReadyThreshold(int numBytes)	Returns a new stub that limits the maximum number of bytes per stream in the queue.
final <T> S	AbstractStub.withOption(CallOptions.Key<T> key, T value)	Sets a custom option to be passed to client interceptors on the channel ClientInterceptor via the CallOptions parameter.

Uses of ExperimentalApi in io.grpc.util

Classes in io.grpc.util with annotations of type ExperimentalApi

Modifier and Type	Class	Description
final class	CertificateUtils	Contains certificate/key PEM file utility method(s).
class	ForwardingClientStreamTracer
class	ForwardingLoadBalancer
class	ForwardingLoadBalancerHelper
class	ForwardingSubchannel
final class	GracefulSwitchLoadBalancer	A load balancer that gracefully swaps to a new lb policy.
final class	TransmitStatusRuntimeExceptionInterceptor	A class that intercepts uncaught exceptions of type StatusRuntimeException and handles them by closing the ServerCall, and transmitting the exception's status and metadata to the client.

Methods in io.grpc.util with annotations of type ExperimentalApi

Modifier and Type	Method	Description
List<ServerServiceDefinition>	MutableHandlerRegistry.getServices()	Note: This does not necessarily return a consistent view of the map.
void	AdvancedTlsX509KeyManager.updateIdentityCredentials(PrivateKey key, X509Certificate[] certs)	Deprecated. Use AdvancedTlsX509KeyManager.updateIdentityCredentials(X509Certificate[], PrivateKey)
void	AdvancedTlsX509KeyManager.updateIdentityCredentialsFromFile(File keyFile, File certFile)	Deprecated. Use AdvancedTlsX509KeyManager.updateIdentityCredentials(File, File) instead.
AdvancedTlsX509KeyManager.Closeable	AdvancedTlsX509KeyManager.updateIdentityCredentialsFromFile(File keyFile, File certFile, long period, TimeUnit unit, ScheduledExecutorService executor)	Deprecated. Use AdvancedTlsX509KeyManager.updateIdentityCredentials(File, File, long, TimeUnit, ScheduledExecutorService) instead.
void	AdvancedTlsX509TrustManager.updateTrustCredentialsFromFile(File trustCertFile)	Deprecated. Use AdvancedTlsX509TrustManager.updateTrustCredentials(File)
AdvancedTlsX509TrustManager.Closeable	AdvancedTlsX509TrustManager.updateTrustCredentialsFromFile(File trustCertFile, long period, TimeUnit unit, ScheduledExecutorService executor)	Deprecated. Use AdvancedTlsX509TrustManager.updateTrustCredentials(File, long,TimeUnit, ScheduledExecutorService)