Class ComposeObjectRequest.Builder (2.8.1)

public static final class ComposeObjectRequest.Builder extends GeneratedMessageV3.Builder<ComposeObjectRequest.Builder> implements ComposeObjectRequestOrBuilder

Request message for ComposeObject.

Protobuf type google.storage.v2.ComposeObjectRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllSourceObjects(Iterable<? extends ComposeObjectRequest.SourceObject> values)

public ComposeObjectRequest.Builder addAllSourceObjects(Iterable<? extends ComposeObjectRequest.SourceObject> values)

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
values Iterable<? extends com.google.storage.v2.ComposeObjectRequest.SourceObject>
Returns
Type Description
ComposeObjectRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ComposeObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

addSourceObjects(ComposeObjectRequest.SourceObject value)

public ComposeObjectRequest.Builder addSourceObjects(ComposeObjectRequest.SourceObject value)

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
value ComposeObjectRequest.SourceObject
Returns
Type Description
ComposeObjectRequest.Builder

addSourceObjects(ComposeObjectRequest.SourceObject.Builder builderForValue)

public ComposeObjectRequest.Builder addSourceObjects(ComposeObjectRequest.SourceObject.Builder builderForValue)

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
builderForValue ComposeObjectRequest.SourceObject.Builder
Returns
Type Description
ComposeObjectRequest.Builder

addSourceObjects(int index, ComposeObjectRequest.SourceObject value)

public ComposeObjectRequest.Builder addSourceObjects(int index, ComposeObjectRequest.SourceObject value)

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

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

Parameters
Name Description
index int
value ComposeObjectRequest.SourceObject
Returns
Type Description
ComposeObjectRequest.Builder

addSourceObjects(int index, ComposeObjectRequest.SourceObject.Builder builderForValue)

