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 TypeMethodDescriptionbuild(io.grpc.Channel channel, io.grpc.CallOptions callOptions) FrameSystemConfig returns the information relevant to building the robot's frame system.GetCloudMetadata returns app-related information about the robot.GetMachineStatus returns the current status of the robot.GetModelsFromModules returns the list of models supported in modules on the machine.getOperations(Robot.GetOperationsRequest request) getPose(Robot.GetPoseRequest request) GetPose returns the pose of a component in a desired referenceframe.getSessions(Robot.GetSessionsRequest request) getStatus(Robot.GetStatusRequest request) Deprecated.getVersion(Robot.GetVersionRequest request) GetVersion returns version information about the robot.listTunnels(Robot.ListTunnelsRequest request) ListTunnels lists all available tunnels configured on the robot.log(Robot.LogRequest request) Log sends logs to be logged by this robot.resourceNames(Robot.ResourceNamesRequest request) ResourceNames returns the list of all resources.ResourceRPCSubtypes returns the list of all resource types.restartModule(Robot.RestartModuleRequest request) SendSessionHeartbeat sends a heartbeat to the given session.sendTraces(Robot.SendTracesRequest request) shutdown(Robot.ShutdownRequest request) Shutdown shuts down the robot.startSession(Robot.StartSessionRequest request) StartSession creates a new session that expects at least one heartbeat within the returned window.stopAll(Robot.StopAllRequest request) StopAll will stop all current and outstanding operations for the robot and stops all actuators and movementio.grpc.stub.BlockingClientCall<?, Robot.StreamStatusResponse> streamStatus(Robot.StreamStatusRequest request) Deprecated.transformPCD(Robot.TransformPCDRequest request) TransformPose returns a point cloud in one referenceframe in a desired referenceframe.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, newStubMethods inherited from class io.grpc.stub.AbstractStub
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady
-
Method Details
-
build
protected RobotServiceGrpc.RobotServiceBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) - Specified by:
buildin classio.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
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
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
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
-