Package com.google.bytestream

Interface ByteStreamProto.WriteRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
ByteStreamProto.WriteRequest, ByteStreamProto.WriteRequest.Builder
Enclosing class:
ByteStreamProto
public static interface ByteStreamProto.WriteRequestOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.ByteString
    getData()
    A portion of the data for the resource.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getResourceName

      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"];
      Returns:
      The resourceName.

    • getResourceNameBytes

      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"];
      Returns:
      The bytes for resourceName.

    • getWriteOffset

      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"];
      Returns:
      The writeOffset.

    • getFinishWrite

      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"];
      Returns:
      The finishWrite.

    • getData

      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"];
      Returns:
      The data.