Package com.google.storage.v2

Interface BidiReadObjectSpecOrBuilder

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

  • 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()
       Optional. If present, selects a specific revision of this object (as
 opposed to the latest version, the default).
      int64 generation = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The generation.

    • 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 = 4;
      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 = 4;
      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 = 5;
      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 = 5;
      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 = 6;
      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 = 6;
      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 = 7;
      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 = 7;
      Returns:
      The ifMetagenerationNotMatch.

    • hasCommonObjectRequestParams

      boolean hasCommonObjectRequestParams()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the commonObjectRequestParams field is set.

    • getCommonObjectRequestParams

      CommonObjectRequestParams getCommonObjectRequestParams()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The commonObjectRequestParams.

    • getCommonObjectRequestParamsOrBuilder

      CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];

    • hasReadMask

      @Deprecated boolean hasReadMask()
      Deprecated.
      google.storage.v2.BidiReadObjectSpec.read_mask is deprecated. See google/storage/v2/storage.proto;l=1027
       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".
 As per https://google.aip.dev/161, this field is deprecated.
 As an alternative, grpc metadata can be used:
 https://cloud.google.com/apis/docs/system-parameters#definitions
      optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
      Returns:
      Whether the readMask field is set.

    • getReadMask

      @Deprecated com.google.protobuf.FieldMask getReadMask()
      Deprecated.
      google.storage.v2.BidiReadObjectSpec.read_mask is deprecated. See google/storage/v2/storage.proto;l=1027
       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".
 As per https://google.aip.dev/161, this field is deprecated.
 As an alternative, grpc metadata can be used:
 https://cloud.google.com/apis/docs/system-parameters#definitions
      optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      @Deprecated com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
      Deprecated.
       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".
 As per https://google.aip.dev/161, this field is deprecated.
 As an alternative, grpc metadata can be used:
 https://cloud.google.com/apis/docs/system-parameters#definitions
      optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];

    • hasReadHandle

      boolean hasReadHandle()
       The client can optionally set this field. The read handle is an optimized
 way of creating new streams. Read handles are generated and periodically
 refreshed from prior reads.
      optional .google.storage.v2.BidiReadHandle read_handle = 13;
      Returns:
      Whether the readHandle field is set.

    • getReadHandle

      BidiReadHandle getReadHandle()
       The client can optionally set this field. The read handle is an optimized
 way of creating new streams. Read handles are generated and periodically
 refreshed from prior reads.
      optional .google.storage.v2.BidiReadHandle read_handle = 13;
      Returns:
      The readHandle.

    • getReadHandleOrBuilder

      BidiReadHandleOrBuilder getReadHandleOrBuilder()
       The client can optionally set this field. The read handle is an optimized
 way of creating new streams. Read handles are generated and periodically
 refreshed from prior reads.
      optional .google.storage.v2.BidiReadHandle read_handle = 13;

    • hasRoutingToken

      boolean hasRoutingToken()
       The routing token that influences request routing for the stream. Must be
 provided if a BidiReadObjectRedirectedError is returned.
      optional string routing_token = 14;
      Returns:
      Whether the routingToken field is set.

    • getRoutingToken

      String getRoutingToken()
       The routing token that influences request routing for the stream. Must be
 provided if a BidiReadObjectRedirectedError is returned.
      optional string routing_token = 14;
      Returns:
      The routingToken.

    • getRoutingTokenBytes

      com.google.protobuf.ByteString getRoutingTokenBytes()
       The routing token that influences request routing for the stream. Must be
 provided if a BidiReadObjectRedirectedError is returned.
      optional string routing_token = 14;
      Returns:
      The bytes for routingToken.