Interface RewriteObjectRequestOrBuilder (2.17.1)

Version 2.17.1

• 2.45.0 (latest)
• 2.44.1
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public interface RewriteObjectRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCommonObjectRequestParams()

public abstract CommonObjectRequestParams getCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 19;

Returns

Type	Description
CommonObjectRequestParams	The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder()

public abstract CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 19;

Returns

Type	Description
CommonObjectRequestParamsOrBuilder

getCopySourceEncryptionAlgorithm()

public abstract 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

Type	Description
String	The copySourceEncryptionAlgorithm.

getCopySourceEncryptionAlgorithmBytes()

public abstract 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

Type	Description
ByteString	The bytes for copySourceEncryptionAlgorithm.

getCopySourceEncryptionKeyBytes()

public abstract 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

Type	Description
ByteString	The copySourceEncryptionKeyBytes.

getCopySourceEncryptionKeySha256Bytes()

public abstract 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

Type	Description
ByteString	The copySourceEncryptionKeySha256Bytes.

getDestination()

public abstract 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

Type	Description
Object	The destination.

getDestinationBucket()

public abstract 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

Type	Description
String	The destinationBucket.

getDestinationBucketBytes()

public abstract 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

Type	Description
ByteString	The bytes for destinationBucket.

getDestinationKmsKey()

public abstract 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

Type	Description
String	The destinationKmsKey.

getDestinationKmsKeyBytes()

public abstract 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

Type	Description
ByteString	The bytes for destinationKmsKey.

getDestinationName()

public abstract String getDestinationName()

Required. Immutable. The name of the destination object. See the Naming Guidelines. 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

Type	Description
String	The destinationName.

getDestinationNameBytes()

public abstract ByteString getDestinationNameBytes()

Required. Immutable. The name of the destination object. See the Naming Guidelines. 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

Type	Description
ByteString	The bytes for destinationName.

getDestinationOrBuilder()

public abstract 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;

Returns

Type	Description
ObjectOrBuilder

getDestinationPredefinedAcl()

public abstract 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

Type	Description
String	The destinationPredefinedAcl.

getDestinationPredefinedAclBytes()

public abstract 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

Type	Description
ByteString	The bytes for destinationPredefinedAcl.

getIfGenerationMatch()

public abstract 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

Type	Description
long	The ifGenerationMatch.

getIfGenerationNotMatch()

public abstract 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

Type	Description
long	The ifGenerationNotMatch.

getIfMetagenerationMatch()

public abstract 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

Type	Description
long	The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public abstract 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

Type	Description
long	The ifMetagenerationNotMatch.

getIfSourceGenerationMatch()

public abstract 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

Type	Description
long	The ifSourceGenerationMatch.

getIfSourceGenerationNotMatch()

public abstract 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

Type	Description
long	The ifSourceGenerationNotMatch.

getIfSourceMetagenerationMatch()

public abstract 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

Type	Description
long	The ifSourceMetagenerationMatch.

getIfSourceMetagenerationNotMatch()

public abstract 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

Type	Description
long	The ifSourceMetagenerationNotMatch.

getMaxBytesRewrittenPerCall()

public abstract 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

Type	Description
long	The maxBytesRewrittenPerCall.

getObjectChecksums()

public abstract 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

Type	Description
ObjectChecksums	The objectChecksums.

getObjectChecksumsOrBuilder()

public abstract 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;

Returns

Type	Description
ObjectChecksumsOrBuilder

getRewriteToken()

public abstract 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

Type	Description
String	The rewriteToken.

getRewriteTokenBytes()

public abstract 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

Type	Description
ByteString	The bytes for rewriteToken.

getSourceBucket()

public abstract String getSourceBucket()

Required. Name of the bucket in which to find the source object.

string source_bucket = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The sourceBucket.

getSourceBucketBytes()

public abstract ByteString getSourceBucketBytes()

Required. Name of the bucket in which to find the source object.

string source_bucket = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for sourceBucket.

getSourceGeneration()

public abstract 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

Type	Description
long	The sourceGeneration.

getSourceObject()

public abstract String getSourceObject()

Required. Name of the source object.

string source_object = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The sourceObject.

getSourceObjectBytes()

public abstract ByteString getSourceObjectBytes()

Required. Name of the source object.

string source_object = 3 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for sourceObject.

hasCommonObjectRequestParams()

public abstract boolean hasCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 19;

Returns

Type	Description
boolean	Whether the commonObjectRequestParams field is set.

hasDestination()

public abstract 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

Type	Description
boolean	Whether the destination field is set.

hasIfGenerationMatch()

public abstract 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

Type	Description
boolean	Whether the ifGenerationMatch field is set.

hasIfGenerationNotMatch()

public abstract 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

Type	Description
boolean	Whether the ifGenerationNotMatch field is set.

hasIfMetagenerationMatch()

public abstract 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

Type	Description
boolean	Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public abstract 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

Type	Description
boolean	Whether the ifMetagenerationNotMatch field is set.

hasIfSourceGenerationMatch()

public abstract 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

Type	Description
boolean	Whether the ifSourceGenerationMatch field is set.

hasIfSourceGenerationNotMatch()

public abstract 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

Type	Description
boolean	Whether the ifSourceGenerationNotMatch field is set.

hasIfSourceMetagenerationMatch()

public abstract 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

Type	Description
boolean	Whether the ifSourceMetagenerationMatch field is set.

hasIfSourceMetagenerationNotMatch()

public abstract 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

Type	Description
boolean	Whether the ifSourceMetagenerationNotMatch field is set.

hasObjectChecksums()

public abstract 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

Type	Description
boolean	Whether the objectChecksums field is set.