Package com.viam.robot.v1

Class RobotServiceGrpc.RobotServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<RobotServiceGrpc.RobotServiceFutureStub>

com.viam.robot.v1.RobotServiceGrpc.RobotServiceFutureStub

Enclosing class:

RobotServiceGrpc

public static final class RobotServiceGrpc.RobotServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<RobotServiceGrpc.RobotServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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
com.google.common.util.concurrent.ListenableFuture<Robot.BlockForOperationResponse>	blockForOperation(Robot.BlockForOperationRequest request)
protected RobotServiceGrpc.RobotServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Robot.CancelOperationResponse>	cancelOperation(Robot.CancelOperationRequest request)
com.google.common.util.concurrent.ListenableFuture<Robot.DiscoverComponentsResponse>	discoverComponents(Robot.DiscoverComponentsRequest request)	DiscoverComponents returns the list of discovered component configurations.
com.google.common.util.concurrent.ListenableFuture<Robot.FrameSystemConfigResponse>	frameSystemConfig(Robot.FrameSystemConfigRequest request)
com.google.common.util.concurrent.ListenableFuture<Robot.GetCloudMetadataResponse>	getCloudMetadata(Robot.GetCloudMetadataRequest request)	GetCloudMetadata returns app-related information about the robot.
com.google.common.util.concurrent.ListenableFuture<Robot.GetMachineStatusResponse>	getMachineStatus(Robot.GetMachineStatusRequest request)	GetMachineStatus returns the current status of the robot.
com.google.common.util.concurrent.ListenableFuture<Robot.GetOperationsResponse>	getOperations(Robot.GetOperationsRequest request)
com.google.common.util.concurrent.ListenableFuture<Robot.GetSessionsResponse>	getSessions(Robot.GetSessionsRequest request)
com.google.common.util.concurrent.ListenableFuture<Robot.GetStatusResponse>	getStatus(Robot.GetStatusRequest request)	Deprecated.
com.google.common.util.concurrent.ListenableFuture<Robot.GetVersionResponse>	getVersion(Robot.GetVersionRequest request)	GetVersion returns version information about the robot.
com.google.common.util.concurrent.ListenableFuture<Robot.LogResponse>	log(Robot.LogRequest request)	Log sends logs to be logged by this robot.
com.google.common.util.concurrent.ListenableFuture<Robot.ResourceNamesResponse>	resourceNames(Robot.ResourceNamesRequest request)	ResourceNames returns the list of all resources.
com.google.common.util.concurrent.ListenableFuture<Robot.ResourceRPCSubtypesResponse>	resourceRPCSubtypes(Robot.ResourceRPCSubtypesRequest request)	ResourceRPCSubtypes returns the list of all resource types.
com.google.common.util.concurrent.ListenableFuture<Robot.RestartModuleResponse>	restartModule(Robot.RestartModuleRequest request)
com.google.common.util.concurrent.ListenableFuture<Robot.SendSessionHeartbeatResponse>	sendSessionHeartbeat(Robot.SendSessionHeartbeatRequest request)	SendSessionHeartbeat sends a heartbeat to the given session.
com.google.common.util.concurrent.ListenableFuture<Robot.ShutdownResponse>	shutdown(Robot.ShutdownRequest request)	Shutdown shuts down the robot.
com.google.common.util.concurrent.ListenableFuture<Robot.StartSessionResponse>	startSession(Robot.StartSessionRequest request)	StartSession creates a new session that expects at least one heartbeat within the returned window.
com.google.common.util.concurrent.ListenableFuture<Robot.StopAllResponse>	stopAll(Robot.StopAllRequest request)	StopAll will stop all current and outstanding operations for the robot and stops all actuators and movement
com.google.common.util.concurrent.ListenableFuture<Robot.TransformPCDResponse>	transformPCD(Robot.TransformPCDRequest request)
com.google.common.util.concurrent.ListenableFuture<Robot.TransformPoseResponse>	transformPose(Robot.TransformPoseRequest request)

Methods inherited from class io.grpc.stub.AbstractFutureStub

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

Specified by:

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

getOperations

public com.google.common.util.concurrent.ListenableFuture<Robot.GetOperationsResponse> getOperations(Robot.GetOperationsRequest request)

getSessions

public com.google.common.util.concurrent.ListenableFuture<Robot.GetSessionsResponse> getSessions(Robot.GetSessionsRequest request)

resourceNames

public com.google.common.util.concurrent.ListenableFuture<Robot.ResourceNamesResponse> resourceNames(Robot.ResourceNamesRequest request)

 ResourceNames returns the list of all resources.
 

resourceRPCSubtypes

public com.google.common.util.concurrent.ListenableFuture<Robot.ResourceRPCSubtypesResponse> resourceRPCSubtypes(Robot.ResourceRPCSubtypesRequest request)

 ResourceRPCSubtypes returns the list of all resource types.
 

cancelOperation

public com.google.common.util.concurrent.ListenableFuture<Robot.CancelOperationResponse> cancelOperation(Robot.CancelOperationRequest request)

blockForOperation

public com.google.common.util.concurrent.ListenableFuture<Robot.BlockForOperationResponse> blockForOperation(Robot.BlockForOperationRequest request)

discoverComponents

public com.google.common.util.concurrent.ListenableFuture<Robot.DiscoverComponentsResponse> discoverComponents(Robot.DiscoverComponentsRequest request)

 DiscoverComponents returns the list of discovered component configurations.
 

frameSystemConfig

public com.google.common.util.concurrent.ListenableFuture<Robot.FrameSystemConfigResponse> frameSystemConfig(Robot.FrameSystemConfigRequest request)

transformPose

public com.google.common.util.concurrent.ListenableFuture<Robot.TransformPoseResponse> transformPose(Robot.TransformPoseRequest request)

transformPCD

public com.google.common.util.concurrent.ListenableFuture<Robot.TransformPCDResponse> transformPCD(Robot.TransformPCDRequest request)

getStatus

@Deprecated
public com.google.common.util.concurrent.ListenableFuture<Robot.GetStatusResponse> getStatus(Robot.GetStatusRequest request)

Deprecated.

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

stopAll

public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<Robot.LogResponse> log(Robot.LogRequest request)

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

getCloudMetadata

public com.google.common.util.concurrent.ListenableFuture<Robot.GetCloudMetadataResponse> getCloudMetadata(Robot.GetCloudMetadataRequest request)

 GetCloudMetadata returns app-related information about the robot.
 

restartModule

public com.google.common.util.concurrent.ListenableFuture<Robot.RestartModuleResponse> restartModule(Robot.RestartModuleRequest request)

shutdown

public com.google.common.util.concurrent.ListenableFuture<Robot.ShutdownResponse> shutdown(Robot.ShutdownRequest request)

 Shutdown shuts down the robot.
 

getMachineStatus

public com.google.common.util.concurrent.ListenableFuture<Robot.GetMachineStatusResponse> getMachineStatus(Robot.GetMachineStatusRequest request)

 GetMachineStatus returns the current status of the robot.
 

getVersion

public com.google.common.util.concurrent.ListenableFuture<Robot.GetVersionResponse> getVersion(Robot.GetVersionRequest request)

 GetVersion returns version information about the robot.