Package io.grpc.channelz.v1

Class ChannelzGrpc.ChannelzFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<ChannelzGrpc.ChannelzFutureStub>

io.grpc.channelz.v1.ChannelzGrpc.ChannelzFutureStub

Enclosing class:

ChannelzGrpc

public static final class ChannelzGrpc.ChannelzFutureStub
extends AbstractFutureStub<ChannelzGrpc.ChannelzFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Channelz.

 Channelz is a service exposed by gRPC servers that provides detailed debug
 information.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected ChannelzGrpc.ChannelzFutureStub	build(Channel channel, CallOptions callOptions)	Returns a new stub with the given channel for the provided method configurations.
com.google.common.util.concurrent.ListenableFuture<GetChannelResponse>	getChannel(GetChannelRequest request)	Returns a single Channel, or else a NOT_FOUND code.
com.google.common.util.concurrent.ListenableFuture<GetServerResponse>	getServer(GetServerRequest request)	Returns a single Server, or else a NOT_FOUND code.
com.google.common.util.concurrent.ListenableFuture<GetServersResponse>	getServers(GetServersRequest request)	Gets all servers that exist in the process.
com.google.common.util.concurrent.ListenableFuture<GetServerSocketsResponse>	getServerSockets(GetServerSocketsRequest request)	Gets all server sockets that exist in the process.
com.google.common.util.concurrent.ListenableFuture<GetSocketResponse>	getSocket(GetSocketRequest request)	Returns a single Socket or else a NOT_FOUND code.
com.google.common.util.concurrent.ListenableFuture<GetSubchannelResponse>	getSubchannel(GetSubchannelRequest request)	Returns a single Subchannel, or else a NOT_FOUND code.
com.google.common.util.concurrent.ListenableFuture<GetTopChannelsResponse>	getTopChannels(GetTopChannelsRequest request)	Gets all root channels (i.e.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected ChannelzGrpc.ChannelzFutureStub build(Channel channel,
                                                CallOptions callOptions)

Description copied from class: AbstractStub

Returns a new stub with the given channel for the provided method configurations.

Specified by:

build in class AbstractStub<ChannelzGrpc.ChannelzFutureStub>

Parameters:

channel - the channel that this stub will use to do communications

callOptions - the runtime call options to be applied to every call on this stub

getTopChannels

public com.google.common.util.concurrent.ListenableFuture<GetTopChannelsResponse> getTopChannels(GetTopChannelsRequest request)

 Gets all root channels (i.e. channels the application has directly
 created). This does not include subchannels nor non-top level channels.
 

getServers

public com.google.common.util.concurrent.ListenableFuture<GetServersResponse> getServers(GetServersRequest request)

 Gets all servers that exist in the process.
 

getServer

public com.google.common.util.concurrent.ListenableFuture<GetServerResponse> getServer(GetServerRequest request)

 Returns a single Server, or else a NOT_FOUND code.
 

getServerSockets

public com.google.common.util.concurrent.ListenableFuture<GetServerSocketsResponse> getServerSockets(GetServerSocketsRequest request)

 Gets all server sockets that exist in the process.
 

getChannel

public com.google.common.util.concurrent.ListenableFuture<GetChannelResponse> getChannel(GetChannelRequest request)

 Returns a single Channel, or else a NOT_FOUND code.
 

getSubchannel

public com.google.common.util.concurrent.ListenableFuture<GetSubchannelResponse> getSubchannel(GetSubchannelRequest request)

 Returns a single Subchannel, or else a NOT_FOUND code.
 

getSocket

public com.google.common.util.concurrent.ListenableFuture<GetSocketResponse> getSocket(GetSocketRequest request)

 Returns a single Socket or else a NOT_FOUND code.