Package com.viam.robot.v1

Class Robot.PackageStatus

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Robot.PackageStatus.Builder
    Protobuf type viam.robot.v1.PackageStatus
    static enum 
    Robot.PackageStatus.State
    Protobuf enum viam.robot.v1.PackageStatus.State

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BYTES_DOWNLOADED_FIELD_NUMBER
     
    static final int
    ERROR_FIELD_NUMBER
     
    static final int
    LAST_UPDATED_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     
    static final int
    TOTAL_BYTES_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     
    static final int
    VERSION_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    long
    getBytesDownloaded()
    number of bytes of the package tarball downloaded so far.
    static Robot.PackageStatus
    getDefaultInstance()
     
    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
    static Robot.PackageStatus.Builder
    newBuilder()
     
    static Robot.PackageStatus.Builder
    newBuilder(Robot.PackageStatus prototype)
     
    static Robot.PackageStatus
    parseDelimitedFrom(InputStream input)
     
    static Robot.PackageStatus
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.PackageStatus
    parseFrom(byte[] data)
     
    static Robot.PackageStatus
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.PackageStatus
    parseFrom(com.google.protobuf.ByteString data)
     
    static Robot.PackageStatus
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.PackageStatus
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Robot.PackageStatus
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.PackageStatus
    parseFrom(InputStream input)
     
    static Robot.PackageStatus
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Robot.PackageStatus
    parseFrom(ByteBuffer data)
     
    static Robot.PackageStatus
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Robot.PackageStatus>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • parseFrom

      public static Robot.PackageStatus parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Robot.PackageStatus parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Robot.PackageStatus parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Robot.PackageStatus parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Robot.PackageStatus parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Robot.PackageStatus parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Robot.PackageStatus parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Robot.PackageStatus parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Robot.PackageStatus parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Robot.PackageStatus parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Robot.PackageStatus parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Robot.PackageStatus parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static Robot.PackageStatus.Builder newBuilder()

    • newBuilder

      public static Robot.PackageStatus.Builder newBuilder(Robot.PackageStatus prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<Robot.PackageStatus,Robot.PackageStatus.Builder>

    • getDefaultInstance

      public static Robot.PackageStatus getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Robot.PackageStatus> parser()