Package com.google.storage.v2

Class ComposeObjectRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.ComposeObjectRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ComposeObjectRequestOrBuilder, Serializable
public final class ComposeObjectRequest extends com.google.protobuf.GeneratedMessageV3 implements ComposeObjectRequestOrBuilder
 Request message for ComposeObject.
Protobuf type google.storage.v2.ComposeObjectRequest
See Also:

  • Field Details

    • DESTINATION_FIELD_NUMBER

      public static final int DESTINATION_FIELD_NUMBER
      See Also:

    • SOURCE_OBJECTS_FIELD_NUMBER

      public static final int SOURCE_OBJECTS_FIELD_NUMBER
      See Also:

    • DESTINATION_PREDEFINED_ACL_FIELD_NUMBER

      public static final int DESTINATION_PREDEFINED_ACL_FIELD_NUMBER
      See Also:

    • IF_GENERATION_MATCH_FIELD_NUMBER

      public static final int IF_GENERATION_MATCH_FIELD_NUMBER
      See Also:

    • IF_METAGENERATION_MATCH_FIELD_NUMBER

      public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
      See Also:

    • KMS_KEY_FIELD_NUMBER

      public static final int KMS_KEY_FIELD_NUMBER
      See Also:

    • COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

      public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
      See Also:

    • OBJECT_CHECKSUMS_FIELD_NUMBER

      public static final int OBJECT_CHECKSUMS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasDestination

      public boolean hasDestination()
       Required. Properties of the resulting object.
      .google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasDestination in interface ComposeObjectRequestOrBuilder
      Returns:
      Whether the destination field is set.

    • getDestination

      public Object getDestination()
       Required. Properties of the resulting object.
      .google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDestination in interface ComposeObjectRequestOrBuilder
      Returns:
      The destination.

    • getDestinationOrBuilder

      public ObjectOrBuilder getDestinationOrBuilder()
       Required. Properties of the resulting object.
      .google.storage.v2.Object destination = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDestinationOrBuilder in interface ComposeObjectRequestOrBuilder

    • getSourceObjectsList

      public List<ComposeObjectRequest.SourceObject> getSourceObjectsList()
       Optional. The list of source objects that will be concatenated into a
 single object.
      repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSourceObjectsList in interface ComposeObjectRequestOrBuilder

    • getSourceObjectsOrBuilderList

      public List<? extends ComposeObjectRequest.SourceObjectOrBuilder> getSourceObjectsOrBuilderList()
       Optional. The list of source objects that will be concatenated into a
 single object.
      repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSourceObjectsOrBuilderList in interface ComposeObjectRequestOrBuilder

    • getSourceObjectsCount

      public int getSourceObjectsCount()
       Optional. The list of source objects that will be concatenated into a
 single object.
      repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSourceObjectsCount in interface ComposeObjectRequestOrBuilder

    • getSourceObjects

      public ComposeObjectRequest.SourceObject getSourceObjects(int index)
       Optional. The list of source objects that will be concatenated into a
 single object.
      repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSourceObjects in interface ComposeObjectRequestOrBuilder

    • getSourceObjectsOrBuilder

      public ComposeObjectRequest.SourceObjectOrBuilder getSourceObjectsOrBuilder(int index)
       Optional. The list of source objects that will be concatenated into a
 single object.
      repeated .google.storage.v2.ComposeObjectRequest.SourceObject source_objects = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSourceObjectsOrBuilder in interface ComposeObjectRequestOrBuilder

    • getDestinationPredefinedAcl

      public String getDestinationPredefinedAcl()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDestinationPredefinedAcl in interface ComposeObjectRequestOrBuilder
      Returns:
      The destinationPredefinedAcl.

    • getDestinationPredefinedAclBytes

      public com.google.protobuf.ByteString getDestinationPredefinedAclBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDestinationPredefinedAclBytes in interface ComposeObjectRequestOrBuilder
      Returns:
      The bytes for destinationPredefinedAcl.

    • 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;
      Specified by:
      hasIfGenerationMatch in interface ComposeObjectRequestOrBuilder
      Returns:
      Whether the ifGenerationMatch field is set.

    • 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;
      Specified by:
      getIfGenerationMatch in interface ComposeObjectRequestOrBuilder
      Returns:
      The ifGenerationMatch.

    • 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;
      Specified by:
      hasIfMetagenerationMatch in interface ComposeObjectRequestOrBuilder
      Returns:
      Whether the ifMetagenerationMatch field is set.

    • 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;
      Specified by:
      getIfMetagenerationMatch in interface ComposeObjectRequestOrBuilder
      Returns:
      The ifMetagenerationMatch.

    • getKmsKey

      public String getKmsKey()
       Optional. 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKey in interface ComposeObjectRequestOrBuilder
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      public com.google.protobuf.ByteString getKmsKeyBytes()
       Optional. 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.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyBytes in interface ComposeObjectRequestOrBuilder
      Returns:
      The bytes for kmsKey.

    • hasCommonObjectRequestParams

      public boolean hasCommonObjectRequestParams()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCommonObjectRequestParams in interface ComposeObjectRequestOrBuilder
      Returns:
      Whether the commonObjectRequestParams field is set.

    • getCommonObjectRequestParams

      public CommonObjectRequestParams getCommonObjectRequestParams()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCommonObjectRequestParams in interface ComposeObjectRequestOrBuilder
      Returns:
      The commonObjectRequestParams.

    • getCommonObjectRequestParamsOrBuilder

      public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
       Optional. A set of parameters common to Storage API requests concerning an
 object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCommonObjectRequestParamsOrBuilder in interface ComposeObjectRequestOrBuilder

    • hasObjectChecksums

      public boolean hasObjectChecksums()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasObjectChecksums in interface ComposeObjectRequestOrBuilder
      Returns:
      Whether the objectChecksums field is set.

    • getObjectChecksums

      public ObjectChecksums getObjectChecksums()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getObjectChecksums in interface ComposeObjectRequestOrBuilder
      Returns:
      The objectChecksums.

    • getObjectChecksumsOrBuilder

      public ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getObjectChecksumsOrBuilder in interface ComposeObjectRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ComposeObjectRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComposeObjectRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComposeObjectRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComposeObjectRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComposeObjectRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComposeObjectRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ComposeObjectRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ComposeObjectRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ComposeObjectRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ComposeObjectRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ComposeObjectRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ComposeObjectRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ComposeObjectRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ComposeObjectRequest.Builder newBuilder()

    • newBuilder

      public static ComposeObjectRequest.Builder newBuilder(ComposeObjectRequest prototype)

    • toBuilder

      public ComposeObjectRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ComposeObjectRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ComposeObjectRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ComposeObjectRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ComposeObjectRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ComposeObjectRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder