Package software.amazon.awssdk.services.s3control.model

Interface S3CopyObjectOperation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>, SdkBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>, SdkPojo
Enclosing class:
S3CopyObjectOperation
public static interface S3CopyObjectOperation.Builder extends SdkPojo, CopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>

  • Method Details

    • targetResource

      S3CopyObjectOperation.Builder targetResource(String targetResource)

      Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation. For example, to copy objects to a bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

      Parameters:
      targetResource - Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation. For example, to copy objects to a bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cannedAccessControlList

      S3CopyObjectOperation.Builder cannedAccessControlList(String cannedAccessControlList)

      Parameters:
      cannedAccessControlList -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cannedAccessControlList

      S3CopyObjectOperation.Builder cannedAccessControlList(S3CannedAccessControlList cannedAccessControlList)

      Parameters:
      cannedAccessControlList -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessControlGrants

      S3CopyObjectOperation.Builder accessControlGrants(Collection<S3Grant> accessControlGrants)

      Parameters:
      accessControlGrants -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessControlGrants

      S3CopyObjectOperation.Builder accessControlGrants(S3Grant... accessControlGrants)

      Parameters:
      accessControlGrants -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessControlGrants

      S3CopyObjectOperation.Builder accessControlGrants(Consumer<S3Grant.Builder>... accessControlGrants)

      This is a convenience method that creates an instance of the S3Grant.Builder avoiding the need to create one manually via S3Grant.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessControlGrants(List<S3Grant>).

      Parameters:
      accessControlGrants - a consumer that will call methods on S3Grant.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadataDirective

      S3CopyObjectOperation.Builder metadataDirective(String metadataDirective)

      Parameters:
      metadataDirective -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadataDirective

      S3CopyObjectOperation.Builder metadataDirective(S3MetadataDirective metadataDirective)

      Parameters:
      metadataDirective -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modifiedSinceConstraint

      S3CopyObjectOperation.Builder modifiedSinceConstraint(Instant modifiedSinceConstraint)

      Parameters:
      modifiedSinceConstraint -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newObjectMetadata

      S3CopyObjectOperation.Builder newObjectMetadata(S3ObjectMetadata newObjectMetadata)

      If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

      Parameters:
      newObjectMetadata - If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newObjectMetadata

      default S3CopyObjectOperation.Builder newObjectMetadata(Consumer<S3ObjectMetadata.Builder> newObjectMetadata)

      If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

      This is a convenience method that creates an instance of the S3ObjectMetadata.Builder avoiding the need to create one manually via S3ObjectMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to newObjectMetadata(S3ObjectMetadata).

      Parameters:
      newObjectMetadata - a consumer that will call methods on S3ObjectMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • newObjectTagging

      S3CopyObjectOperation.Builder newObjectTagging(Collection<S3Tag> newObjectTagging)

      Parameters:
      newObjectTagging -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newObjectTagging

      S3CopyObjectOperation.Builder newObjectTagging(S3Tag... newObjectTagging)

      Parameters:
      newObjectTagging -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newObjectTagging

      S3CopyObjectOperation.Builder newObjectTagging(Consumer<S3Tag.Builder>... newObjectTagging)

      This is a convenience method that creates an instance of the S3Tag.Builder avoiding the need to create one manually via S3Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to newObjectTagging(List<S3Tag>).

      Parameters:
      newObjectTagging - a consumer that will call methods on S3Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • redirectLocation

      S3CopyObjectOperation.Builder redirectLocation(String redirectLocation)

      Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.

      Parameters:
      redirectLocation - Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requesterPays

      S3CopyObjectOperation.Builder requesterPays(Boolean requesterPays)

      Parameters:
      requesterPays -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageClass

      S3CopyObjectOperation.Builder storageClass(String storageClass)

      Parameters:
      storageClass -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageClass

      S3CopyObjectOperation.Builder storageClass(S3StorageClass storageClass)

      Parameters:
      storageClass -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • unModifiedSinceConstraint

      S3CopyObjectOperation.Builder unModifiedSinceConstraint(Instant unModifiedSinceConstraint)

      Parameters:
      unModifiedSinceConstraint -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseAwsKmsKeyId

      S3CopyObjectOperation.Builder sseAwsKmsKeyId(String sseAwsKmsKeyId)

      Parameters:
      sseAwsKmsKeyId -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetKeyPrefix

      S3CopyObjectOperation.Builder targetKeyPrefix(String targetKeyPrefix)

      Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix property to Folder1.

      Parameters:
      targetKeyPrefix - Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix property to Folder1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objectLockLegalHoldStatus

      S3CopyObjectOperation.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)

      The legal hold status to be applied to all objects in the Batch Operations job.

      Parameters:
      objectLockLegalHoldStatus - The legal hold status to be applied to all objects in the Batch Operations job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockLegalHoldStatus

      S3CopyObjectOperation.Builder objectLockLegalHoldStatus(S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus)

      The legal hold status to be applied to all objects in the Batch Operations job.

      Parameters:
      objectLockLegalHoldStatus - The legal hold status to be applied to all objects in the Batch Operations job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockMode

      S3CopyObjectOperation.Builder objectLockMode(String objectLockMode)

      The retention mode to be applied to all objects in the Batch Operations job.

      Parameters:
      objectLockMode - The retention mode to be applied to all objects in the Batch Operations job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockMode

      S3CopyObjectOperation.Builder objectLockMode(S3ObjectLockMode objectLockMode)

      The retention mode to be applied to all objects in the Batch Operations job.

      Parameters:
      objectLockMode - The retention mode to be applied to all objects in the Batch Operations job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockRetainUntilDate

      S3CopyObjectOperation.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)

      The date when the applied object retention configuration expires on all objects in the Batch Operations job.

      Parameters:
      objectLockRetainUntilDate - The date when the applied object retention configuration expires on all objects in the Batch Operations job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketKeyEnabled

      S3CopyObjectOperation.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)

      Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

      Parameters:
      bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

      Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumAlgorithm

      S3CopyObjectOperation.Builder checksumAlgorithm(String checksumAlgorithm)

      Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumAlgorithm - Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checksumAlgorithm

      S3CopyObjectOperation.Builder checksumAlgorithm(S3ChecksumAlgorithm checksumAlgorithm)

      Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumAlgorithm - Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: