Package io.deephaven.proto.controller.grpc

Class ControllerApiGrpc.ControllerApiBlockingV2Stub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<ControllerApiGrpc.ControllerApiBlockingV2Stub>

io.deephaven.proto.controller.grpc.ControllerApiGrpc.ControllerApiBlockingV2Stub

Enclosing class:

ControllerApiGrpc

public static final class ControllerApiGrpc.ControllerApiBlockingV2Stub
extends io.grpc.stub.AbstractBlockingStub<ControllerApiGrpc.ControllerApiBlockingV2Stub>

A stub to allow clients to do synchronous rpc calls to service ControllerApi.

Nested Class Summary

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

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
AddQueryResponse	addQuery(AddQueryRequest request)	These are for query management
AuthenticationResponse	authenticate(AuthenticationRequest request)	Given a token and client ID from the auth service, authenticate and return a cookie for future use on this service.
protected ControllerApiGrpc.ControllerApiBlockingV2Stub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
DeserializeQueryConfigurationResponse	deserializeQueryConfiguration(DeserializeQueryConfigurationRequest request)
DetermineDispatcherResponse	determineDispatcher(DetermineDispatcherRequest request)
GetConfigurationResponse	getConfiguration(GetConfigurationRequest request)	Simple unary to request the current configuration, as an alternative to having it pushed via subscribe, or requesting it on authenticate.
GetScriptResponse	getScript(GetScriptRequest request)
GetScriptPathsResponse	getScriptPaths(GetScriptPathsRequest request)	Script commands
InvalidateCookieResponse	invalidateCookie(InvalidateCookieRequest request)
ModifyQueryResponse	modifyQuery(ModifyQueryRequest request)
PingResponse	ping(PingRequest request)	Simple no-op to verify connectivity.
ReloadConfigResponse	reloadConfig(ReloadConfigRequest request)
RemoveQueryResponse	removeQuery(RemoveQueryRequest request)
RestartQueryResponse	restartQuery(RestartQueryRequest request)
RestartReplicaResponse	restartReplica(RestartReplicaRequest request)
ServerSelectionAdminResponse	selectionProviderAdmin(ServerSelectionAdminRequest request)
ServerSelectionStatusResponse	selectionProviderStatus(ServerSelectionStatusRequest request)
SerializeQueryConfigurationResponse	serializeQueryConfiguration(SerializeQueryConfigurationRequest request)	XML import and export
StatusUpdateResponse	statusUpdate(StatusUpdateRequest request)	Configuration commands
StopQueryResponse	stopQuery(StopQueryRequest request)
StopReplicaResponse	stopReplica(StopReplicaRequest request)
io.grpc.stub.BlockingClientCall<?,SubscribeResponse>	subscribe(SubscribeRequest request)	Subscribes to a stream of query configuration/state changes, as well as controller configuration changes.

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 Details

build

protected ControllerApiGrpc.ControllerApiBlockingV2Stub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ControllerApiGrpc.ControllerApiBlockingV2Stub>

authenticate

public AuthenticationResponse authenticate(AuthenticationRequest request)
                                    throws io.grpc.StatusException

 Given a token and client ID from the auth service, authenticate and return a cookie for future use on this
 service. Optionally will send controller configuration.
 

Throws:

io.grpc.StatusException

addQuery

public AddQueryResponse addQuery(AddQueryRequest request)
                          throws io.grpc.StatusException

 These are for query management
 

Throws:

io.grpc.StatusException

removeQuery

public RemoveQueryResponse removeQuery(RemoveQueryRequest request)
                                throws io.grpc.StatusException

Throws:

io.grpc.StatusException

modifyQuery

public ModifyQueryResponse modifyQuery(ModifyQueryRequest request)
                                throws io.grpc.StatusException

Throws:

io.grpc.StatusException

restartQuery

public RestartQueryResponse restartQuery(RestartQueryRequest request)
                                  throws io.grpc.StatusException

Throws:

io.grpc.StatusException

stopQuery

public StopQueryResponse stopQuery(StopQueryRequest request)
                            throws io.grpc.StatusException

Throws:

io.grpc.StatusException

restartReplica

public RestartReplicaResponse restartReplica(RestartReplicaRequest request)
                                      throws io.grpc.StatusException

Throws:

io.grpc.StatusException

stopReplica

public StopReplicaResponse stopReplica(StopReplicaRequest request)
                                throws io.grpc.StatusException

Throws:

io.grpc.StatusException

determineDispatcher

public DetermineDispatcherResponse determineDispatcher(DetermineDispatcherRequest request)
                                                throws io.grpc.StatusException

Throws:

io.grpc.StatusException

selectionProviderStatus

public ServerSelectionStatusResponse selectionProviderStatus(ServerSelectionStatusRequest request)
                                                      throws io.grpc.StatusException

Throws:

io.grpc.StatusException

selectionProviderAdmin

public ServerSelectionAdminResponse selectionProviderAdmin(ServerSelectionAdminRequest request)
                                                    throws io.grpc.StatusException

Throws:

io.grpc.StatusException

getConfiguration

public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)
                                          throws io.grpc.StatusException

 Simple unary to request the current configuration, as an alternative to having it pushed via subscribe, or
 requesting it on authenticate.
 

Throws:

io.grpc.StatusException

getScriptPaths

public GetScriptPathsResponse getScriptPaths(GetScriptPathsRequest request)
                                      throws io.grpc.StatusException

 Script commands
 

Throws:

io.grpc.StatusException

getScript

public GetScriptResponse getScript(GetScriptRequest request)
                            throws io.grpc.StatusException

Throws:

io.grpc.StatusException

statusUpdate

public StatusUpdateResponse statusUpdate(StatusUpdateRequest request)
                                  throws io.grpc.StatusException

 Configuration commands
 

Throws:

io.grpc.StatusException

reloadConfig

public ReloadConfigResponse reloadConfig(ReloadConfigRequest request)
                                  throws io.grpc.StatusException

Throws:

io.grpc.StatusException

ping

public PingResponse ping(PingRequest request)
                  throws io.grpc.StatusException

 Simple no-op to verify connectivity. The server will terminate sessions after some idle time (default of one minute),
 so clients should ping at some interval less than that, such as every 10 seconds.
 

Throws:

io.grpc.StatusException

subscribe

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,SubscribeResponse> subscribe(SubscribeRequest request)

 Subscribes to a stream of query configuration/state changes, as well as controller configuration changes. As the stream
 starts, the current configuration will be sent, along with the current state of all queries.
 

invalidateCookie

public InvalidateCookieResponse invalidateCookie(InvalidateCookieRequest request)
                                          throws io.grpc.StatusException

Throws:

io.grpc.StatusException

serializeQueryConfiguration

public SerializeQueryConfigurationResponse serializeQueryConfiguration(SerializeQueryConfigurationRequest request)
                                                                throws io.grpc.StatusException

 XML import and export
 

Throws:

io.grpc.StatusException

deserializeQueryConfiguration

public DeserializeQueryConfigurationResponse deserializeQueryConfiguration(DeserializeQueryConfigurationRequest request)
                                                                    throws io.grpc.StatusException

Throws:

io.grpc.StatusException