Interface ComposeObjectRequestOrBuilder (2.4.5)

Version 2.4.5

• 2.43.2 (latest)
• 2.43.1
• 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 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

getCommonRequestParams()

public abstract CommonRequestParams getCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 8;

Returns

Type	Description
CommonRequestParams	The commonRequestParams.

getCommonRequestParamsOrBuilder()

public abstract CommonRequestParamsOrBuilder getCommonRequestParamsOrBuilder()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 8;

Returns

Type	Description
CommonRequestParamsOrBuilder

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 PredefinedObjectAcl getDestinationPredefinedAcl()

Apply a predefined set of access controls to the destination object.

.google.storage.v2.PredefinedObjectAcl destination_predefined_acl = 3;

Returns

Type	Description
PredefinedObjectAcl	The destinationPredefinedAcl.

getDestinationPredefinedAclValue()

public abstract int getDestinationPredefinedAclValue()

Apply a predefined set of access controls to the destination object.

.google.storage.v2.PredefinedObjectAcl destination_predefined_acl = 3;

Returns

Type	Description
int	The enum numeric value on the wire 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.

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.

hasCommonRequestParams()

public abstract boolean hasCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 8;

Returns

Type	Description
boolean	Whether the commonRequestParams 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.