Package com.viam.robot.v1

Class RobotServiceGrpc.RobotServiceBlockingV2Stub

java.lang.Object

io.grpc.stub.AbstractStub<RobotServiceGrpc.RobotServiceBlockingV2Stub>

io.grpc.stub.AbstractBlockingStub<RobotServiceGrpc.RobotServiceBlockingV2Stub>

com.viam.robot.v1.RobotServiceGrpc.RobotServiceBlockingV2Stub

Enclosing class:

RobotServiceGrpc

public static final class RobotServiceGrpc.RobotServiceBlockingV2Stub
extends io.grpc.stub.AbstractBlockingStub<RobotServiceGrpc.RobotServiceBlockingV2Stub>

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

 A RobotService encompasses all functionality of some robot comprised of parts, local and remote.
 

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
Robot.BlockForOperationResponse	blockForOperation(Robot.BlockForOperationRequest request)
protected RobotServiceGrpc.RobotServiceBlockingV2Stub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Robot.CancelOperationResponse	cancelOperation(Robot.CancelOperationRequest request)
Robot.FrameSystemConfigResponse	frameSystemConfig(Robot.FrameSystemConfigRequest request)	FrameSystemConfig returns the information relevant to building the robot's frame system.
Robot.GetCloudMetadataResponse	getCloudMetadata(Robot.GetCloudMetadataRequest request)	GetCloudMetadata returns app-related information about the robot.
Robot.GetMachineStatusResponse	getMachineStatus(Robot.GetMachineStatusRequest request)	GetMachineStatus returns the current status of the robot.
Robot.GetModelsFromModulesResponse	getModelsFromModules(Robot.GetModelsFromModulesRequest request)	GetModelsFromModules returns the list of models supported in modules on the machine.
Robot.GetOperationsResponse	getOperations(Robot.GetOperationsRequest request)
Robot.GetPoseResponse	getPose(Robot.GetPoseRequest request)	GetPose returns the pose of a component in a desired referenceframe.
Robot.GetSessionsResponse	getSessions(Robot.GetSessionsRequest request)
Robot.GetStatusResponse	getStatus(Robot.GetStatusRequest request)	Deprecated.
Robot.GetVersionResponse	getVersion(Robot.GetVersionRequest request)	GetVersion returns version information about the robot.
Robot.ListTunnelsResponse	listTunnels(Robot.ListTunnelsRequest request)	ListTunnels lists all available tunnels configured on the robot.
Robot.LogResponse	log(Robot.LogRequest request)	Log sends logs to be logged by this robot.
Robot.ResourceNamesResponse	resourceNames(Robot.ResourceNamesRequest request)	ResourceNames returns the list of all resources.
Robot.ResourceRPCSubtypesResponse	resourceRPCSubtypes(Robot.ResourceRPCSubtypesRequest request)	ResourceRPCSubtypes returns the list of all resource types.
Robot.RestartModuleResponse	restartModule(Robot.RestartModuleRequest request)
Robot.SendSessionHeartbeatResponse	sendSessionHeartbeat(Robot.SendSessionHeartbeatRequest request)	SendSessionHeartbeat sends a heartbeat to the given session.
Robot.SendTracesResponse	sendTraces(Robot.SendTracesRequest request)
Robot.ShutdownResponse	shutdown(Robot.ShutdownRequest request)	Shutdown shuts down the robot.
Robot.StartSessionResponse	startSession(Robot.StartSessionRequest request)	StartSession creates a new session that expects at least one heartbeat within the returned window.
Robot.StopAllResponse	stopAll(Robot.StopAllRequest request)	StopAll will stop all current and outstanding operations for the robot and stops all actuators and movement
io.grpc.stub.BlockingClientCall<?,Robot.StreamStatusResponse>	streamStatus(Robot.StreamStatusRequest request)	Deprecated.
Robot.TransformPCDResponse	transformPCD(Robot.TransformPCDRequest request)	TransformPose returns a point cloud in one referenceframe in a desired referenceframe.
Robot.TransformPoseResponse	transformPose(Robot.TransformPoseRequest request)	TransformPose returns a pose in one referenceframe in a desired referenceframe.
io.grpc.stub.BlockingClientCall<Robot.TunnelRequest,Robot.TunnelResponse>	tunnel()	Tunnel tunnels traffic to the destination port of the robot server.

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 RobotServiceGrpc.RobotServiceBlockingV2Stub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<RobotServiceGrpc.RobotServiceBlockingV2Stub>

getOperations

public Robot.GetOperationsResponse getOperations(Robot.GetOperationsRequest request)
                                          throws io.grpc.StatusException

Throws:

io.grpc.StatusException

getSessions

public Robot.GetSessionsResponse getSessions(Robot.GetSessionsRequest request)
                                      throws io.grpc.StatusException

Throws:

io.grpc.StatusException

resourceNames

public Robot.ResourceNamesResponse resourceNames(Robot.ResourceNamesRequest request)
                                          throws io.grpc.StatusException

 ResourceNames returns the list of all resources.
 

Throws:

io.grpc.StatusException

resourceRPCSubtypes

public Robot.ResourceRPCSubtypesResponse resourceRPCSubtypes(Robot.ResourceRPCSubtypesRequest request)
                                                      throws io.grpc.StatusException

 ResourceRPCSubtypes returns the list of all resource types.
 

