Interface UploadRequest.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<UploadRequest.Builder,UploadRequest>
,SdkBuilder<UploadRequest.Builder,UploadRequest>
- Enclosing class:
- UploadRequest
@NotThreadSafe public static interface UploadRequest.Builder extends CopyableBuilder<UploadRequest.Builder,UploadRequest>
A builder for aUploadRequest
, created withUploadRequest.builder()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description UploadRequest.Builder
addTransferListener(TransferListener transferListener)
Add aTransferListener
that will be notified as part of this request.UploadRequest
build()
default UploadRequest.Builder
putObjectRequest(Consumer<PutObjectRequest.Builder> putObjectRequestBuilder)
Configure thePutObjectRequest
that should be used for the uploadUploadRequest.Builder
putObjectRequest(PutObjectRequest putObjectRequest)
Configure thePutObjectRequest
that should be used for the uploadUploadRequest.Builder
requestBody(AsyncRequestBody requestBody)
TheAsyncRequestBody
containing the data to send to the service.UploadRequest.Builder
transferListeners(Collection<TransferListener> transferListeners)
TheTransferListener
s 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 Detail
-
requestBody
UploadRequest.Builder requestBody(AsyncRequestBody requestBody)
TheAsyncRequestBody
containing the data to send to the service. Request bodies may be declared using one of the static factory methods in theAsyncRequestBody
class.- Parameters:
requestBody
- the request body- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AsyncRequestBody
-
putObjectRequest
UploadRequest.Builder putObjectRequest(PutObjectRequest putObjectRequest)
Configure thePutObjectRequest
that should be used for the upload- Parameters:
putObjectRequest
- the putObjectRequest- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
putObjectRequest(Consumer)
-
putObjectRequest
default UploadRequest.Builder putObjectRequest(Consumer<PutObjectRequest.Builder> putObjectRequestBuilder)
Configure thePutObjectRequest
that should be used for the uploadThis is a convenience method that creates an instance of the
PutObjectRequest
builder avoiding the need to create one manually viaPutObjectRequest.builder()
.- Parameters:
putObjectRequestBuilder
- the putObjectRequest consumer builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
putObjectRequest(PutObjectRequest)
-
transferListeners
UploadRequest.Builder transferListeners(Collection<TransferListener> transferListeners)
TheTransferListener
s 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
UploadRequest.Builder addTransferListener(TransferListener transferListener)
Add aTransferListener
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
UploadRequest build()
- Specified by:
build
in interfaceBuildable
- Specified by:
build
in interfaceSdkBuilder<UploadRequest.Builder,UploadRequest>
- Returns:
- The built request.
-
-