org.apache.hadoop.fs.s3a.api

Interface RequestFactory

All Known Implementing Classes:

RequestFactoryImpl

@InterfaceStability.Unstable
 @InterfaceAudience.LimitedPrivate(value="testing/diagnostics")
public interface RequestFactory

Factory for S3 request objects. This is where the owner FS's prepareRequest() callback is invoked to mark up a request for this span. All AWS request objects MUST BE created through this, in the active audit span. The standard implementation provides a callback for the S3AFS or tests to be invoked to prepare each request. Such callbacks SHOULD NOT raise exceptions other than argument validation exceptions. as there are no guarantees how they are processed. That is: no guarantees of retry or translation.

Method Summary

Modifier and Type	Method and Description
String	getCannedACL() Get the canned ACL of this FS.
String	getContentEncoding() Get the content encoding (e.g.
S3AEncryptionMethods	getServerSideEncryptionAlgorithm() Get the encryption algorithm of this endpoint.
software.amazon.awssdk.services.s3.model.StorageClass	getStorageClass() Get the object storage class, return null if none.
software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest.Builder	newAbortMultipartUploadRequestBuilder(String destKey, String uploadId) Abort a multipart upload.
software.amazon.awssdk.services.s3.model.DeleteObjectsRequest.Builder	newBulkDeleteRequestBuilder(List<software.amazon.awssdk.services.s3.model.ObjectIdentifier> keysToDelete) Create a request builder to delete objects in bulk.
software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest.Builder	newCompleteMultipartUploadRequestBuilder(String destKey, String uploadId, List<software.amazon.awssdk.services.s3.model.CompletedPart> partETags) Complete a multipart upload.
software.amazon.awssdk.services.s3.model.CopyObjectRequest.Builder	newCopyObjectRequestBuilder(String srcKey, String dstKey, software.amazon.awssdk.services.s3.model.HeadObjectResponse srcom) Create a copy request builder.
software.amazon.awssdk.services.s3.model.DeleteObjectRequest.Builder	newDeleteObjectRequestBuilder(String key) Create a request builder to delete a single object.
software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder	newDirectoryMarkerRequest(String directory) Create a PutObjectRequest request for creating an empty directory.
software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder	newGetObjectRequestBuilder(String key) Create a GET request builder.
software.amazon.awssdk.services.s3.model.HeadBucketRequest.Builder	newHeadBucketRequestBuilder(String bucket) Create a HEAD bucket request builder.
software.amazon.awssdk.services.s3.model.HeadObjectRequest.Builder	newHeadObjectRequestBuilder(String key) Create a HEAD object request builder.
software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest.Builder	newListMultipartUploadsRequestBuilder(String prefix) List all multipart uploads under a prefix.
software.amazon.awssdk.services.s3.model.ListObjectsRequest.Builder	newListObjectsV1RequestBuilder(String key, String delimiter, int maxKeys) Create the (legacy) V1 list request builder.
software.amazon.awssdk.services.s3.model.ListObjectsV2Request.Builder	newListObjectsV2RequestBuilder(String key, String delimiter, int maxKeys) Create a V2 list request builder.
software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest.Builder	newMultipartUploadRequestBuilder(String destKey, PutObjectOptions options) Start a multipart upload.
software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder	newPutObjectRequestBuilder(String key, PutObjectOptions options, long length, boolean isDirectoryMarker) Create a PutObjectRequest request builder.
software.amazon.awssdk.services.s3.model.UploadPartRequest.Builder	newUploadPartRequestBuilder(String destKey, String uploadId, int partNumber, long size) Create and initialize a part request builder of a multipart upload.
void	setEncryptionSecrets(EncryptionSecrets secrets) Set the encryption secrets for all subsequent requests.

Method Detail

setEncryptionSecrets

void setEncryptionSecrets(EncryptionSecrets secrets)

Set the encryption secrets for all subsequent requests.

Parameters:

secrets - encryption secrets.

getCannedACL

String getCannedACL()

Get the canned ACL of this FS.

Returns:

an ACL, if any

getServerSideEncryptionAlgorithm

S3AEncryptionMethods getServerSideEncryptionAlgorithm()

Get the encryption algorithm of this endpoint.

Returns:

the encryption algorithm.

getContentEncoding

String getContentEncoding()

Get the content encoding (e.g. gzip) or return null if none.

Returns:

content encoding

getStorageClass

software.amazon.awssdk.services.s3.model.StorageClass getStorageClass()

Get the object storage class, return null if none.

Returns:

storage class

newCopyObjectRequestBuilder

software.amazon.awssdk.services.s3.model.CopyObjectRequest.Builder newCopyObjectRequestBuilder(String srcKey,
                                                                                               String dstKey,
                                                                                               software.amazon.awssdk.services.s3.model.HeadObjectResponse srcom)

Create a copy request builder. This includes the work of copying the relevant parts of the metadata from the source

Parameters:

srcKey - source

dstKey - destination

srcom - source object metadata.

Returns:

the request builder

newPutObjectRequestBuilder

software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder newPutObjectRequestBuilder(String key,
                                                                                             PutObjectOptions options,
                                                                                             long length,
                                                                                             boolean isDirectoryMarker)

Create a PutObjectRequest request builder. The metadata is assumed to have been configured with the size of the operation.

Parameters:

key - key of object

options - options for the request

length - length of object to be uploaded

isDirectoryMarker - true if object to be uploaded is a directory marker

Returns:

the request builder

newDirectoryMarkerRequest

software.amazon.awssdk.services.s3.model.PutObjectRequest.Builder newDirectoryMarkerRequest(String directory)

Create a PutObjectRequest request for creating an empty directory.

Parameters:

directory - destination directory.

Returns:

request builder for a zero byte upload.

newListMultipartUploadsRequestBuilder

software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest.Builder newListMultipartUploadsRequestBuilder(@Nullable
                                                                                                                   String prefix)

List all multipart uploads under a prefix.

Parameters:

prefix - prefix to list under

Returns:

the request builder.

newAbortMultipartUploadRequestBuilder

software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest.Builder newAbortMultipartUploadRequestBuilder(String destKey,
                                                                                                                   String uploadId)

Abort a multipart upload.

Parameters:

destKey - destination object key

uploadId - ID of initiated upload

Returns:

the request builder.

newMultipartUploadRequestBuilder

software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest.Builder newMultipartUploadRequestBuilder(String destKey,
                                                                                                               @Nullable
                                                                                                               PutObjectOptions options)
                                                                                                        throws org.apache.hadoop.fs.PathIOException

Start a multipart upload.

Parameters:

destKey - destination object key

options - options for the request

Returns:

the request builder.

Throws:

org.apache.hadoop.fs.PathIOException - if multipart uploads are disabled

newCompleteMultipartUploadRequestBuilder

software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest.Builder newCompleteMultipartUploadRequestBuilder(String destKey,
                                                                                                                         String uploadId,
                                                                                                                         List<software.amazon.awssdk.services.s3.model.CompletedPart> partETags)

Complete a multipart upload.

Parameters:

destKey - destination object key

uploadId - ID of initiated upload

partETags - ordered list of etags

Returns:

the request builder.

newHeadObjectRequestBuilder

software.amazon.awssdk.services.s3.model.HeadObjectRequest.Builder newHeadObjectRequestBuilder(String key)

Create a HEAD object request builder.

Parameters:

key - key, may have trailing /

Returns:

the request builder.

newHeadBucketRequestBuilder

software.amazon.awssdk.services.s3.model.HeadBucketRequest.Builder newHeadBucketRequestBuilder(String bucket)

Create a HEAD bucket request builder.

Parameters:

bucket - bucket to get metadata for

Returns:

the request builder.

newGetObjectRequestBuilder

software.amazon.awssdk.services.s3.model.GetObjectRequest.Builder newGetObjectRequestBuilder(String key)

Create a GET request builder.

Parameters:

key - object key

Returns:

the request builder.

newUploadPartRequestBuilder

software.amazon.awssdk.services.s3.model.UploadPartRequest.Builder newUploadPartRequestBuilder(String destKey,
                                                                                               String uploadId,
                                                                                               int partNumber,
                                                                                               long size)
                                                                                        throws org.apache.hadoop.fs.PathIOException

Create and initialize a part request builder of a multipart upload.

Parameters:

destKey - destination key of ongoing operation

uploadId - ID of ongoing upload

partNumber - current part number of the upload

size - amount of data

Returns:

the request builder.

Throws:

org.apache.hadoop.fs.PathIOException - if the part number is out of range.

newListObjectsV1RequestBuilder

software.amazon.awssdk.services.s3.model.ListObjectsRequest.Builder newListObjectsV1RequestBuilder(String key,
                                                                                                   String delimiter,
                                                                                                   int maxKeys)

Create the (legacy) V1 list request builder.

Parameters:

key - key to list under

delimiter - delimiter for keys

maxKeys - maximum number in a list page.

Returns:

the request builder.

newListObjectsV2RequestBuilder

software.amazon.awssdk.services.s3.model.ListObjectsV2Request.Builder newListObjectsV2RequestBuilder(String key,
                                                                                                     String delimiter,
                                                                                                     int maxKeys)

Create a V2 list request builder. This will be recycled for any subsequent requests.

Parameters:

key - key to list under

delimiter - delimiter for keys

maxKeys - maximum number in a list page.

Returns:

the request builder.

newDeleteObjectRequestBuilder

software.amazon.awssdk.services.s3.model.DeleteObjectRequest.Builder newDeleteObjectRequestBuilder(String key)

Create a request builder to delete a single object.

Parameters:

key - object to delete

Returns:

the request builder.

newBulkDeleteRequestBuilder

software.amazon.awssdk.services.s3.model.DeleteObjectsRequest.Builder newBulkDeleteRequestBuilder(List<software.amazon.awssdk.services.s3.model.ObjectIdentifier> keysToDelete)

Create a request builder to delete objects in bulk.

Parameters:

keysToDelete - list of keys to delete.

Returns:

the request builder.