Package software.amazon.awssdk.transfer.s3.model

Interface CopyRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CopyRequest.Builder,CopyRequest>, SdkBuilder<CopyRequest.Builder,CopyRequest>

Enclosing class:

CopyRequest

@NotThreadSafe
public static interface CopyRequest.Builder
extends CopyableBuilder<CopyRequest.Builder,CopyRequest>

A builder for a CopyRequest, created with CopyRequest.builder()

Method Summary

Modifier and Type	Method	Description
CopyRequest.Builder	addTransferListener(TransferListener transferListener)	Adds a TransferListener that will be notified as part of this request.
CopyRequest	build()	An immutable object that is created from the properties that have been set on the builder.
default CopyRequest.Builder	copyObjectRequest(Consumer<CopyObjectRequest.Builder> copyRequestBuilder)	Configures the CopyRequest that should be used for the copy
CopyRequest.Builder	copyObjectRequest(CopyObjectRequest copyRequest)	Configures the CopyRequest that should be used for the copy
CopyRequest.Builder	transferListeners(Collection<TransferListener> transferListeners)	The TransferListeners that will be notified as part of this request.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Method Details

copyObjectRequest

CopyRequest.Builder copyObjectRequest(CopyObjectRequest copyRequest)

Configures the CopyRequest that should be used for the copy

Parameters:

copyRequest - the copyRequest

Returns:

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

See Also:

• copyObjectRequest(Consumer)

copyObjectRequest

default CopyRequest.Builder copyObjectRequest(Consumer<CopyObjectRequest.Builder> copyRequestBuilder)

Configures the CopyRequest that should be used for the copy

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

Parameters:

copyRequestBuilder - the copyRequest consumer builder

Returns:

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

See Also:

• copyObjectRequest(CopyObjectRequest)

transferListeners

CopyRequest.Builder transferListeners(Collection<TransferListener> transferListeners)

The TransferListeners that will be notified as part of this request. This method overrides and replaces any transferListeners that have already been set. Add an optional request override configuration.

Parameters:

transferListeners - the collection of transferListeners

Returns:

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

See Also:

• TransferListener

addTransferListener

CopyRequest.Builder addTransferListener(TransferListener transferListener)

Adds a TransferListener that will be notified as part of this request.

Parameters:

transferListener - the transferListener to add

Returns:

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

See Also:

• TransferListener

build

CopyRequest build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<CopyRequest.Builder,CopyRequest>

Returns:

The built request.