Package com.google.bytestream

Class ByteStreamProto.WriteRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<ByteStreamProto.WriteRequest,ByteStreamProto.WriteRequest.Builder>
com.google.bytestream.ByteStreamProto.WriteRequest
All Implemented Interfaces:
ByteStreamProto.WriteRequestOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
Enclosing class:
ByteStreamProto
public static final class ByteStreamProto.WriteRequest extends com.google.protobuf.GeneratedMessageLite<ByteStreamProto.WriteRequest,ByteStreamProto.WriteRequest.Builder> implements ByteStreamProto.WriteRequestOrBuilder
 Request object for ByteStream.Write.
Protobuf type google.bytestream.WriteRequest

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ByteStreamProto.WriteRequest.Builder
    Request object for ByteStream.Write.

    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
    FINISH_WRITE_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    WRITE_OFFSET_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()
    A portion of the data for the resource.
    static ByteStreamProto.WriteRequest
    getDefaultInstance()
     
    boolean
    getFinishWrite()
    If `true`, this indicates that the write is complete.
    String
    getResourceName()
    The name of the resource to write.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    The name of the resource to write.
    long
    getWriteOffset()
    The offset from the beginning of the resource at which the data should be written.
    static ByteStreamProto.WriteRequest.Builder
    newBuilder()
     
    static ByteStreamProto.WriteRequest.Builder
    newBuilder(ByteStreamProto.WriteRequest prototype)
     
    static ByteStreamProto.WriteRequest
    parseDelimitedFrom(InputStream input)
     
    static ByteStreamProto.WriteRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ByteStreamProto.WriteRequest
    parseFrom(byte[] data)
     
    static ByteStreamProto.WriteRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ByteStreamProto.WriteRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ByteStreamProto.WriteRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ByteStreamProto.WriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ByteStreamProto.WriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ByteStreamProto.WriteRequest
    parseFrom(InputStream input)
     
    static ByteStreamProto.WriteRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ByteStreamProto.WriteRequest
    parseFrom(ByteBuffer data)
     
    static ByteStreamProto.WriteRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ByteStreamProto.WriteRequest>
    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

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • WRITE_OFFSET_FIELD_NUMBER

      public static final int WRITE_OFFSET_FIELD_NUMBER
      See Also:

    • FINISH_WRITE_FIELD_NUMBER

      public static final int FINISH_WRITE_FIELD_NUMBER
      See Also:

    • DATA_FIELD_NUMBER

      public static final int DATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getResourceName

      public String getResourceName()
       The name of the resource to write. This **must** be set on the first
 `WriteRequest` of each `Write()` action. If it is set on subsequent calls,
 it **must** match the value of the first request.
      string resource_name = 1 [json_name = "resourceName"];
      Specified by:
      getResourceName in interface ByteStreamProto.WriteRequestOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       The name of the resource to write. This **must** be set on the first
 `WriteRequest` of each `Write()` action. If it is set on subsequent calls,
 it **must** match the value of the first request.
      string resource_name = 1 [json_name = "resourceName"];
      Specified by:
      getResourceNameBytes in interface ByteStreamProto.WriteRequestOrBuilder
      Returns:
      The bytes for resourceName.

    • getWriteOffset

      public long getWriteOffset()
       The offset from the beginning of the resource at which the data should be
 written. It is required on all `WriteRequest`s.

 In the first `WriteRequest` of a `Write()` action, it indicates
 the initial offset for the `Write()` call. The value **must** be equal to
 the `committed_size` that a call to `QueryWriteStatus()` would return.

 On subsequent calls, this value **must** be set and **must** be equal to
 the sum of the first `write_offset` and the sizes of all `data` bundles
 sent previously on this stream.

 An incorrect value will cause an error.
      int64 write_offset = 2 [json_name = "writeOffset"];
      Specified by:
      getWriteOffset in interface ByteStreamProto.WriteRequestOrBuilder
      Returns:
      The writeOffset.

    • getFinishWrite

      public boolean getFinishWrite()
       If `true`, this indicates that the write is complete. Sending any
 `WriteRequest`s subsequent to one in which `finish_write` is `true` will
 cause an error.
      bool finish_write = 3 [json_name = "finishWrite"];
      Specified by:
      getFinishWrite in interface ByteStreamProto.WriteRequestOrBuilder
      Returns:
      The finishWrite.

    • getData

      public com.google.protobuf.ByteString getData()
       A portion of the data for the resource. The client **may** leave `data`
 empty for any given `WriteRequest`. This enables the client to inform the
 service that the request is still live while it is running an operation to
 generate more data.
      bytes data = 10 [json_name = "data"];
      Specified by:
      getData in interface ByteStreamProto.WriteRequestOrBuilder
      Returns:
      The data.

    • parseFrom

      public static ByteStreamProto.WriteRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ByteStreamProto.WriteRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ByteStreamProto.WriteRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ByteStreamProto.WriteRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ByteStreamProto.WriteRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilder

      public static ByteStreamProto.WriteRequest.Builder newBuilder()

    • newBuilder

      public static ByteStreamProto.WriteRequest.Builder newBuilder(ByteStreamProto.WriteRequest 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<ByteStreamProto.WriteRequest,ByteStreamProto.WriteRequest.Builder>

    • getDefaultInstance

      public static ByteStreamProto.WriteRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ByteStreamProto.WriteRequest> parser()