public final class RewriteObjectRequest extends GeneratedMessageV3 implements RewriteObjectRequestOrBuilder
Request message for RewriteObject. If the source object is encrypted using a Customer-Supplied Encryption Key the key information must be provided in the copy_source_encryption_algorithm, copy_source_encryption_key_bytes, and copy_source_encryption_key_sha256_bytes fields. If the destination object should be encrypted the keying information should be provided in the encryption_algorithm, encryption_key_bytes, and encryption_key_sha256_bytes fields of the common_object_request_params.customer_encryption field.
Protobuf type google.storage.v2.RewriteObjectRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RewriteObjectRequestImplements
RewriteObjectRequestOrBuilderStatic Fields
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Type | Description |
int |
COPY_SOURCE_ENCRYPTION_ALGORITHM_FIELD_NUMBER
public static final int COPY_SOURCE_ENCRYPTION_ALGORITHM_FIELD_NUMBER
Type | Description |
int |
COPY_SOURCE_ENCRYPTION_KEY_BYTES_FIELD_NUMBER
public static final int COPY_SOURCE_ENCRYPTION_KEY_BYTES_FIELD_NUMBER
Type | Description |
int |
COPY_SOURCE_ENCRYPTION_KEY_SHA256_BYTES_FIELD_NUMBER
public static final int COPY_SOURCE_ENCRYPTION_KEY_SHA256_BYTES_FIELD_NUMBER
Type | Description |
int |
DESTINATION_BUCKET_FIELD_NUMBER
public static final int DESTINATION_BUCKET_FIELD_NUMBER
Type | Description |
int |
DESTINATION_FIELD_NUMBER
public static final int DESTINATION_FIELD_NUMBER
Type | Description |
int |
DESTINATION_KMS_KEY_FIELD_NUMBER
public static final int DESTINATION_KMS_KEY_FIELD_NUMBER
Type | Description |
int |
DESTINATION_NAME_FIELD_NUMBER
public static final int DESTINATION_NAME_FIELD_NUMBER
Type | Description |
int |
DESTINATION_PREDEFINED_ACL_FIELD_NUMBER
public static final int DESTINATION_PREDEFINED_ACL_FIELD_NUMBER
Type | Description |
int |
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Type | Description |
int |
IF_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
Type | Description |
int |
IF_METAGENERATION_MATCH_FIELD_NUMBER
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Type | Description |
int |
IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Type | Description |
int |
IF_SOURCE_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_SOURCE_GENERATION_MATCH_FIELD_NUMBER
Type | Description |
int |
IF_SOURCE_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_SOURCE_GENERATION_NOT_MATCH_FIELD_NUMBER
Type | Description |
int |
IF_SOURCE_METAGENERATION_MATCH_FIELD_NUMBER
public static final int IF_SOURCE_METAGENERATION_MATCH_FIELD_NUMBER
Type | Description |
int |
IF_SOURCE_METAGENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_SOURCE_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Type | Description |
int |
MAX_BYTES_REWRITTEN_PER_CALL_FIELD_NUMBER
public static final int MAX_BYTES_REWRITTEN_PER_CALL_FIELD_NUMBER
Type | Description |
int |
REWRITE_TOKEN_FIELD_NUMBER
public static final int REWRITE_TOKEN_FIELD_NUMBER
Type | Description |
int |
SOURCE_BUCKET_FIELD_NUMBER
public static final int SOURCE_BUCKET_FIELD_NUMBER
Type | Description |
int |
SOURCE_GENERATION_FIELD_NUMBER
public static final int SOURCE_GENERATION_FIELD_NUMBER
Type | Description |
int |
SOURCE_OBJECT_FIELD_NUMBER
public static final int SOURCE_OBJECT_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static RewriteObjectRequest getDefaultInstance()
Type | Description |
RewriteObjectRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static RewriteObjectRequest.Builder newBuilder()
Type | Description |
RewriteObjectRequest.Builder |
newBuilder(RewriteObjectRequest prototype)
public static RewriteObjectRequest.Builder newBuilder(RewriteObjectRequest prototype)
Name | Description |
prototype | RewriteObjectRequest |
Type | Description |
RewriteObjectRequest.Builder |
parseDelimitedFrom(InputStream input)
public static RewriteObjectRequest parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
RewriteObjectRequest |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RewriteObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
RewriteObjectRequest |
Type | Description |
IOException |
parseFrom(byte[] data)
public static RewriteObjectRequest parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
RewriteObjectRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RewriteObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
RewriteObjectRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static RewriteObjectRequest parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
RewriteObjectRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RewriteObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
RewriteObjectRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static RewriteObjectRequest parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
RewriteObjectRequest |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RewriteObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
RewriteObjectRequest |
Type | Description |
IOException |
parseFrom(InputStream input)
public static RewriteObjectRequest parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
RewriteObjectRequest |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RewriteObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
RewriteObjectRequest |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static RewriteObjectRequest parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
RewriteObjectRequest |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RewriteObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
RewriteObjectRequest |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<RewriteObjectRequest> parser()
Type | Description |
Parser<RewriteObjectRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getCommonObjectRequestParams()
public CommonObjectRequestParams getCommonObjectRequestParams()
A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 19;
Type | Description |
CommonObjectRequestParams | The commonObjectRequestParams. |
getCommonObjectRequestParamsOrBuilder()
public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 19;
Type | Description |
CommonObjectRequestParamsOrBuilder |
getCopySourceEncryptionAlgorithm()
public 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;
Type | Description |
String | The copySourceEncryptionAlgorithm. |
getCopySourceEncryptionAlgorithmBytes()
public 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;
Type | Description |
ByteString | The bytes for copySourceEncryptionAlgorithm. |
getCopySourceEncryptionKeyBytes()
public 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;
Type | Description |
ByteString | The copySourceEncryptionKeyBytes. |
getCopySourceEncryptionKeySha256Bytes()
public 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;
Type | Description |
ByteString | The copySourceEncryptionKeySha256Bytes. |
getDefaultInstanceForType()
public RewriteObjectRequest getDefaultInstanceForType()
Type | Description |
RewriteObjectRequest |
getDestination()
public 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;
Type | Description |
Object | The destination. |
getDestinationBucket()
public String getDestinationBucket()
Immutable. The name of the bucket containing the destination object.
string destination_bucket = 25 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Type | Description |
String | The destinationBucket. |
getDestinationBucketBytes()
public ByteString getDestinationBucketBytes()
Immutable. The name of the bucket containing the destination object.
string destination_bucket = 25 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for destinationBucket. |
getDestinationKmsKey()
public 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) = { ... }
Type | Description |
String | The destinationKmsKey. |
getDestinationKmsKeyBytes()
public 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) = { ... }
Type | Description |
ByteString | The bytes for destinationKmsKey. |
getDestinationName()
public String getDestinationName()
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) = IMMUTABLE];
Type | Description |
String | The destinationName. |
getDestinationNameBytes()
public ByteString getDestinationNameBytes()
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) = IMMUTABLE];
Type | Description |
ByteString | The bytes for destinationName. |
getDestinationOrBuilder()
public 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;
Type | Description |
ObjectOrBuilder |
getDestinationPredefinedAcl()
public 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;
Type | Description |
String | The destinationPredefinedAcl. |
getDestinationPredefinedAclBytes()
public 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;
Type | Description |
ByteString | The bytes for destinationPredefinedAcl. |
getIfGenerationMatch()
public 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;
Type | Description |
long | The ifGenerationMatch. |
getIfGenerationNotMatch()
public 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;
Type | Description |
long | The ifGenerationNotMatch. |
getIfMetagenerationMatch()
public long getIfMetagenerationMatch()
Makes the operation conditional on whether the destination object's current metageneration matches the given value.
optional int64 if_metageneration_match = 9;
Type | Description |
long | The ifMetagenerationMatch. |
getIfMetagenerationNotMatch()
public 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;
Type | Description |
long | The ifMetagenerationNotMatch. |
getIfSourceGenerationMatch()
public 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;
Type | Description |
long | The ifSourceGenerationMatch. |
getIfSourceGenerationNotMatch()
public 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;
Type | Description |
long | The ifSourceGenerationNotMatch. |
getIfSourceMetagenerationMatch()
public 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;
Type | Description |
long | The ifSourceMetagenerationMatch. |
getIfSourceMetagenerationNotMatch()
public 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;
Type | Description |
long | The ifSourceMetagenerationNotMatch. |
getMaxBytesRewrittenPerCall()
public 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;
Type | Description |
long | The maxBytesRewrittenPerCall. |
getParserForType()
public Parser<RewriteObjectRequest> getParserForType()
Type | Description |
Parser<RewriteObjectRequest> |
getRewriteToken()
public 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;
Type | Description |
String | The rewriteToken. |
getRewriteTokenBytes()
public 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;
Type | Description |
ByteString | The bytes for rewriteToken. |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getSourceBucket()
public String getSourceBucket()
Required. Name of the bucket in which to find the source object.
string source_bucket = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
String | The sourceBucket. |
getSourceBucketBytes()
public ByteString getSourceBucketBytes()
Required. Name of the bucket in which to find the source object.
string source_bucket = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
ByteString | The bytes for sourceBucket. |
getSourceGeneration()
public long getSourceGeneration()
If present, selects a specific revision of the source object (as opposed to the latest version, the default).
int64 source_generation = 4;
Type | Description |
long | The sourceGeneration. |
getSourceObject()
public String getSourceObject()
Required. Name of the source object.
string source_object = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
String | The sourceObject. |
getSourceObjectBytes()
public ByteString getSourceObjectBytes()
Required. Name of the source object.
string source_object = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
ByteString | The bytes for sourceObject. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
hasCommonObjectRequestParams()
public boolean hasCommonObjectRequestParams()
A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 19;
Type | Description |
boolean | Whether the commonObjectRequestParams field is set. |
hasDestination()
public 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;
Type | Description |
boolean | Whether the destination field is set. |
hasIfGenerationMatch()
public 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;
Type | Description |
boolean | Whether the ifGenerationMatch field is set. |
hasIfGenerationNotMatch()
public 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;
Type | Description |
boolean | Whether the ifGenerationNotMatch field is set. |
hasIfMetagenerationMatch()
public boolean hasIfMetagenerationMatch()
Makes the operation conditional on whether the destination object's current metageneration matches the given value.
optional int64 if_metageneration_match = 9;
Type | Description |
boolean | Whether the ifMetagenerationMatch field is set. |
hasIfMetagenerationNotMatch()
public 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;
Type | Description |
boolean | Whether the ifMetagenerationNotMatch field is set. |
hasIfSourceGenerationMatch()
public 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;
Type | Description |
boolean | Whether the ifSourceGenerationMatch field is set. |
hasIfSourceGenerationNotMatch()
public 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;
Type | Description |
boolean | Whether the ifSourceGenerationNotMatch field is set. |
hasIfSourceMetagenerationMatch()
public 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;
Type | Description |
boolean | Whether the ifSourceMetagenerationMatch field is set. |
hasIfSourceMetagenerationNotMatch()
public 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;
Type | Description |
boolean | Whether the ifSourceMetagenerationNotMatch field is set. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public RewriteObjectRequest.Builder newBuilderForType()
Type | Description |
RewriteObjectRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RewriteObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
RewriteObjectRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public RewriteObjectRequest.Builder toBuilder()
Type | Description |
RewriteObjectRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |