B C D F G I N O P R S T X

B

bindService() - Method in class io.grpc.xds.orca.OrcaServiceImpl

build() - Method in class io.grpc.xds.orca.OrcaOobUtil.OrcaReportingConfig.Builder

Creates a new OrcaOobUtil.OrcaReportingConfig object.

build() - Method in class io.grpc.xds.XdsServerBuilder

C

create(MetricRecorder) - Static method in class io.grpc.xds.orca.OrcaMetricReportingServerInterceptor

Creates a new OrcaMetricReportingServerInterceptor instance with the given MetricRecorder.

create(ChannelCredentials) - Static method in class io.grpc.xds.XdsChannelCredentials

Creates credentials to be configured by xDS, falling back to other credentials if no TLS configuration is provided by xDS.

create(ServerCredentials) - Static method in class io.grpc.xds.XdsServerCredentials

Creates credentials to be configured by xDS, falling back to other credentials if no TLS configuration is provided by xDS.

createService(ScheduledExecutorService, MetricRecorder, long, TimeUnit) - Static method in class io.grpc.xds.orca.OrcaServiceImpl

Constructs a service to report server metrics.

createService(ScheduledExecutorService, MetricRecorder) - Static method in class io.grpc.xds.orca.OrcaServiceImpl

CsdsService - Class in io.grpc.xds

The CSDS service provides information about the status of a running xDS client.

D

DEFAULT_MIN_REPORT_INTERVAL_NANOS - Static variable in class io.grpc.xds.orca.OrcaServiceImpl

Empty or invalid (non-positive) minInterval config in will be treated to this default value.

delegate() - Method in class io.grpc.xds.XdsServerBuilder

drainGraceTime(long, TimeUnit) - Method in class io.grpc.xds.XdsServerBuilder

Sets the grace time when draining connections with outdated configuration.

F

fetchClientStatus(ClientStatusRequest, StreamObserver<ClientStatusResponse>) - Method in class io.grpc.xds.CsdsService

forPort(int) - Static method in class io.grpc.xds.XdsServerBuilder

forPort(int, ServerCredentials) - Static method in class io.grpc.xds.XdsServerBuilder

Creates a gRPC server builder for the given port.

G

getInstance() - Static method in class io.grpc.xds.orca.OrcaMetricReportingServerInterceptor

getInstance() - Static method in class io.grpc.xds.orca.OrcaPerRequestUtil

Gets an OrcaPerRequestUtil instance that provides actual implementation of OrcaPerRequestUtil.newOrcaClientStreamTracerFactory(io.grpc.xds.orca.OrcaPerRequestUtil.OrcaPerRequestReportListener).

getName() - Method in class io.grpc.xds.XdsCredentialsProvider

Returns the xDS credential name associated with this provider which makes it selectable via XdsCredentialsRegistry.getProvider(java.lang.String).

getReportIntervalNanos() - Method in class io.grpc.xds.orca.OrcaOobUtil.OrcaReportingConfig

Returns the configured maximum interval of receiving out-of-band ORCA reports.

getRingSizeCap() - Static method in class io.grpc.xds.RingHashOptions

Get the global limit for min and max ring hash sizes.

I

interceptCall(ServerCall<ReqT, RespT>, Metadata, ServerCallHandler<ReqT, RespT>) - Method in class io.grpc.xds.orca.OrcaMetricReportingServerInterceptor

io.grpc.xds - package io.grpc.xds

Library for gPRC proxyless service mesh using Envoy xDS protocol.

io.grpc.xds.orca - package io.grpc.xds.orca

isAvailable() - Method in class io.grpc.xds.XdsCredentialsProvider

Whether this provider is available for use, taking the current environment into consideration.

N

newBuilder() - Static method in class io.grpc.xds.orca.OrcaOobUtil.OrcaReportingConfig

Creates a new builder.

newChannelCredentials(Map<String, ?>) - Method in class io.grpc.xds.XdsCredentialsProvider

Creates a ChannelCredentials from the given jsonConfig, or null if the given config is invalid.

newInstance() - Static method in class io.grpc.xds.CsdsService

Creates an instance.

newOrcaClientStreamTracerFactory(OrcaPerRequestUtil.OrcaPerRequestReportListener) - Method in class io.grpc.xds.orca.OrcaPerRequestUtil

Creates a new ClientStreamTracer.Factory with provided OrcaPerRequestUtil.OrcaPerRequestReportListener installed to receive callback when a per-request ORCA report is received.

newOrcaClientStreamTracerFactory(ClientStreamTracer.Factory, OrcaPerRequestUtil.OrcaPerRequestReportListener) - Method in class io.grpc.xds.orca.OrcaPerRequestUtil

Creates a new ClientStreamTracer.Factory with provided OrcaPerRequestUtil.OrcaPerRequestReportListener installed to receive callback when a per-request ORCA report is received.

newOrcaReportingHelper(LoadBalancer.Helper) - Static method in class io.grpc.xds.orca.OrcaOobUtil

