Package com.google.storage.v2

Interface ReadObjectRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBucket()
    Required.
    com.google.protobuf.ByteString
    getBucketBytes()
    Required.
    CommonObjectRequestParams
    getCommonObjectRequestParams()
    A set of parameters common to Storage API requests concerning an object.
    CommonObjectRequestParamsOrBuilder
    getCommonObjectRequestParamsOrBuilder()
    A set of parameters common to Storage API requests concerning an object.
    long
    getGeneration()
    If present, selects a specific revision of this object (as opposed to the latest version, the default).
    long
    getIfGenerationMatch()
    Makes the operation conditional on whether the object's current generation matches the given value.
    long
    getIfGenerationNotMatch()
    Makes the operation conditional on whether the object's live generation does not match the given value.
    long
    getIfMetagenerationMatch()
    Makes the operation conditional on whether the object's current metageneration matches the given value.
    long
    getIfMetagenerationNotMatch()
    Makes the operation conditional on whether the object's current metageneration does not match the given value.
    String
    getObject()
    Required.
    com.google.protobuf.ByteString
    getObjectBytes()
    Required.
    long
    getReadLimit()
    The maximum number of `data` bytes the server is allowed to return in the sum of all `Object` messages.
    com.google.protobuf.FieldMask
    getReadMask()
    Mask specifying which fields to read.
    com.google.protobuf.FieldMaskOrBuilder
    getReadMaskOrBuilder()
    Mask specifying which fields to read.
    long
    getReadOffset()
    The offset for the first byte to return in the read, relative to the start of the object.
    boolean
    hasCommonObjectRequestParams()
    A set of parameters common to Storage API requests concerning an object.
    boolean
    hasIfGenerationMatch()
    Makes the operation conditional on whether the object's current generation matches the given value.
    boolean
    hasIfGenerationNotMatch()
    Makes the operation conditional on whether the object's live generation does not match the given value.
    boolean
    hasIfMetagenerationMatch()
    Makes the operation conditional on whether the object's current metageneration matches the given value.
    boolean
    hasIfMetagenerationNotMatch()
    Makes the operation conditional on whether the object's current metageneration does not match the given value.
    boolean
    hasReadMask()
    Mask specifying which fields to read.

    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

    • getBucket

      String getBucket()
       Required. The name of the bucket containing the object to read.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bucket.

    • getBucketBytes

      com.google.protobuf.ByteString getBucketBytes()
       Required. The name of the bucket containing the object to read.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for bucket.

    • getObject

      String getObject()
       Required. The name of the object to read.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The object.

    • getObjectBytes

      com.google.protobuf.ByteString getObjectBytes()
       Required. The name of the object to read.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for object.

    • getGeneration

      long getGeneration()
       If present, selects a specific revision of this object (as opposed
 to the latest version, the default).
      int64 generation = 3;
      Returns:
      The generation.

    • getReadOffset

      long getReadOffset()
       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_limit` = 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.
      int64 read_offset = 4;
      Returns:
      The readOffset.

    • getReadLimit

      long getReadLimit()
       The maximum number of `data` bytes the server is allowed to return in the
 sum of all `Object` 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 = 5;
      Returns:
      The readLimit.

    • hasIfGenerationMatch

      boolean hasIfGenerationMatch()
       Makes the operation conditional on whether the object's current generation
 matches the given value. Setting to 0 makes the operation succeed only if
 there are no live versions of the object.
      optional int64 if_generation_match = 6;
      Returns:
      Whether the ifGenerationMatch field is set.

    • getIfGenerationMatch

      long getIfGenerationMatch()
       Makes the operation conditional on whether the object's current generation
 matches the given value. Setting to 0 makes the operation succeed only if
 there are no live versions of the object.
      optional int64 if_generation_match = 6;
      Returns:
      The ifGenerationMatch.

    • hasIfGenerationNotMatch

      boolean hasIfGenerationNotMatch()
       Makes the operation conditional on whether the object's live generation
 does not match the given value. If no live object exists, the precondition
 fails. Setting to 0 makes the operation succeed only if there is a live
 version of the object.
      optional int64 if_generation_not_match = 7;
      Returns:
      Whether the ifGenerationNotMatch field is set.

    • getIfGenerationNotMatch

      long getIfGenerationNotMatch()
       Makes the operation conditional on whether the object's live generation
 does not match the given value. If no live object exists, the precondition
 fails. Setting to 0 makes the operation succeed only if there is a live
 version of the object.
      optional int64 if_generation_not_match = 7;
      Returns:
      The ifGenerationNotMatch.

    • hasIfMetagenerationMatch

      boolean hasIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 8;
      Returns:
      Whether the ifMetagenerationMatch field is set.

    • getIfMetagenerationMatch

      long getIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 8;
      Returns:
      The ifMetagenerationMatch.

    • hasIfMetagenerationNotMatch

      boolean hasIfMetagenerationNotMatch()
       Makes the operation conditional on whether the object's current
 metageneration does not match the given value.
      optional int64 if_metageneration_not_match = 9;
      Returns:
      Whether the ifMetagenerationNotMatch field is set.

    • getIfMetagenerationNotMatch

      long getIfMetagenerationNotMatch()
       Makes the operation conditional on whether the object's current
 metageneration does not match the given value.
      optional int64 if_metageneration_not_match = 9;
      Returns:
      The ifMetagenerationNotMatch.

    • hasCommonObjectRequestParams

      boolean hasCommonObjectRequestParams()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
      Returns:
      Whether the commonObjectRequestParams field is set.

    • getCommonObjectRequestParams

      CommonObjectRequestParams getCommonObjectRequestParams()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
      Returns:
      The commonObjectRequestParams.

    • getCommonObjectRequestParamsOrBuilder

      CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

    • hasReadMask

      boolean hasReadMask()
       Mask specifying which fields to read.
 The checksummed_data field and its children will always be present.
 If no mask is specified, will default to all fields except metadata.owner
 and metadata.acl.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 12;
      Returns:
      Whether the readMask field is set.

    • getReadMask

      com.google.protobuf.FieldMask getReadMask()
       Mask specifying which fields to read.
 The checksummed_data field and its children will always be present.
 If no mask is specified, will default to all fields except metadata.owner
 and metadata.acl.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 12;
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Mask specifying which fields to read.
 The checksummed_data field and its children will always be present.
 If no mask is specified, will default to all fields except metadata.owner
 and metadata.acl.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 12;