Package com.google.bytestream

Interface ByteStreamProto.ReadRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getReadLimit()
    The maximum number of `data` bytes the server is allowed to return in the sum of all `ReadResponse` messages.
    long
    getReadOffset()
    The offset for the first byte to return in the read, relative to the start of the resource.
    String
    getResourceName()
    The name of the resource to read.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    The name of the resource to read.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getResourceName

      String getResourceName()
       The name of the resource to read.
      string resource_name = 1 [json_name = "resourceName"];
      Returns:
      The resourceName.

    • getResourceNameBytes

      com.google.protobuf.ByteString getResourceNameBytes()
       The name of the resource to read.
      string resource_name = 1 [json_name = "resourceName"];
      Returns:
      The bytes for resourceName.

    • getReadOffset

      long getReadOffset()
       The offset for the first byte to return in the read, relative to the start
 of the resource.

 A `read_offset` that is negative or greater than the size of the resource
 will cause an `OUT_OF_RANGE` error.
      int64 read_offset = 2 [json_name = "readOffset"];
      Returns:
      The readOffset.

    • getReadLimit

      long getReadLimit()
       The maximum number of `data` bytes the server is allowed to return in the
 sum of all `ReadResponse` messages. A `read_limit` of zero indicates that
 there is no limit, and a negative `read_limit` will cause an error.

 If the stream returns fewer bytes than allowed by the `read_limit` and no
 error occurred, the stream includes all data from the `read_offset` to the
 end of the resource.
      int64 read_limit = 3 [json_name = "readLimit"];
      Returns:
      The readLimit.