Package com.google.storage.v2

Interface ReadRangeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReadRange, ReadRange.Builder
public interface ReadRangeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getReadId()
    Required.
    long
    getReadLength()
    Optional.
    long
    getReadOffset()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getReadOffset

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

 A negative read_offset value will be interpreted as the number of bytes
 back from the end of the object to be returned. For example, if an object's
 length is 15 bytes, a ReadObjectRequest with read_offset = -5 and
 read_length = 3 would return bytes 10 through 12 of the object. Requesting
 a negative offset with magnitude larger than the size of the object will
 return the entire object. A read_offset larger than the size of the object
 will result in an OutOfRange error.
      int64 read_offset = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The readOffset.

    • getReadLength

      long getReadLength()
       Optional. The maximum number of data bytes the server is allowed to return
 across all response messages with the same read_id. A read_length of zero
 indicates to read until the resource end, and a negative read_length will
 cause an error. If the stream returns fewer bytes than allowed by the
 read_length and no error occurred, the stream includes all data from the
 read_offset to the resource end.
      int64 read_length = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The readLength.

    • getReadId

      long getReadId()
       Required. Read identifier provided by the client. When the client issues
 more than one outstanding ReadRange on the same stream, responses can be
 mapped back to their corresponding requests using this value. Clients must
 ensure that all outstanding requests have different read_id values. The
 server may close the stream with an error if this condition is not met.
      int64 read_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The readId.