Package io.grpc.channelz.v1

Class ChannelzGrpc.ChannelzBlockingV2Stub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<ChannelzGrpc.ChannelzBlockingV2Stub>

io.grpc.channelz.v1.ChannelzGrpc.ChannelzBlockingV2Stub

Enclosing class:

ChannelzGrpc

public static final class ChannelzGrpc.ChannelzBlockingV2Stub
extends AbstractBlockingStub<ChannelzGrpc.ChannelzBlockingV2Stub>

A stub to allow clients to do synchronous 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.ChannelzBlockingV2Stub	build(Channel channel, CallOptions callOptions)	Returns a new stub with the given channel for the provided method configurations.
GetChannelResponse	getChannel(GetChannelRequest request)	Returns a single Channel, or else a NOT_FOUND code.
GetServerResponse	getServer(GetServerRequest request)	Returns a single Server, or else a NOT_FOUND code.
GetServersResponse	getServers(GetServersRequest request)	Gets all servers that exist in the process.
GetServerSocketsResponse	getServerSockets(GetServerSocketsRequest request)	Gets all server sockets that exist in the process.
GetSocketResponse	getSocket(GetSocketRequest request)	Returns a single Socket or else a NOT_FOUND code.
GetSubchannelResponse	getSubchannel(GetSubchannelRequest request)	Returns a single Subchannel, or else a NOT_FOUND code.
GetTopChannelsResponse	getTopChannels(GetTopChannelsRequest request)	Gets all root channels (i.e.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, 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.ChannelzBlockingV2Stub 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.ChannelzBlockingV2Stub>

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 GetTopChannelsResponse getTopChannels(GetTopChannelsRequest request)
                                      throws StatusException

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

Throws:

StatusException

getServers

public GetServersResponse getServers(GetServersRequest request)
                              throws StatusException

 Gets all servers that exist in the process.
 

Throws:

StatusException

getServer

public GetServerResponse getServer(GetServerRequest request)
                            throws StatusException

 Returns a single Server, or else a NOT_FOUND code.
 

Throws:

StatusException

getServerSockets

public GetServerSocketsResponse getServerSockets(GetServerSocketsRequest request)
                                          throws StatusException

 Gets all server sockets that exist in the process.
 

Throws:

StatusException

getChannel

public GetChannelResponse getChannel(GetChannelRequest request)
                              throws StatusException

 Returns a single Channel, or else a NOT_FOUND code.
 

Throws:

StatusException

getSubchannel

public GetSubchannelResponse getSubchannel(GetSubchannelRequest request)
                                    throws StatusException

 Returns a single Subchannel, or else a NOT_FOUND code.
 

Throws:

StatusException

getSocket

public GetSocketResponse getSocket(GetSocketRequest request)
                            throws StatusException

 Returns a single Socket or else a NOT_FOUND code.
 

Throws:

StatusException