Throws:

io.grpc.StatusException

cancelOperation

public Robot.CancelOperationResponse cancelOperation(Robot.CancelOperationRequest request)
                                              throws io.grpc.StatusException

Throws:

io.grpc.StatusException

blockForOperation

public Robot.BlockForOperationResponse blockForOperation(Robot.BlockForOperationRequest request)
                                                  throws io.grpc.StatusException

Throws:

io.grpc.StatusException

getModelsFromModules

public Robot.GetModelsFromModulesResponse getModelsFromModules(Robot.GetModelsFromModulesRequest request)
                                                        throws io.grpc.StatusException

 GetModelsFromModules returns the list of models supported in modules on the machine.
 

Throws:

io.grpc.StatusException

getStatus

@Deprecated
public Robot.GetStatusResponse getStatus(Robot.GetStatusRequest request)
                                  throws io.grpc.StatusException

Deprecated.

 GetStatus returns the list of all statuses requested. An empty request signifies all resources.
 

Throws:

io.grpc.StatusException

streamStatus

@Deprecated
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<?,Robot.StreamStatusResponse> streamStatus(Robot.StreamStatusRequest request)

Deprecated.

 StreamStatus periodically sends the status of all statuses requested. An empty request signifies all resources.
 

stopAll

public Robot.StopAllResponse stopAll(Robot.StopAllRequest request)
                              throws io.grpc.StatusException

 StopAll will stop all current and outstanding operations for the robot and stops all actuators and movement
 

Throws:

io.grpc.StatusException

startSession

public Robot.StartSessionResponse startSession(Robot.StartSessionRequest request)
                                        throws io.grpc.StatusException

 StartSession creates a new session that expects at least one heartbeat within the returned window.
 If the window lapses, any resources that have safety heart monitored methods, where this session was
 the last caller on the resource, will be stopped.
 

Throws:

io.grpc.StatusException

sendSessionHeartbeat

public Robot.SendSessionHeartbeatResponse sendSessionHeartbeat(Robot.SendSessionHeartbeatRequest request)
                                                        throws io.grpc.StatusException

 SendSessionHeartbeat sends a heartbeat to the given session. If the session has expired, a
 SESSION_EXPIRED error will be returned.
 

Throws:

io.grpc.StatusException

log

public Robot.LogResponse log(Robot.LogRequest request)
                      throws io.grpc.StatusException

 Log sends logs to be logged by this robot. Currently used for module logging.
 

Throws:

io.grpc.StatusException

getCloudMetadata

public Robot.GetCloudMetadataResponse getCloudMetadata(Robot.GetCloudMetadataRequest request)
                                                throws io.grpc.StatusException

 GetCloudMetadata returns app-related information about the robot.
 

Throws:

io.grpc.StatusException

restartModule

public Robot.RestartModuleResponse restartModule(Robot.RestartModuleRequest request)
                                          throws io.grpc.StatusException

Throws:

io.grpc.StatusException

shutdown

public Robot.ShutdownResponse shutdown(Robot.ShutdownRequest request)
                                throws io.grpc.StatusException

 Shutdown shuts down the robot.
 

Throws:

io.grpc.StatusException

getMachineStatus

public Robot.GetMachineStatusResponse getMachineStatus(Robot.GetMachineStatusRequest request)
                                                throws io.grpc.StatusException

 GetMachineStatus returns the current status of the robot.
 

Throws:

io.grpc.StatusException

getVersion

public Robot.GetVersionResponse getVersion(Robot.GetVersionRequest request)
                                    throws io.grpc.StatusException

 GetVersion returns version information about the robot.
 

Throws:

io.grpc.StatusException

tunnel

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918")
public io.grpc.stub.BlockingClientCall<Robot.TunnelRequest,Robot.TunnelResponse> tunnel()

 Tunnel tunnels traffic to the destination port of the robot server.
 

listTunnels

public Robot.ListTunnelsResponse listTunnels(Robot.ListTunnelsRequest request)
                                      throws io.grpc.StatusException

 ListTunnels lists all available tunnels configured on the robot.
 

Throws:

io.grpc.StatusException

frameSystemConfig

public Robot.FrameSystemConfigResponse frameSystemConfig(Robot.FrameSystemConfigRequest request)
                                                  throws io.grpc.StatusException

 FrameSystemConfig returns the information relevant to building the robot's frame system.
 

Throws:

io.grpc.StatusException

getPose

public Robot.GetPoseResponse getPose(Robot.GetPoseRequest request)
                              throws io.grpc.StatusException

 GetPose returns the pose of a component in a desired referenceframe.
 

Throws:

io.grpc.StatusException

transformPose

public Robot.TransformPoseResponse transformPose(Robot.TransformPoseRequest request)
                                          throws io.grpc.StatusException

 TransformPose returns a pose in one referenceframe in a desired referenceframe.
 

Throws:

io.grpc.StatusException

transformPCD

public Robot.TransformPCDResponse transformPCD(Robot.TransformPCDRequest request)
                                        throws io.grpc.StatusException

 TransformPose returns a point cloud in one referenceframe in a desired referenceframe.
 

Throws:

io.grpc.StatusException

sendTraces

public Robot.SendTracesResponse sendTraces(Robot.SendTracesRequest request)
                                    throws io.grpc.StatusException

Throws:

io.grpc.StatusException