Package com.viam.robot.v1

Class Robot.PackageStatus.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<Robot.PackageStatus,Robot.PackageStatus.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<Robot.PackageStatus,Robot.PackageStatus.Builder>
com.viam.robot.v1.Robot.PackageStatus.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Robot.PackageStatusOrBuilder, Cloneable
Enclosing class:
Robot.PackageStatus
public static final class Robot.PackageStatus.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Robot.PackageStatus,Robot.PackageStatus.Builder> implements Robot.PackageStatusOrBuilder
Protobuf type viam.robot.v1.PackageStatus

  • Method Details

    • getName

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

    • getNameBytes

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

    • setName

      public Robot.PackageStatus.Builder setName(String value)
       the package name as declared in the robot config (PackageConfig.Name)
      string name = 1 [json_name = "name"];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Robot.PackageStatus.Builder clearName()
       the package name as declared in the robot config (PackageConfig.Name)
      string name = 1 [json_name = "name"];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Robot.PackageStatus.Builder setNameBytes(com.google.protobuf.ByteString value)
       the package name as declared in the robot config (PackageConfig.Name)
      string name = 1 [json_name = "name"];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getTypeValue

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

    • setTypeValue

      public Robot.PackageStatus.Builder setTypeValue(int value)
       the package type (module, ml_model, slam_map, etc.)
      .viam.app.packages.v1.PackageType type = 2 [json_name = "type"];
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • getType

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

    • setType

      public Robot.PackageStatus.Builder setType(Packages.PackageType value)
       the package type (module, ml_model, slam_map, etc.)
      .viam.app.packages.v1.PackageType type = 2 [json_name = "type"];
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • clearType

      public Robot.PackageStatus.Builder clearType()
       the package type (module, ml_model, slam_map, etc.)
      .viam.app.packages.v1.PackageType type = 2 [json_name = "type"];
      Returns:
      This builder for chaining.

    • getStateValue

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

    • setStateValue

      public Robot.PackageStatus.Builder setStateValue(int value)
       current lifecycle state
      .viam.robot.v1.PackageStatus.State state = 3 [json_name = "state"];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • getState

      public Robot.PackageStatus.State getState()
       current lifecycle state
      .viam.robot.v1.PackageStatus.State state = 3 [json_name = "state"];
      Specified by:
      getState in interface Robot.PackageStatusOrBuilder
      Returns:
      The state.

    • setState

      public Robot.PackageStatus.Builder setState(Robot.PackageStatus.State value)
       current lifecycle state
      .viam.robot.v1.PackageStatus.State state = 3 [json_name = "state"];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • clearState

      public Robot.PackageStatus.Builder clearState()
       current lifecycle state
      .viam.robot.v1.PackageStatus.State state = 3 [json_name = "state"];
      Returns:
      This builder for chaining.

    • getError

      public String getError()
       human-readable error detail when state == STATE_FAILED
      string error = 4 [json_name = "error"];
      Specified by:
      getError in interface Robot.PackageStatusOrBuilder
      Returns:
      The error.

    • getErrorBytes

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

    • setError

      public Robot.PackageStatus.Builder setError(String value)
       human-readable error detail when state == STATE_FAILED
      string error = 4 [json_name = "error"];
      Parameters:
      value - The error to set.
      Returns:
      This builder for chaining.

    • clearError

      public Robot.PackageStatus.Builder clearError()
       human-readable error detail when state == STATE_FAILED
      string error = 4 [json_name = "error"];
      Returns:
      This builder for chaining.

    • setErrorBytes

      public Robot.PackageStatus.Builder setErrorBytes(com.google.protobuf.ByteString value)
       human-readable error detail when state == STATE_FAILED
      string error = 4 [json_name = "error"];
      Parameters:
      value - The bytes for error to set.
      Returns:
      This builder for chaining.

    • hasLastUpdated

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

    • getLastUpdated

      public com.google.protobuf.Timestamp getLastUpdated()
       when this status was last updated
      .google.protobuf.Timestamp last_updated = 5 [json_name = "lastUpdated"];
      Specified by:
      getLastUpdated in interface Robot.PackageStatusOrBuilder
      Returns:
      The lastUpdated.

    • setLastUpdated

      public Robot.PackageStatus.Builder setLastUpdated(com.google.protobuf.Timestamp value)
       when this status was last updated
      .google.protobuf.Timestamp last_updated = 5 [json_name = "lastUpdated"];

    • setLastUpdated

      public Robot.PackageStatus.Builder setLastUpdated(com.google.protobuf.Timestamp.Builder builderForValue)
       when this status was last updated
      .google.protobuf.Timestamp last_updated = 5 [json_name = "lastUpdated"];

    • mergeLastUpdated

      public Robot.PackageStatus.Builder mergeLastUpdated(com.google.protobuf.Timestamp value)
       when this status was last updated
      .google.protobuf.Timestamp last_updated = 5 [json_name = "lastUpdated"];

    • clearLastUpdated

      public Robot.PackageStatus.Builder clearLastUpdated()
       when this status was last updated
      .google.protobuf.Timestamp last_updated = 5 [json_name = "lastUpdated"];

    • getVersion

      public String getVersion()
       the version string from PackageConfig
      string version = 6 [json_name = "version"];
      Specified by:
      getVersion in interface Robot.PackageStatusOrBuilder
      Returns:
      The version.

    • getVersionBytes

      public com.google.protobuf.ByteString getVersionBytes()
       the version string from PackageConfig
      string version = 6 [json_name = "version"];
      Specified by:
      getVersionBytes in interface Robot.PackageStatusOrBuilder
      Returns:
      The bytes for version.

    • setVersion

      public Robot.PackageStatus.Builder setVersion(String value)
       the version string from PackageConfig
      string version = 6 [json_name = "version"];
      Parameters:
      value - The version to set.
      Returns:
      This builder for chaining.

    • clearVersion

      public Robot.PackageStatus.Builder clearVersion()
       the version string from PackageConfig
      string version = 6 [json_name = "version"];
      Returns:
      This builder for chaining.

    • setVersionBytes

      public Robot.PackageStatus.Builder setVersionBytes(com.google.protobuf.ByteString value)
       the version string from PackageConfig
      string version = 6 [json_name = "version"];
      Parameters:
      value - The bytes for version to set.
      Returns:
      This builder for chaining.

    • getBytesDownloaded

      public 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"];
      Specified by:
      getBytesDownloaded in interface Robot.PackageStatusOrBuilder
      Returns:
      The bytesDownloaded.

    • setBytesDownloaded

      public Robot.PackageStatus.Builder setBytesDownloaded(long value)
       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"];
      Parameters:
      value - The bytesDownloaded to set.
      Returns:
      This builder for chaining.

    • clearBytesDownloaded

      public Robot.PackageStatus.Builder clearBytesDownloaded()
       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:
      This builder for chaining.

    • getTotalBytes

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

    • setTotalBytes

      public Robot.PackageStatus.Builder setTotalBytes(long value)
       total size of the package tarball in bytes. Zero if the size is unknown.
      uint64 total_bytes = 8 [json_name = "totalBytes"];
      Parameters:
      value - The totalBytes to set.
      Returns:
      This builder for chaining.

    • clearTotalBytes

      public Robot.PackageStatus.Builder clearTotalBytes()
       total size of the package tarball in bytes. Zero if the size is unknown.
      uint64 total_bytes = 8 [json_name = "totalBytes"];
      Returns:
      This builder for chaining.