Package com.viam.service.shell.v1

Class Shell.FileData

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Shell.FileData,Shell.FileData.Builder>
com.viam.service.shell.v1.Shell.FileData
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, Shell.FileDataOrBuilder
Enclosing class:
Shell
public static final class Shell.FileData extends com.google.protobuf.GeneratedMessageLite<Shell.FileData,Shell.FileData.Builder> implements Shell.FileDataOrBuilder
 FileData contains partial (sometimes complete) information about a File.
 When transmitting FileData with CopyFilesToMachine and CopyFilesFromMachine,
 it MUST initially contain its name, size, and is_dir. Depending on whether
 preservation is in use, the mod_time and mode fields may be initially set
 as well. On all transmissions, data and eof must be set. Because files are
 sent one-by-one, it is currently permitted to exclude the initially set fields.
 If this ever changes, a new scheme should be used for identifying files (like a number)
 in order to reduce data transmission while allowing out-of-order transfers.
 eof must be true and its own message once no more data is to be sent for this file.
Protobuf type viam.service.shell.v1.FileData

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Shell.FileData.Builder
    FileData contains partial (sometimes complete) information about a File.

    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 extends Object>, 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
    DATA_FIELD_NUMBER
     
    static final int
    EOF_FIELD_NUMBER
     
    static final int
    IS_DIR_FIELD_NUMBER
     
    static final int
    MOD_TIME_FIELD_NUMBER
     
    static final int
    MODE_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    SIZE_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)
     
    com.google.protobuf.ByteString
    getData()
    bytes data = 4 [json_name = "data"];
    static Shell.FileData
    getDefaultInstance()
     
    boolean
    getEof()
    bool eof = 5 [json_name = "eof"];
    boolean
    getIsDir()
    bool is_dir = 3 [json_name = "isDir"];
    int
    getMode()
    optional uint32 mode = 7 [json_name = "mode"];
    com.google.protobuf.Timestamp
    getModTime()
    Note(erd): maybe support access time in the future if needed
    String
    getName()
    string name = 1 [json_name = "name"];
    com.google.protobuf.ByteString
    getNameBytes()
    string name = 1 [json_name = "name"];
    long
    getSize()
    int64 size = 2 [json_name = "size"];
    boolean
    hasMode()
    optional uint32 mode = 7 [json_name = "mode"];
    boolean
    hasModTime()
    Note(erd): maybe support access time in the future if needed
    static Shell.FileData.Builder
    newBuilder()
     
    static Shell.FileData.Builder
    newBuilder(Shell.FileData prototype)
     
    static Shell.FileData
    parseDelimitedFrom(InputStream input)
     
    static Shell.FileData
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Shell.FileData
    parseFrom(byte[] data)
     
    static Shell.FileData
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Shell.FileData
    parseFrom(com.google.protobuf.ByteString data)
     
    static Shell.FileData
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Shell.FileData
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Shell.FileData
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Shell.FileData
    parseFrom(InputStream input)
     
    static Shell.FileData
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Shell.FileData
    parseFrom(ByteBuffer data)
     
    static Shell.FileData
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Shell.FileData>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, 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()
      string name = 1 [json_name = "name"];
      Specified by:
      getName in interface Shell.FileDataOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      string name = 1 [json_name = "name"];
      Specified by:
      getNameBytes in interface Shell.FileDataOrBuilder
      Returns:
      The bytes for name.

    • getSize

      public long getSize()
      int64 size = 2 [json_name = "size"];
      Specified by:
      getSize in interface Shell.FileDataOrBuilder
      Returns:
      The size.

    • getIsDir

      public boolean getIsDir()
      bool is_dir = 3 [json_name = "isDir"];
      Specified by:
      getIsDir in interface Shell.FileDataOrBuilder
      Returns:
      The isDir.

    • getData

      public com.google.protobuf.ByteString getData()
      bytes data = 4 [json_name = "data"];
      Specified by:
      getData in interface Shell.FileDataOrBuilder
      Returns:
      The data.

    • getEof

      public boolean getEof()
      bool eof = 5 [json_name = "eof"];
      Specified by:
      getEof in interface Shell.FileDataOrBuilder
      Returns:
      The eof.

    • hasModTime

      public boolean hasModTime()
       Note(erd): maybe support access time in the future if needed
      optional .google.protobuf.Timestamp mod_time = 6 [json_name = "modTime"];
      Specified by:
      hasModTime in interface Shell.FileDataOrBuilder
      Returns:
      Whether the modTime field is set.

    • getModTime

      public com.google.protobuf.Timestamp getModTime()
       Note(erd): maybe support access time in the future if needed
      optional .google.protobuf.Timestamp mod_time = 6 [json_name = "modTime"];
      Specified by:
      getModTime in interface Shell.FileDataOrBuilder
      Returns:
      The modTime.

    • hasMode

      public boolean hasMode()
      optional uint32 mode = 7 [json_name = "mode"];
      Specified by:
      hasMode in interface Shell.FileDataOrBuilder
      Returns:
      Whether the mode field is set.

    • getMode

      public int getMode()
      optional uint32 mode = 7 [json_name = "mode"];
      Specified by:
      getMode in interface Shell.FileDataOrBuilder
      Returns:
      The mode.

    • parseFrom

      public static Shell.FileData parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Shell.FileData parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Shell.FileData parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Shell.FileData parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Shell.FileData parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilder

      public static Shell.FileData.Builder newBuilder()

    • newBuilder

      public static Shell.FileData.Builder newBuilder(Shell.FileData 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<Shell.FileData,Shell.FileData.Builder>

    • getDefaultInstance

      public static Shell.FileData getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Shell.FileData> parser()