public final class ComposeObjectRequest extends GeneratedMessageV3 implements ComposeObjectRequestOrBuilder
Request message for ComposeObject.
Protobuf type google.storage.v2.ComposeObjectRequest
Static Fields
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
COMMON_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_REQUEST_PARAMS_FIELD_NUMBER
Field Value
DESTINATION_FIELD_NUMBER
public static final int DESTINATION_FIELD_NUMBER
Field Value
DESTINATION_PREDEFINED_ACL_FIELD_NUMBER
public static final int DESTINATION_PREDEFINED_ACL_FIELD_NUMBER
Field Value
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Field Value
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER
Field Value
SOURCE_OBJECTS_FIELD_NUMBER
public static final int SOURCE_OBJECTS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ComposeObjectRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ComposeObjectRequest.Builder newBuilder()
Returns
newBuilder(ComposeObjectRequest prototype)
public static ComposeObjectRequest.Builder newBuilder(ComposeObjectRequest prototype)
Parameter
Returns
public static ComposeObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ComposeObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ComposeObjectRequest parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ComposeObjectRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ComposeObjectRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ComposeObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ComposeObjectRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ComposeObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ComposeObjectRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ComposeObjectRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
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;
getCommonRequestParams()
public CommonRequestParams getCommonRequestParams()
A set of parameters common to all Storage API requests.
.google.storage.v2.CommonRequestParams common_request_params = 8;
getCommonRequestParamsOrBuilder()
public CommonRequestParamsOrBuilder getCommonRequestParamsOrBuilder()
A set of parameters common to all Storage API requests.
.google.storage.v2.CommonRequestParams common_request_params = 8;
getDefaultInstanceForType()
public ComposeObjectRequest getDefaultInstanceForType()
Returns
getDestination()
public Object getDestination()
Required. Properties of the resulting object.
.google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
| Object |
The destination.
|
getDestinationOrBuilder()
public ObjectOrBuilder getDestinationOrBuilder()
Required. Properties of the resulting object.
.google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];
getDestinationPredefinedAcl()
public PredefinedObjectAcl getDestinationPredefinedAcl()
Apply a predefined set of access controls to the destination object.
.google.storage.v2.PredefinedObjectAcl destination_predefined_acl = 3;
getDestinationPredefinedAclValue()
public int getDestinationPredefinedAclValue()
Apply a predefined set of access controls to the destination object.
.google.storage.v2.PredefinedObjectAcl destination_predefined_acl = 3;
| Type |
Description |
| int |
The enum numeric value on the wire 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;
| Type |
Description |
| long |
The ifGenerationMatch.
|
public long getIfMetagenerationMatch()
Makes the operation conditional on whether the object's current
metageneration matches the given value.
optional int64 if_metageneration_match = 5;
| 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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<ComposeObjectRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
| Name |
Description |
| index |
int
|
Returns
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;
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;
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;
| Name |
Description |
| index |
int
|
Returns
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;
| Type |
Description |
| List<? extends com.google.storage.v2.ComposeObjectRequest.SourceObjectOrBuilder> |
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type |
Description |
| boolean |
Whether the commonObjectRequestParams field is set.
|
hasCommonRequestParams()
public boolean hasCommonRequestParams()
A set of parameters common to all Storage API requests.
.google.storage.v2.CommonRequestParams common_request_params = 8;
| Type |
Description |
| boolean |
Whether the commonRequestParams field is set.
|
hasDestination()
public boolean hasDestination()
Required. Properties of the resulting object.
.google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];
| 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;
| Type |
Description |
| boolean |
Whether the ifGenerationMatch field is set.
|
public boolean hasIfMetagenerationMatch()
Makes the operation conditional on whether the object's current
metageneration matches the given value.
optional int64 if_metageneration_match = 5;
| Type |
Description |
| boolean |
Whether the ifMetagenerationMatch field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ComposeObjectRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ComposeObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ComposeObjectRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
