Interface ComposeObjectRequestOrBuilder (2.33.0) 

public interface ComposeObjectRequestOrBuilder 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 = 7;

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 = 7;

Returns
Type Description
CommonObjectRequestParamsOrBuilder

getDestination()

public abstract Object getDestination()

Required. Properties of the resulting object.

.google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Object

The destination.

getDestinationOrBuilder()

public abstract ObjectOrBuilder getDestinationOrBuilder()

Required. Properties of the resulting object.

.google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];

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 = 9;

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 = 9;

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 = 4;

Returns
Type Description
long

The ifGenerationMatch.

getIfMetagenerationMatch()

public abstract long getIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 5;

Returns
Type Description
long

The ifMetagenerationMatch.

getKmsKey()

public abstract String getKmsKey()

Resource name of the Cloud KMS key, of the form projects/my-project/locations/my-location/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.

string kms_key = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

Resource name of the Cloud KMS key, of the form projects/my-project/locations/my-location/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.

string kms_key = 6 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getObjectChecksums()

public abstract ObjectChecksums getObjectChecksums()

The checksums of the complete object. This will be validated against the combined checksums of the component objects.

.google.storage.v2.ObjectChecksums object_checksums = 10;

Returns
Type Description
ObjectChecksums

The objectChecksums.

getObjectChecksumsOrBuilder()

public abstract ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder()

The checksums of the complete object. This will be validated against the combined checksums of the component objects.

.google.storage.v2.ObjectChecksums object_checksums = 10;

Returns
Type Description
ObjectChecksumsOrBuilder

getSourceObjects(int index)

public abstract ComposeObjectRequest.SourceObject getSourceObjects(int index)

The list of source objects that will be concatenated into a single object.

repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2;

Parameter
Name Description
index int
Returns
Type Description
ComposeObjectRequest.SourceObject

getSourceObjectsCount()

public abstract int getSourceObjectsCount()

The list of source objects that will be concatenated into a single object.

repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2;

Returns
Type Description
int

getSourceObjectsList()

public abstract List<ComposeObjectRequest.SourceObject> getSourceObjectsList()

The list of source objects that will be concatenated into a single object.

repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2;

Returns
Type Description
List<SourceObject>

getSourceObjectsOrBuilder(int index)

public abstract ComposeObjectRequest.SourceObjectOrBuilder getSourceObjectsOrBuilder(int index)

The list of source objects that will be concatenated into a single object.

repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2;

Parameter
Name Description
index int
Returns
Type Description
ComposeObjectRequest.SourceObjectOrBuilder

getSourceObjectsOrBuilderList()

public abstract List<? extends ComposeObjectRequest.SourceObjectOrBuilder> getSourceObjectsOrBuilderList()

The list of source objects that will be concatenated into a single object.

repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2;

Returns
Type Description
List<? extends com.google.storage.v2.ComposeObjectRequest.SourceObjectOrBuilder>

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 = 7;

Returns
Type Description
boolean

Whether the commonObjectRequestParams field is set.

hasDestination()

public abstract boolean hasDestination()

Required. Properties of the resulting object.

.google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];

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 = 4;

Returns
Type Description
boolean

Whether the ifGenerationMatch field is set.

hasIfMetagenerationMatch()

public abstract boolean hasIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 5;

Returns
Type Description
boolean

Whether the ifMetagenerationMatch field is set.

hasObjectChecksums()

public abstract boolean hasObjectChecksums()

The checksums of the complete object. This will be validated against the combined checksums of the component objects.

.google.storage.v2.ObjectChecksums object_checksums = 10;

Returns
Type Description
boolean

Whether the objectChecksums field is set.