com.google.storage.v2

Interface ComposeObjectRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ComposeObjectRequest, ComposeObjectRequest.Builder

public interface ComposeObjectRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CommonObjectRequestParams	getCommonObjectRequestParams() A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParamsOrBuilder	getCommonObjectRequestParamsOrBuilder() A set of parameters common to Storage API requests concerning an object.
Object	getDestination() Required.
ObjectOrBuilder	getDestinationOrBuilder() Required.
String	getDestinationPredefinedAcl() Apply a predefined set of access controls to the destination object.
com.google.protobuf.ByteString	getDestinationPredefinedAclBytes() Apply a predefined set of access controls to the destination object.
long	getIfGenerationMatch() Makes the operation conditional on whether the object's current generation matches the given value.
long	getIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
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.
com.google.protobuf.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.
ObjectChecksums	getObjectChecksums() The checksums of the complete object.
ObjectChecksumsOrBuilder	getObjectChecksumsOrBuilder() The checksums of the complete object.
ComposeObjectRequest.SourceObject	getSourceObjects(int index) The list of source objects that will be concatenated into a single object.
int	getSourceObjectsCount() The list of source objects that will be concatenated into a single object.
List<ComposeObjectRequest.SourceObject>	getSourceObjectsList() The list of source objects that will be concatenated into a single object.
ComposeObjectRequest.SourceObjectOrBuilder	getSourceObjectsOrBuilder(int index) The list of source objects that will be concatenated into a single object.
List<? extends ComposeObjectRequest.SourceObjectOrBuilder>	getSourceObjectsOrBuilderList() The list of source objects that will be concatenated into a single object.
boolean	hasCommonObjectRequestParams() A set of parameters common to Storage API requests concerning an object.
boolean	hasDestination() Required.
boolean	hasIfGenerationMatch() Makes the operation conditional on whether the object's current generation matches the given value.
boolean	hasIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
boolean	hasObjectChecksums() The checksums of the complete object.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasDestination

boolean hasDestination()

 Required. Properties of the resulting object.
 

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

Returns:

Whether the destination field is set.

getDestination

Object getDestination()

 Required. Properties of the resulting object.
 

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

Returns:

The destination.

getDestinationOrBuilder

ObjectOrBuilder getDestinationOrBuilder()

 Required. Properties of the resulting object.
 

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

getSourceObjectsList

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;

getSourceObjects

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;

getSourceObjectsCount

int getSourceObjectsCount()

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

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

getSourceObjectsOrBuilderList

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;

getSourceObjectsOrBuilder

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;

getDestinationPredefinedAcl

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:

The destinationPredefinedAcl.

getDestinationPredefinedAclBytes

com.google.protobuf.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:

The bytes for destinationPredefinedAcl.

hasIfGenerationMatch

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:

Whether the ifGenerationMatch field is set.

getIfGenerationMatch

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:

The ifGenerationMatch.

hasIfMetagenerationMatch

boolean hasIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 5;

Returns:

Whether the ifMetagenerationMatch field is set.

getIfMetagenerationMatch

long getIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 5;

Returns:

The ifMetagenerationMatch.

getKmsKey

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:

The kmsKey.

getKmsKeyBytes

com.google.protobuf.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:

The bytes for kmsKey.

hasCommonObjectRequestParams

boolean hasCommonObjectRequestParams()

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

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

Returns:

Whether the commonObjectRequestParams field is set.

getCommonObjectRequestParams

CommonObjectRequestParams getCommonObjectRequestParams()

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

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

Returns:

The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder

CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

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

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

hasObjectChecksums

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:

Whether the objectChecksums field is set.

getObjectChecksums

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:

The objectChecksums.

getObjectChecksumsOrBuilder

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;