Package com.google.storage.v2

Interface RewriteObjectRequestOrBuilder

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

  • Method Details

    • getDestinationName

      String getDestinationName()
       Required. Immutable. The name of the destination object.
 See the
 [Naming Guidelines](https://cloud.google.com/storage/docs/objects#naming).
 Example: `test.txt`
 The `name` field by itself does not uniquely identify a Cloud Storage
 object. A Cloud Storage object is uniquely identified by the tuple of
 (bucket, object, generation).
      string destination_name = 24 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The destinationName.

    • getDestinationNameBytes

      com.google.protobuf.ByteString getDestinationNameBytes()
       Required. Immutable. The name of the destination object.
 See the
 [Naming Guidelines](https://cloud.google.com/storage/docs/objects#naming).
 Example: `test.txt`
 The `name` field by itself does not uniquely identify a Cloud Storage
 object. A Cloud Storage object is uniquely identified by the tuple of
 (bucket, object, generation).
      string destination_name = 24 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for destinationName.

    • getDestinationBucket

      String getDestinationBucket()
       Required. Immutable. The name of the bucket containing the destination
 object.
      string destination_bucket = 25 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The destinationBucket.

    • getDestinationBucketBytes

      com.google.protobuf.ByteString getDestinationBucketBytes()
       Required. Immutable. The name of the bucket containing the destination
 object.
      string destination_bucket = 25 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for destinationBucket.

    • getDestinationKmsKey

      String getDestinationKmsKey()
       The name of the Cloud KMS key that will be used to encrypt the destination
 object. The Cloud KMS key must be located in same location as the object.
 If the parameter is not specified, the request uses the destination
 bucket's default encryption key, if any, or else the Google-managed
 encryption key.
      string destination_kms_key = 27 [(.google.api.resource_reference) = { ... }
      Returns:
      The destinationKmsKey.

    • getDestinationKmsKeyBytes

      com.google.protobuf.ByteString getDestinationKmsKeyBytes()
       The name of the Cloud KMS key that will be used to encrypt the destination
 object. The Cloud KMS key must be located in same location as the object.
 If the parameter is not specified, the request uses the destination
 bucket's default encryption key, if any, or else the Google-managed
 encryption key.
      string destination_kms_key = 27 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for destinationKmsKey.

    • hasDestination

      boolean hasDestination()
       Properties of the destination, post-rewrite object.
 The `name`, `bucket` and `kms_key` fields must not be populated (these
 values are specified in the `destination_name`, `destination_bucket`, and
 `destination_kms_key` fields).
 If `destination` is present it will be used to construct the destination
 object's metadata; otherwise the destination object's metadata will be
 copied from the source object.
      .google.storage.v2.Object destination = 1;
      Returns:
      Whether the destination field is set.

    • getDestination

      Object getDestination()
       Properties of the destination, post-rewrite object.
 The `name`, `bucket` and `kms_key` fields must not be populated (these
 values are specified in the `destination_name`, `destination_bucket`, and
 `destination_kms_key` fields).
 If `destination` is present it will be used to construct the destination
 object's metadata; otherwise the destination object's metadata will be
 copied from the source object.
      .google.storage.v2.Object destination = 1;
      Returns:
      The destination.

    • getDestinationOrBuilder

      ObjectOrBuilder getDestinationOrBuilder()
       Properties of the destination, post-rewrite object.
 The `name`, `bucket` and `kms_key` fields must not be populated (these
 values are specified in the `destination_name`, `destination_bucket`, and
 `destination_kms_key` fields).
 If `destination` is present it will be used to construct the destination
 object's metadata; otherwise the destination object's metadata will be
 copied from the source object.
      .google.storage.v2.Object destination = 1;

    • getSourceBucket

      String getSourceBucket()
       Required. Name of the bucket in which to find the source object.
      string source_bucket = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The sourceBucket.

    • getSourceBucketBytes

      com.google.protobuf.ByteString getSourceBucketBytes()
       Required. Name of the bucket in which to find the source object.
      string source_bucket = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for sourceBucket.

    • getSourceObject

      String getSourceObject()
       Required. Name of the source object.
      string source_object = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The sourceObject.

    • getSourceObjectBytes

      com.google.protobuf.ByteString getSourceObjectBytes()
       Required. Name of the source object.
      string source_object = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for sourceObject.

    • getSourceGeneration

      long getSourceGeneration()
       If present, selects a specific revision of the source object (as opposed to
 the latest version, the default).
      int64 source_generation = 4;
      Returns:
      The sourceGeneration.

    • getRewriteToken

      String getRewriteToken()
       Include this field (from the previous rewrite response) on each rewrite
 request after the first one, until the rewrite response 'done' flag is
 true. Calls that provide a rewriteToken can omit all other request fields,
 but if included those fields must match the values provided in the first
 rewrite request.
      string rewrite_token = 5;
      Returns:
      The rewriteToken.

    • getRewriteTokenBytes

      com.google.protobuf.ByteString getRewriteTokenBytes()
       Include this field (from the previous rewrite response) on each rewrite
 request after the first one, until the rewrite response 'done' flag is
 true. Calls that provide a rewriteToken can omit all other request fields,
 but if included those fields must match the values provided in the first
 rewrite request.
      string rewrite_token = 5;
      Returns:
      The bytes for rewriteToken.

    • getDestinationPredefinedAcl

      String getDestinationPredefinedAcl()
       Apply a predefined set of access controls to the destination object.
 Valid values are "authenticatedRead", "bucketOwnerFullControl",
 "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
      string destination_predefined_acl = 28;
      Returns:
      The destinationPredefinedAcl.

    • getDestinationPredefinedAclBytes

      com.google.protobuf.ByteString getDestinationPredefinedAclBytes()
       Apply a predefined set of access controls to the destination object.
 Valid values are "authenticatedRead", "bucketOwnerFullControl",
 "bucketOwnerRead", "private", "projectPrivate", or "publicRead".
      string destination_predefined_acl = 28;
      Returns:
      The bytes for destinationPredefinedAcl.

    • 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 = 7;
      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 = 7;
      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 = 8;
      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 = 8;
      Returns:
      The ifGenerationNotMatch.

    • hasIfMetagenerationMatch

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

    • getIfMetagenerationMatch

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

    • hasIfMetagenerationNotMatch

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

    • getIfMetagenerationNotMatch

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

    • hasIfSourceGenerationMatch

      boolean hasIfSourceGenerationMatch()
       Makes the operation conditional on whether the source object's live
 generation matches the given value.
      optional int64 if_source_generation_match = 11;
      Returns:
      Whether the ifSourceGenerationMatch field is set.

    • getIfSourceGenerationMatch

      long getIfSourceGenerationMatch()
       Makes the operation conditional on whether the source object's live
 generation matches the given value.
      optional int64 if_source_generation_match = 11;
      Returns:
      The ifSourceGenerationMatch.

    • hasIfSourceGenerationNotMatch

      boolean hasIfSourceGenerationNotMatch()
       Makes the operation conditional on whether the source object's live
 generation does not match the given value.
      optional int64 if_source_generation_not_match = 12;
      Returns:
      Whether the ifSourceGenerationNotMatch field is set.

    • getIfSourceGenerationNotMatch

      long getIfSourceGenerationNotMatch()
       Makes the operation conditional on whether the source object's live
 generation does not match the given value.
      optional int64 if_source_generation_not_match = 12;
      Returns:
      The ifSourceGenerationNotMatch.

    • hasIfSourceMetagenerationMatch

      boolean hasIfSourceMetagenerationMatch()
       Makes the operation conditional on whether the source object's current
 metageneration matches the given value.
      optional int64 if_source_metageneration_match = 13;
      Returns:
      Whether the ifSourceMetagenerationMatch field is set.

    • getIfSourceMetagenerationMatch

      long getIfSourceMetagenerationMatch()
       Makes the operation conditional on whether the source object's current
 metageneration matches the given value.
      optional int64 if_source_metageneration_match = 13;
      Returns:
      The ifSourceMetagenerationMatch.

    • hasIfSourceMetagenerationNotMatch

      boolean hasIfSourceMetagenerationNotMatch()
       Makes the operation conditional on whether the source object's current
 metageneration does not match the given value.
      optional int64 if_source_metageneration_not_match = 14;
      Returns:
      Whether the ifSourceMetagenerationNotMatch field is set.

    • getIfSourceMetagenerationNotMatch

      long getIfSourceMetagenerationNotMatch()
       Makes the operation conditional on whether the source object's current
 metageneration does not match the given value.
      optional int64 if_source_metageneration_not_match = 14;
      Returns:
      The ifSourceMetagenerationNotMatch.

    • getMaxBytesRewrittenPerCall

      long getMaxBytesRewrittenPerCall()
       The maximum number of bytes that will be rewritten per rewrite request.
 Most callers
 shouldn't need to specify this parameter - it is primarily in place to
 support testing. If specified the value must be an integral multiple of
 1 MiB (1048576). Also, this only applies to requests where the source and
 destination span locations and/or storage classes. Finally, this value must
 not change across rewrite calls else you'll get an error that the
 `rewriteToken` is invalid.
      int64 max_bytes_rewritten_per_call = 15;
      Returns:
      The maxBytesRewrittenPerCall.

    • getCopySourceEncryptionAlgorithm

      String getCopySourceEncryptionAlgorithm()
       The algorithm used to encrypt the source object, if any. Used if the source
 object was encrypted with a Customer-Supplied Encryption Key.
      string copy_source_encryption_algorithm = 16;
      Returns:
      The copySourceEncryptionAlgorithm.

    • getCopySourceEncryptionAlgorithmBytes

      com.google.protobuf.ByteString getCopySourceEncryptionAlgorithmBytes()
       The algorithm used to encrypt the source object, if any. Used if the source
 object was encrypted with a Customer-Supplied Encryption Key.
      string copy_source_encryption_algorithm = 16;
      Returns:
      The bytes for copySourceEncryptionAlgorithm.

    • getCopySourceEncryptionKeyBytes

      com.google.protobuf.ByteString getCopySourceEncryptionKeyBytes()
       The raw bytes (not base64-encoded) AES-256 encryption key used to encrypt
 the source object, if it was encrypted with a Customer-Supplied Encryption
 Key.
      bytes copy_source_encryption_key_bytes = 21;
      Returns:
      The copySourceEncryptionKeyBytes.

    • getCopySourceEncryptionKeySha256Bytes

      com.google.protobuf.ByteString getCopySourceEncryptionKeySha256Bytes()
       The raw bytes (not base64-encoded) SHA256 hash of the encryption key used
 to encrypt the source object, if it was encrypted with a Customer-Supplied
 Encryption Key.
      bytes copy_source_encryption_key_sha256_bytes = 22;
      Returns:
      The copySourceEncryptionKeySha256Bytes.

    • hasCommonObjectRequestParams

      boolean hasCommonObjectRequestParams()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 19;
      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 = 19;
      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 = 19;

    • hasObjectChecksums

      boolean hasObjectChecksums()
       The checksums of the complete object. This will be used to validate the
 destination object after rewriting.
      .google.storage.v2.ObjectChecksums object_checksums = 29;
      Returns:
      Whether the objectChecksums field is set.

    • getObjectChecksums

      ObjectChecksums getObjectChecksums()
       The checksums of the complete object. This will be used to validate the
 destination object after rewriting.
      .google.storage.v2.ObjectChecksums object_checksums = 29;
      Returns:
      The objectChecksums.

    • getObjectChecksumsOrBuilder

      ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder()
       The checksums of the complete object. This will be used to validate the
 destination object after rewriting.
      .google.storage.v2.ObjectChecksums object_checksums = 29;