public ComposeObjectRequest.Builder addSourceObjects(int index, ComposeObjectRequest.SourceObject.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue ComposeObjectRequest.SourceObject.Builder
Returns
Type Description
ComposeObjectRequest.Builder

addSourceObjectsBuilder()

public ComposeObjectRequest.SourceObject.Builder addSourceObjectsBuilder()

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
ComposeObjectRequest.SourceObject.Builder

addSourceObjectsBuilder(int index)

public ComposeObjectRequest.SourceObject.Builder addSourceObjectsBuilder(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.Builder

build()

public ComposeObjectRequest build()
Returns
Type Description
ComposeObjectRequest

buildPartial()

public ComposeObjectRequest buildPartial()
Returns
Type Description
ComposeObjectRequest

clear()

public ComposeObjectRequest.Builder clear()
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

clearCommonObjectRequestParams()

public ComposeObjectRequest.Builder clearCommonObjectRequestParams()

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

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

Returns
Type Description
ComposeObjectRequest.Builder

clearDestination()

public ComposeObjectRequest.Builder clearDestination()

Required. Properties of the resulting object.

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

Returns
Type Description
ComposeObjectRequest.Builder

clearDestinationPredefinedAcl()

public ComposeObjectRequest.Builder clearDestinationPredefinedAcl()

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
ComposeObjectRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ComposeObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

clearIfGenerationMatch()

public ComposeObjectRequest.Builder clearIfGenerationMatch()

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
ComposeObjectRequest.Builder

This builder for chaining.

clearIfMetagenerationMatch()

public ComposeObjectRequest.Builder clearIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 5;

Returns
Type Description
ComposeObjectRequest.Builder

This builder for chaining.

clearKmsKey()

public ComposeObjectRequest.Builder clearKmsKey()

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
ComposeObjectRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ComposeObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

clearSourceObjects()

public ComposeObjectRequest.Builder clearSourceObjects()

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
ComposeObjectRequest.Builder

clone()

public ComposeObjectRequest.Builder clone()
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

getCommonObjectRequestParams()

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

getCommonObjectRequestParamsBuilder()

public CommonObjectRequestParams.Builder getCommonObjectRequestParamsBuilder()

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.Builder

getCommonObjectRequestParamsOrBuilder()

public 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

getDefaultInstanceForType()

public ComposeObjectRequest getDefaultInstanceForType()
Returns
Type Description
ComposeObjectRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestination()

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

getDestinationBuilder()

public Object.Builder getDestinationBuilder()

Required. Properties of the resulting object.

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

Returns
Type Description
Object.Builder

getDestinationOrBuilder()

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

getSourceObjectsBuilder(int index)

public ComposeObjectRequest.SourceObject.Builder getSourceObjectsBuilder(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.Builder

getSourceObjectsBuilderList()

public List<ComposeObjectRequest.SourceObject.Builder> getSourceObjectsBuilderList()

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<Builder>

getSourceObjectsCount()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommonObjectRequestParams(CommonObjectRequestParams value)

public ComposeObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)

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

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

Parameter
Name Description
value CommonObjectRequestParams
Returns
Type Description
ComposeObjectRequest.Builder

mergeDestination(Object value)

public ComposeObjectRequest.Builder mergeDestination(Object value)

Required. Properties of the resulting object.

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

Parameter
Name Description
value Object
Returns
Type Description
ComposeObjectRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ComposeObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ComposeObjectRequest.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public ComposeObjectRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

mergeFrom(ComposeObjectRequest other)

public ComposeObjectRequest.Builder mergeFrom(ComposeObjectRequest other)
Parameter
Name Description
other ComposeObjectRequest
Returns
Type Description
ComposeObjectRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ComposeObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

removeSourceObjects(int index)

public ComposeObjectRequest.Builder removeSourceObjects(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.Builder

setCommonObjectRequestParams(CommonObjectRequestParams value)

public ComposeObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)

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

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

Parameter
Name Description
value CommonObjectRequestParams
Returns
Type Description
ComposeObjectRequest.Builder

setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

public ComposeObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue CommonObjectRequestParams.Builder
Returns
Type Description
ComposeObjectRequest.Builder

setDestination(Object value)

public ComposeObjectRequest.Builder setDestination(Object value)

Required. Properties of the resulting object.

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

Parameter
Name Description
value Object
Returns
Type Description
ComposeObjectRequest.Builder

setDestination(Object.Builder builderForValue)

public ComposeObjectRequest.Builder setDestination(Object.Builder builderForValue)

Required. Properties of the resulting object.

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

Parameter
Name Description
builderForValue Object.Builder
Returns
Type Description
ComposeObjectRequest.Builder

setDestinationPredefinedAcl(String value)

public ComposeObjectRequest.Builder setDestinationPredefinedAcl(String value)

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;

Parameter
Name Description
value String

The destinationPredefinedAcl to set.

Returns
Type Description
ComposeObjectRequest.Builder

This builder for chaining.

setDestinationPredefinedAclBytes(ByteString value)

public ComposeObjectRequest.Builder setDestinationPredefinedAclBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for destinationPredefinedAcl to set.

Returns
Type Description
ComposeObjectRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ComposeObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

setIfGenerationMatch(long value)

public ComposeObjectRequest.Builder setIfGenerationMatch(long value)

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;

Parameter
Name Description
value long

The ifGenerationMatch to set.

Returns
Type Description
ComposeObjectRequest.Builder

This builder for chaining.

setIfMetagenerationMatch(long value)

public ComposeObjectRequest.Builder setIfMetagenerationMatch(long value)

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

optional int64 if_metageneration_match = 5;

Parameter
Name Description
value long

The ifMetagenerationMatch to set.

Returns
Type Description
ComposeObjectRequest.Builder

This builder for chaining.

setKmsKey(String value)

public ComposeObjectRequest.Builder setKmsKey(String value)

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) = { ... }

Parameter
Name Description
value String

The kmsKey to set.

Returns
Type Description
ComposeObjectRequest.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public ComposeObjectRequest.Builder setKmsKeyBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.

Returns
Type Description
ComposeObjectRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ComposeObjectRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ComposeObjectRequest.Builder
Overrides

setSourceObjects(int index, ComposeObjectRequest.SourceObject value)

public ComposeObjectRequest.Builder setSourceObjects(int index, ComposeObjectRequest.SourceObject value)

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

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

Parameters
Name Description
index int
value ComposeObjectRequest.SourceObject
Returns
Type Description
ComposeObjectRequest.Builder

setSourceObjects(int index, ComposeObjectRequest.SourceObject.Builder builderForValue)

public ComposeObjectRequest.Builder setSourceObjects(int index, ComposeObjectRequest.SourceObject.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue ComposeObjectRequest.SourceObject.Builder
Returns
Type Description
ComposeObjectRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ComposeObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ComposeObjectRequest.Builder
Overrides