Creates a new LoadBalancer.Helper with provided OrcaOobUtil.OrcaOobReportListener installed to receive callback when an out-of-band ORCA report is received.

O

onLoadReport(MetricReport) - Method in interface io.grpc.xds.orca.OrcaOobUtil.OrcaOobReportListener

Invoked when an out-of-band ORCA report is received.

onLoadReport(MetricReport) - Method in interface io.grpc.xds.orca.OrcaPerRequestUtil.OrcaPerRequestReportListener

Invoked when a per-request ORCA report is received.

onNotServing(Throwable) - Method in interface io.grpc.xds.XdsServerBuilder.XdsServingStatusListener

Callback invoked when server is forced to be "not serving" due to an error.

onServing() - Method in interface io.grpc.xds.XdsServerBuilder.XdsServingStatusListener

Callback invoked when server begins serving.

OrcaMetricReportingServerInterceptor - Class in io.grpc.xds.orca

A ServerInterceptor that intercepts a ServerCall by running server-side RPC handling under a Context that records custom per-request metrics provided by server applications and sends to client side along with the response in the format of Open Request Cost Aggregation (ORCA).

OrcaOobUtil - Class in io.grpc.xds.orca

Utility class that provides method for LoadBalancer to install listeners to receive out-of-band backend metrics in the format of Open Request Cost Aggregation (ORCA).

OrcaOobUtil.OrcaOobReportListener - Interface in io.grpc.xds.orca

The listener interface for receiving out-of-band ORCA reports from backends.

OrcaOobUtil.OrcaReportingConfig - Class in io.grpc.xds.orca

Configuration for out-of-band ORCA reporting service RPC.

OrcaOobUtil.OrcaReportingConfig.Builder - Class in io.grpc.xds.orca

OrcaPerRequestUtil - Class in io.grpc.xds.orca

Utility class that provides method for LoadBalancer to install listeners to receive per-request backend cost metrics in the format of Open Request Cost Aggregation (ORCA).

OrcaPerRequestUtil() - Constructor for class io.grpc.xds.orca.OrcaPerRequestUtil

OrcaPerRequestUtil.OrcaPerRequestReportListener - Interface in io.grpc.xds.orca

The listener interface for receiving per-request ORCA reports from backends.

OrcaServiceImpl - Class in io.grpc.xds.orca

Implements a BindableService that generates Out-Of-Band server metrics.

overrideBootstrapForTest(Map<String, ?>) - Method in class io.grpc.xds.XdsServerBuilder

Allows providing bootstrap override, useful for testing.

P

priority() - Method in class io.grpc.xds.XdsCredentialsProvider

A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.

R

RingHashOptions - Class in io.grpc.xds

Utility class that provides a way to configure ring hash size limits.

S

setListener(LoadBalancer.Subchannel, OrcaOobUtil.OrcaOobReportListener, OrcaOobUtil.OrcaReportingConfig) - Static method in class io.grpc.xds.orca.OrcaOobUtil

Update OrcaOobUtil.OrcaOobReportListener to receive Out-of-Band metrics report for the particular subchannel connection, and set the configuration of receiving ORCA reports, such as the interval of receiving reports.

setReportInterval(long, TimeUnit) - Method in class io.grpc.xds.orca.OrcaOobUtil.OrcaReportingConfig.Builder

Sets the maximum expected interval of receiving out-of-band ORCA report.

setRingSizeCap(long) - Static method in class io.grpc.xds.RingHashOptions

Set the global limit for the min and max number of ring hash entries per ring.

streamClientStatus(StreamObserver<ClientStatusResponse>) - Method in class io.grpc.xds.CsdsService

T

toBuilder() - Method in class io.grpc.xds.orca.OrcaOobUtil.OrcaReportingConfig

Returns a builder with the same initial values as this object.

toString() - Method in class io.grpc.xds.orca.OrcaOobUtil.OrcaReportingConfig

transportBuilder() - Method in class io.grpc.xds.XdsServerBuilder

Returns the delegate NettyServerBuilder to allow experimental level transport-specific configuration.

X

XdsChannelCredentials - Class in io.grpc.xds

XdsCredentialsProvider - Class in io.grpc.xds

Provider of credentials which can be consumed by clients for xds communications.

XdsCredentialsProvider() - Constructor for class io.grpc.xds.XdsCredentialsProvider

XdsServerBuilder - Class in io.grpc.xds

A version of ServerBuilder to create xDS managed servers.

XdsServerBuilder.XdsServingStatusListener - Interface in io.grpc.xds

Applications can register this listener to receive "serving" and "not serving" states of the server using XdsServerBuilder.xdsServingStatusListener(XdsServingStatusListener).

XdsServerCredentials - Class in io.grpc.xds

xdsServingStatusListener(XdsServerBuilder.XdsServingStatusListener) - Method in class io.grpc.xds.XdsServerBuilder

Set the XdsServerBuilder.XdsServingStatusListener to receive "serving" and "not serving" states.

B C D F G I N O P R S T X