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 |
|---|
| Type | Description |
int | |
DESTINATION_FIELD_NUMBER
public static final int DESTINATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESTINATION_PREDEFINED_ACL_FIELD_NUMBER
public static final int DESTINATION_PREDEFINED_ACL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OBJECT_CHECKSUMS_FIELD_NUMBER
public static final int OBJECT_CHECKSUMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SOURCE_OBJECTS_FIELD_NUMBER
public static final int SOURCE_OBJECTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ComposeObjectRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ComposeObjectRequest.Builder newBuilder()
newBuilder(ComposeObjectRequest prototype)
public static ComposeObjectRequest.Builder newBuilder(ComposeObjectRequest prototype)
public static ComposeObjectRequest parseDelimitedFrom(InputStream input)
public static ComposeObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ComposeObjectRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ComposeObjectRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(CodedInputStream input)
public static ComposeObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(InputStream input)
public static ComposeObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ComposeObjectRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ComposeObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ComposeObjectRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
getDefaultInstanceForType()
public ComposeObjectRequest getDefaultInstanceForType()
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.
|
getDestinationOrBuilder()
public ObjectOrBuilder getDestinationOrBuilder()
Required. Properties of the resulting object.
.google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];
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.
|
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.
|
getObjectChecksums()
public 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;
getObjectChecksumsOrBuilder()
public 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;
getParserForType()
public Parser<ComposeObjectRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
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;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
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
|
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> | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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;
| 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.
|
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.
|
hasObjectChecksums()
public 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ComposeObjectRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ComposeObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ComposeObjectRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
