Package com.viam.robot.v1

Interface Robot.PackageStatusOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getBytesDownloaded()
    number of bytes of the package tarball downloaded so far.
    String
    getError()
    human-readable error detail when state == STATE_FAILED
    com.google.protobuf.ByteString
    getErrorBytes()
    human-readable error detail when state == STATE_FAILED
    com.google.protobuf.Timestamp
    getLastUpdated()
    when this status was last updated
    String
    getName()
    the package name as declared in the robot config (PackageConfig.Name)
    com.google.protobuf.ByteString
    getNameBytes()
    the package name as declared in the robot config (PackageConfig.Name)
    Robot.PackageStatus.State
    getState()
    current lifecycle state
    int
    getStateValue()
    current lifecycle state
    long
    getTotalBytes()
    total size of the package tarball in bytes.
    Packages.PackageType
    getType()
    the package type (module, ml_model, slam_map, etc.)
    int
    getTypeValue()
    the package type (module, ml_model, slam_map, etc.)
    String
    getVersion()
    the version string from PackageConfig
    com.google.protobuf.ByteString
    getVersionBytes()
    the version string from PackageConfig
    boolean
    hasLastUpdated()
    when this status was last updated

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getName

      String getName()
       the package name as declared in the robot config (PackageConfig.Name)
      string name = 1 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       the package name as declared in the robot config (PackageConfig.Name)
      string name = 1 [json_name = "name"];
      Returns:
      The bytes for name.

    • getTypeValue

      int getTypeValue()
       the package type (module, ml_model, slam_map, etc.)
      .viam.app.packages.v1.PackageType type = 2 [json_name = "type"];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Packages.PackageType getType()
       the package type (module, ml_model, slam_map, etc.)
      .viam.app.packages.v1.PackageType type = 2 [json_name = "type"];
      Returns:
      The type.

    • getStateValue

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

    • getState

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

    • getError

      String getError()
       human-readable error detail when state == STATE_FAILED
      string error = 4 [json_name = "error"];
      Returns:
      The error.

    • getErrorBytes

      com.google.protobuf.ByteString getErrorBytes()
       human-readable error detail when state == STATE_FAILED
      string error = 4 [json_name = "error"];
      Returns:
      The bytes for error.

    • hasLastUpdated

      boolean hasLastUpdated()
       when this status was last updated
      .google.protobuf.Timestamp last_updated = 5 [json_name = "lastUpdated"];
      Returns:
      Whether the lastUpdated field is set.

    • getLastUpdated

      com.google.protobuf.Timestamp getLastUpdated()
       when this status was last updated
      .google.protobuf.Timestamp last_updated = 5 [json_name = "lastUpdated"];
      Returns:
      The lastUpdated.

    • getVersion

      String getVersion()
       the version string from PackageConfig
      string version = 6 [json_name = "version"];
      Returns:
      The version.

    • getVersionBytes

      com.google.protobuf.ByteString getVersionBytes()
       the version string from PackageConfig
      string version = 6 [json_name = "version"];
      Returns:
      The bytes for version.

    • getBytesDownloaded

      long getBytesDownloaded()
       number of bytes of the package tarball downloaded so far. Only populated
 while state == STATE_DOWNLOADING; equals total_bytes once the download completes.
      uint64 bytes_downloaded = 7 [json_name = "bytesDownloaded"];
      Returns:
      The bytesDownloaded.

    • getTotalBytes

      long getTotalBytes()
       total size of the package tarball in bytes. Zero if the size is unknown.
      uint64 total_bytes = 8 [json_name = "totalBytes"];
      Returns:
      The totalBytes.