Package com.viam.robot.v1

Interface Robot.ResourceStatusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Robot.ResourceStatus, Robot.ResourceStatus.Builder
Enclosing class:
Robot
public static interface Robot.ResourceStatusOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Robot.GetCloudMetadataResponse
    getCloudMetadata()
    infomation about resource orgID, locationID and partID
    String
    getError()
    error details for a resource.
    com.google.protobuf.ByteString
    getErrorBytes()
    error details for a resource.
    com.google.protobuf.Timestamp
    getLastUpdated()
    state transition timestamp.
    Common.ResourceName
    getName()
    resource name.
    Robot.ResourceStatus.Reachability
    getReachability()
    whether calls to this resource by name can be routed through this machine.
    int
    getReachabilityValue()
    whether calls to this resource by name can be routed through this machine.
    String
    getRemote()
    name of the remote, as configured on this machine, that this resource is reached through; for a resource on a remote's remote, this is the first hop.
    com.google.protobuf.ByteString
    getRemoteBytes()
    name of the remote, as configured on this machine, that this resource is reached through; for a resource on a remote's remote, this is the first hop.
    String
    getRevision()
    revision of the last config that successfully updated this resource.
    com.google.protobuf.ByteString
    getRevisionBytes()
    revision of the last config that successfully updated this resource.
    Robot.ResourceStatus.State
    getState()
    current state.
    int
    getStateValue()
    current state.
    boolean
    hasCloudMetadata()
    infomation about resource orgID, locationID and partID
    boolean
    hasLastUpdated()
    state transition timestamp.
    boolean
    hasName()
    resource name.
    boolean
    hasRemote()
    name of the remote, as configured on this machine, that this resource is reached through; for a resource on a remote's remote, this is the first hop.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasName

      boolean hasName()
       resource name.
      .viam.common.v1.ResourceName name = 1 [json_name = "name"];
      Returns:
      Whether the name field is set.

    • getName

      Common.ResourceName getName()
       resource name.
      .viam.common.v1.ResourceName name = 1 [json_name = "name"];
      Returns:
      The name.

    • getStateValue

      int getStateValue()
       current state.
      .viam.robot.v1.ResourceStatus.State state = 2 [json_name = "state"];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Robot.ResourceStatus.State getState()
       current state.
      .viam.robot.v1.ResourceStatus.State state = 2 [json_name = "state"];
      Returns:
      The state.

    • hasLastUpdated

      boolean hasLastUpdated()
       state transition timestamp.
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];
      Returns:
      Whether the lastUpdated field is set.

    • getLastUpdated

      com.google.protobuf.Timestamp getLastUpdated()
       state transition timestamp.
      .google.protobuf.Timestamp last_updated = 3 [json_name = "lastUpdated"];
      Returns:
      The lastUpdated.

    • getRevision

      String getRevision()
       revision of the last config that successfully updated this resource.
      string revision = 4 [json_name = "revision"];
      Returns:
      The revision.

    • getRevisionBytes

      com.google.protobuf.ByteString getRevisionBytes()
       revision of the last config that successfully updated this resource.
      string revision = 4 [json_name = "revision"];
      Returns:
      The bytes for revision.

    • getError

      String getError()
       error details for a resource. This is guaranteed to be null if the
 resource is ready and non-null if the resource unhealthy.
      string error = 5 [json_name = "error"];
      Returns:
      The error.

    • getErrorBytes

      com.google.protobuf.ByteString getErrorBytes()
       error details for a resource. This is guaranteed to be null if the
 resource is ready and non-null if the resource unhealthy.
      string error = 5 [json_name = "error"];
      Returns:
      The bytes for error.

    • hasCloudMetadata

      boolean hasCloudMetadata()
       infomation about resource orgID, locationID and partID
      optional .viam.robot.v1.GetCloudMetadataResponse cloud_metadata = 6 [json_name = "cloudMetadata"];
      Returns:
      Whether the cloudMetadata field is set.

    • getCloudMetadata

      Robot.GetCloudMetadataResponse getCloudMetadata()
       infomation about resource orgID, locationID and partID
      optional .viam.robot.v1.GetCloudMetadataResponse cloud_metadata = 6 [json_name = "cloudMetadata"];
      Returns:
      The cloudMetadata.

    • getReachabilityValue

      int getReachabilityValue()
       whether calls to this resource by name can be routed through this machine.
      .viam.robot.v1.ResourceStatus.Reachability reachability = 7 [json_name = "reachability"];
      Returns:
      The enum numeric value on the wire for reachability.

    • getReachability

      Robot.ResourceStatus.Reachability getReachability()
       whether calls to this resource by name can be routed through this machine.
      .viam.robot.v1.ResourceStatus.Reachability reachability = 7 [json_name = "reachability"];
      Returns:
      The reachability.

    • hasRemote

      boolean hasRemote()
       name of the remote, as configured on this machine, that this resource is reached through;
 for a resource on a remote's remote, this is the first hop. Unset for local resources.
      optional string remote = 8 [json_name = "remote"];
      Returns:
      Whether the remote field is set.

    • getRemote

      String getRemote()
       name of the remote, as configured on this machine, that this resource is reached through;
 for a resource on a remote's remote, this is the first hop. Unset for local resources.
      optional string remote = 8 [json_name = "remote"];
      Returns:
      The remote.

    • getRemoteBytes

      com.google.protobuf.ByteString getRemoteBytes()
       name of the remote, as configured on this machine, that this resource is reached through;
 for a resource on a remote's remote, this is the first hop. Unset for local resources.
      optional string remote = 8 [json_name = "remote"];
      Returns:
      The bytes for remote.