Package com.viam.robot.v1

Class RobotServiceGrpc.RobotServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

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

com.viam.robot.v1.RobotServiceGrpc.RobotServiceBlockingStub

Enclosing class:

RobotServiceGrpc

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

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.RobotServiceBlockingStub	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.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
Iterator<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.

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

Specified by:

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

getOperations

public Robot.GetOperationsResponse getOperations(Robot.GetOperationsRequest request)

getSessions

public Robot.GetSessionsResponse getSessions(Robot.GetSessionsRequest request)

resourceNames

public Robot.ResourceNamesResponse resourceNames(Robot.ResourceNamesRequest request)

 ResourceNames returns the list of all resources.
 

resourceRPCSubtypes

public Robot.ResourceRPCSubtypesResponse resourceRPCSubtypes(Robot.ResourceRPCSubtypesRequest request)

 ResourceRPCSubtypes returns the list of all resource types.
 

cancelOperation

public Robot.CancelOperationResponse cancelOperation(Robot.CancelOperationRequest request)

blockForOperation

public Robot.BlockForOperationResponse blockForOperation(Robot.BlockForOperationRequest request)

getModelsFromModules

public Robot.GetModelsFromModulesResponse getModelsFromModules(Robot.GetModelsFromModulesRequest request)

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

getStatus

@Deprecated
public Robot.GetStatusResponse getStatus(Robot.GetStatusRequest request)

Deprecated.

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

streamStatus

@Deprecated
public Iterator<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)

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

startSession

public Robot.StartSessionResponse startSession(Robot.StartSessionRequest request)

 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.
 

sendSessionHeartbeat

public Robot.SendSessionHeartbeatResponse sendSessionHeartbeat(Robot.SendSessionHeartbeatRequest request)

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

log

public Robot.LogResponse log(Robot.LogRequest request)

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

getCloudMetadata

public Robot.GetCloudMetadataResponse getCloudMetadata(Robot.GetCloudMetadataRequest request)

 GetCloudMetadata returns app-related information about the robot.
 

restartModule

public Robot.RestartModuleResponse restartModule(Robot.RestartModuleRequest request)

shutdown

public Robot.ShutdownResponse shutdown(Robot.ShutdownRequest request)

 Shutdown shuts down the robot.
 

getMachineStatus

public Robot.GetMachineStatusResponse getMachineStatus(Robot.GetMachineStatusRequest request)

 GetMachineStatus returns the current status of the robot.
 

getVersion

public Robot.GetVersionResponse getVersion(Robot.GetVersionRequest request)

 GetVersion returns version information about the robot.
 

listTunnels

public Robot.ListTunnelsResponse listTunnels(Robot.ListTunnelsRequest request)

 ListTunnels lists all available tunnels configured on the robot.
 

frameSystemConfig

public Robot.FrameSystemConfigResponse frameSystemConfig(Robot.FrameSystemConfigRequest request)

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

getPose

public Robot.GetPoseResponse getPose(Robot.GetPoseRequest request)

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

transformPose

public Robot.TransformPoseResponse transformPose(Robot.TransformPoseRequest request)

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

transformPCD

public Robot.TransformPCDResponse transformPCD(Robot.TransformPCDRequest request)

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