@Generated(value="software.amazon.awssdk:codegen") public interface S3AsyncClient extends SdkClient
builder()
method.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AbortMultipartUploadResponse> |
abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
Aborts a multipart upload.
|
default CompletableFuture<AbortMultipartUploadResponse> |
abortMultipartUpload(Consumer<AbortMultipartUploadRequest.Builder> abortMultipartUploadRequest)
Aborts a multipart upload.
|
static S3AsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
S3AsyncClient . |
default CompletableFuture<CompleteMultipartUploadResponse> |
completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
Completes a multipart upload by assembling previously uploaded parts.
|
default CompletableFuture<CompleteMultipartUploadResponse> |
completeMultipartUpload(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest)
Completes a multipart upload by assembling previously uploaded parts.
|
default CompletableFuture<CopyObjectResponse> |
copyObject(Consumer<CopyObjectRequest.Builder> copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
|
default CompletableFuture<CopyObjectResponse> |
copyObject(CopyObjectRequest copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
|
static S3AsyncClient |
create()
Create a
S3AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateBucketResponse> |
createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
Creates a new bucket.
|
default CompletableFuture<CreateBucketResponse> |
createBucket(CreateBucketRequest createBucketRequest)
Creates a new bucket.
|
default CompletableFuture<CreateMultipartUploadResponse> |
createMultipartUpload(Consumer<CreateMultipartUploadRequest.Builder> createMultipartUploadRequest)
Initiates a multipart upload and returns an upload ID.
|
default CompletableFuture<CreateMultipartUploadResponse> |
createMultipartUpload(CreateMultipartUploadRequest createMultipartUploadRequest)
Initiates a multipart upload and returns an upload ID.
|
default CompletableFuture<DeleteBucketResponse> |
deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
Deletes the bucket.
|
default CompletableFuture<DeleteBucketResponse> |
deleteBucket(DeleteBucketRequest deleteBucketRequest)
Deletes the bucket.
|
default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> |
deleteBucketAnalyticsConfiguration(Consumer<DeleteBucketAnalyticsConfigurationRequest.Builder> deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> |
deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<DeleteBucketCorsResponse> |
deleteBucketCors(Consumer<DeleteBucketCorsRequest.Builder> deleteBucketCorsRequest)
Deletes the CORS configuration information set for the bucket.
|
default CompletableFuture<DeleteBucketCorsResponse> |
deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest)
Deletes the CORS configuration information set for the bucket.
|
default CompletableFuture<DeleteBucketEncryptionResponse> |
deleteBucketEncryption(Consumer<DeleteBucketEncryptionRequest.Builder> deleteBucketEncryptionRequest)
Deletes the server-side encryption configuration from the bucket.
|
default CompletableFuture<DeleteBucketEncryptionResponse> |
deleteBucketEncryption(DeleteBucketEncryptionRequest deleteBucketEncryptionRequest)
Deletes the server-side encryption configuration from the bucket.
|
default CompletableFuture<DeleteBucketInventoryConfigurationResponse> |
deleteBucketInventoryConfiguration(Consumer<DeleteBucketInventoryConfigurationRequest.Builder> deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<DeleteBucketInventoryConfigurationResponse> |
deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<DeleteBucketLifecycleResponse> |
deleteBucketLifecycle(Consumer<DeleteBucketLifecycleRequest.Builder> deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the bucket.
|
default CompletableFuture<DeleteBucketLifecycleResponse> |
deleteBucketLifecycle(DeleteBucketLifecycleRequest deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the bucket.
|
default CompletableFuture<DeleteBucketMetricsConfigurationResponse> |
deleteBucketMetricsConfiguration(Consumer<DeleteBucketMetricsConfigurationRequest.Builder> deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default CompletableFuture<DeleteBucketMetricsConfigurationResponse> |
deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default CompletableFuture<DeleteBucketPolicyResponse> |
deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
Deletes the policy from the bucket.
|
default CompletableFuture<DeleteBucketPolicyResponse> |
deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
Deletes the policy from the bucket.
|
default CompletableFuture<DeleteBucketReplicationResponse> |
deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket.
|
default CompletableFuture<DeleteBucketReplicationResponse> |
deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket.
|
default CompletableFuture<DeleteBucketTaggingResponse> |
deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
Deletes the tags from the bucket.
|
default CompletableFuture<DeleteBucketTaggingResponse> |
deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
Deletes the tags from the bucket.
|
default CompletableFuture<DeleteBucketWebsiteResponse> |
deleteBucketWebsite(Consumer<DeleteBucketWebsiteRequest.Builder> deleteBucketWebsiteRequest)
This operation removes the website configuration from the bucket.
|
default CompletableFuture<DeleteBucketWebsiteResponse> |
deleteBucketWebsite(DeleteBucketWebsiteRequest deleteBucketWebsiteRequest)
This operation removes the website configuration from the bucket.
|
default CompletableFuture<DeleteObjectResponse> |
deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest
version of the object.
|
default CompletableFuture<DeleteObjectResponse> |
deleteObject(DeleteObjectRequest deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest
version of the object.
|
default CompletableFuture<DeleteObjectsResponse> |
deleteObjects(Consumer<DeleteObjectsRequest.Builder> deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request.
|
default CompletableFuture<DeleteObjectsResponse> |
deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request.
|
default CompletableFuture<DeleteObjectTaggingResponse> |
deleteObjectTagging(Consumer<DeleteObjectTaggingRequest.Builder> deleteObjectTaggingRequest)
Removes the tag-set from an existing object.
|
default CompletableFuture<DeleteObjectTaggingResponse> |
deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest)
Removes the tag-set from an existing object.
|
default CompletableFuture<DeletePublicAccessBlockResponse> |
deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration from an Amazon S3 bucket. |
default CompletableFuture<DeletePublicAccessBlockResponse> |
deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration from an Amazon S3 bucket. |
default CompletableFuture<GetBucketAccelerateConfigurationResponse> |
getBucketAccelerateConfiguration(Consumer<GetBucketAccelerateConfigurationRequest.Builder> getBucketAccelerateConfigurationRequest)
Returns the accelerate configuration of a bucket.
|
default CompletableFuture<GetBucketAccelerateConfigurationResponse> |
getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest)
Returns the accelerate configuration of a bucket.
|
default CompletableFuture<GetBucketAclResponse> |
getBucketAcl(Consumer<GetBucketAclRequest.Builder> getBucketAclRequest)
Gets the access control policy for the bucket.
|
default CompletableFuture<GetBucketAclResponse> |
getBucketAcl(GetBucketAclRequest getBucketAclRequest)
Gets the access control policy for the bucket.
|
default CompletableFuture<GetBucketAnalyticsConfigurationResponse> |
getBucketAnalyticsConfiguration(Consumer<GetBucketAnalyticsConfigurationRequest.Builder> getBucketAnalyticsConfigurationRequest)
Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<GetBucketAnalyticsConfigurationResponse> |
getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest)
Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<GetBucketCorsResponse> |
getBucketCors(Consumer<GetBucketCorsRequest.Builder> getBucketCorsRequest)
Returns the CORS configuration for the bucket.
|
default CompletableFuture<GetBucketCorsResponse> |
getBucketCors(GetBucketCorsRequest getBucketCorsRequest)
Returns the CORS configuration for the bucket.
|
default CompletableFuture<GetBucketEncryptionResponse> |
getBucketEncryption(Consumer<GetBucketEncryptionRequest.Builder> getBucketEncryptionRequest)
Returns the server-side encryption configuration of a bucket.
|
default CompletableFuture<GetBucketEncryptionResponse> |
getBucketEncryption(GetBucketEncryptionRequest getBucketEncryptionRequest)
Returns the server-side encryption configuration of a bucket.
|
default CompletableFuture<GetBucketInventoryConfigurationResponse> |
getBucketInventoryConfiguration(Consumer<GetBucketInventoryConfigurationRequest.Builder> getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<GetBucketInventoryConfigurationResponse> |
getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<GetBucketLifecycleConfigurationResponse> |
getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
Returns the lifecycle configuration information set on the bucket.
|
default CompletableFuture<GetBucketLifecycleConfigurationResponse> |
getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
Returns the lifecycle configuration information set on the bucket.
|
default CompletableFuture<GetBucketLocationResponse> |
getBucketLocation(Consumer<GetBucketLocationRequest.Builder> getBucketLocationRequest)
Returns the region the bucket resides in.
|
default CompletableFuture<GetBucketLocationResponse> |
getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
Returns the region the bucket resides in.
|
default CompletableFuture<GetBucketLoggingResponse> |
getBucketLogging(Consumer<GetBucketLoggingRequest.Builder> getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status.
|
default CompletableFuture<GetBucketLoggingResponse> |
getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status.
|
default CompletableFuture<GetBucketMetricsConfigurationResponse> |
getBucketMetricsConfiguration(Consumer<GetBucketMetricsConfigurationRequest.Builder> getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default CompletableFuture<GetBucketMetricsConfigurationResponse> |
getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default CompletableFuture<GetBucketNotificationConfigurationResponse> |
getBucketNotificationConfiguration(Consumer<GetBucketNotificationConfigurationRequest.Builder> getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
|
default CompletableFuture<GetBucketNotificationConfigurationResponse> |
getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
|
default CompletableFuture<GetBucketPolicyResponse> |
getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
Returns the policy of a specified bucket.
|
default CompletableFuture<GetBucketPolicyResponse> |
getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
Returns the policy of a specified bucket.
|
default CompletableFuture<GetBucketPolicyStatusResponse> |
getBucketPolicyStatus(Consumer<GetBucketPolicyStatusRequest.Builder> getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
|
default CompletableFuture<GetBucketPolicyStatusResponse> |
getBucketPolicyStatus(GetBucketPolicyStatusRequest getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
|
default CompletableFuture<GetBucketReplicationResponse> |
getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
Returns the replication configuration of a bucket.
|
default CompletableFuture<GetBucketReplicationResponse> |
getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
Returns the replication configuration of a bucket.
|
default CompletableFuture<GetBucketRequestPaymentResponse> |
getBucketRequestPayment(Consumer<GetBucketRequestPaymentRequest.Builder> getBucketRequestPaymentRequest)
Returns the request payment configuration of a bucket.
|
default CompletableFuture<GetBucketRequestPaymentResponse> |
getBucketRequestPayment(GetBucketRequestPaymentRequest getBucketRequestPaymentRequest)
Returns the request payment configuration of a bucket.
|
default CompletableFuture<GetBucketTaggingResponse> |
getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
Returns the tag set associated with the bucket.
|
default CompletableFuture<GetBucketTaggingResponse> |
getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
Returns the tag set associated with the bucket.
|
default CompletableFuture<GetBucketVersioningResponse> |
getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)
Returns the versioning state of a bucket.
|
default CompletableFuture<GetBucketVersioningResponse> |
getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
Returns the versioning state of a bucket.
|
default CompletableFuture<GetBucketWebsiteResponse> |
getBucketWebsite(Consumer<GetBucketWebsiteRequest.Builder> getBucketWebsiteRequest)
Returns the website configuration for a bucket.
|
default CompletableFuture<GetBucketWebsiteResponse> |
getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest)
Returns the website configuration for a bucket.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3.
|
default CompletableFuture<GetObjectResponse> |
getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
Path destinationPath)
Retrieves objects from Amazon S3.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObject(GetObjectRequest getObjectRequest,
AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3.
|
default CompletableFuture<GetObjectResponse> |
getObject(GetObjectRequest getObjectRequest,
Path destinationPath)
Retrieves objects from Amazon S3.
|
default CompletableFuture<GetObjectAclResponse> |
getObjectAcl(Consumer<GetObjectAclRequest.Builder> getObjectAclRequest)
Returns the access control list (ACL) of an object.
|
default CompletableFuture<GetObjectAclResponse> |
getObjectAcl(GetObjectAclRequest getObjectAclRequest)
Returns the access control list (ACL) of an object.
|
default CompletableFuture<GetObjectLegalHoldResponse> |
getObjectLegalHold(Consumer<GetObjectLegalHoldRequest.Builder> getObjectLegalHoldRequest)
Gets an object's current Legal Hold status.
|
default CompletableFuture<GetObjectLegalHoldResponse> |
getObjectLegalHold(GetObjectLegalHoldRequest getObjectLegalHoldRequest)
Gets an object's current Legal Hold status.
|
default CompletableFuture<GetObjectLockConfigurationResponse> |
getObjectLockConfiguration(Consumer<GetObjectLockConfigurationRequest.Builder> getObjectLockConfigurationRequest)
Gets the object lock configuration for a bucket.
|
default CompletableFuture<GetObjectLockConfigurationResponse> |
getObjectLockConfiguration(GetObjectLockConfigurationRequest getObjectLockConfigurationRequest)
Gets the object lock configuration for a bucket.
|
default CompletableFuture<GetObjectRetentionResponse> |
getObjectRetention(Consumer<GetObjectRetentionRequest.Builder> getObjectRetentionRequest)
Retrieves an object's retention settings.
|
default CompletableFuture<GetObjectRetentionResponse> |
getObjectRetention(GetObjectRetentionRequest getObjectRetentionRequest)
Retrieves an object's retention settings.
|
default CompletableFuture<GetObjectTaggingResponse> |
getObjectTagging(Consumer<GetObjectTaggingRequest.Builder> getObjectTaggingRequest)
Returns the tag-set of an object.
|
default CompletableFuture<GetObjectTaggingResponse> |
getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest)
Returns the tag-set of an object.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest,
AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Return torrent files from a bucket.
|
default CompletableFuture<GetObjectTorrentResponse> |
getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest,
Path destinationPath)
Return torrent files from a bucket.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Return torrent files from a bucket.
|
default CompletableFuture<GetObjectTorrentResponse> |
getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
Path destinationPath)
Return torrent files from a bucket.
|
default CompletableFuture<GetPublicAccessBlockResponse> |
getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<GetPublicAccessBlockResponse> |
getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<HeadBucketResponse> |
headBucket(Consumer<HeadBucketRequest.Builder> headBucketRequest)
This operation is useful to determine if a bucket exists and you have permission to access it.
|
default CompletableFuture<HeadBucketResponse> |
headBucket(HeadBucketRequest headBucketRequest)
This operation is useful to determine if a bucket exists and you have permission to access it.
|
default CompletableFuture<HeadObjectResponse> |
headObject(Consumer<HeadObjectRequest.Builder> headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself.
|
default CompletableFuture<HeadObjectResponse> |
headObject(HeadObjectRequest headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself.
|
default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> |
listBucketAnalyticsConfigurations(Consumer<ListBucketAnalyticsConfigurationsRequest.Builder> listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket.
|
default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> |
listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket.
|
default CompletableFuture<ListBucketInventoryConfigurationsResponse> |
listBucketInventoryConfigurations(Consumer<ListBucketInventoryConfigurationsRequest.Builder> listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket.
|
default CompletableFuture<ListBucketInventoryConfigurationsResponse> |
listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket.
|
default CompletableFuture<ListBucketMetricsConfigurationsResponse> |
listBucketMetricsConfigurations(Consumer<ListBucketMetricsConfigurationsRequest.Builder> listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket.
|
default CompletableFuture<ListBucketMetricsConfigurationsResponse> |
listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket.
|
default CompletableFuture<ListBucketsResponse> |
listBuckets()
Returns a list of all buckets owned by the authenticated sender of the request.
|
default CompletableFuture<ListBucketsResponse> |
listBuckets(Consumer<ListBucketsRequest.Builder> listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
|
default CompletableFuture<ListBucketsResponse> |
listBuckets(ListBucketsRequest listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
|
default CompletableFuture<ListMultipartUploadsResponse> |
listMultipartUploads(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default CompletableFuture<ListMultipartUploadsResponse> |
listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default ListMultipartUploadsPublisher |
listMultipartUploadsPaginator(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default ListMultipartUploadsPublisher |
listMultipartUploadsPaginator(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default CompletableFuture<ListObjectsResponse> |
listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
Returns some or all (up to 1000) of the objects in a bucket.
|
default CompletableFuture<ListObjectsResponse> |
listObjects(ListObjectsRequest listObjectsRequest)
Returns some or all (up to 1000) of the objects in a bucket.
|
default CompletableFuture<ListObjectsV2Response> |
listObjectsV2(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket.
|
default CompletableFuture<ListObjectsV2Response> |
listObjectsV2(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket.
|
default ListObjectsV2Publisher |
listObjectsV2Paginator(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket.
|
default ListObjectsV2Publisher |
listObjectsV2Paginator(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket.
|
default CompletableFuture<ListObjectVersionsResponse> |
listObjectVersions(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
|
default CompletableFuture<ListObjectVersionsResponse> |
listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
|
default ListObjectVersionsPublisher |
listObjectVersionsPaginator(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
|
default ListObjectVersionsPublisher |
listObjectVersionsPaginator(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
|
default CompletableFuture<ListPartsResponse> |
listParts(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default CompletableFuture<ListPartsResponse> |
listParts(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default ListPartsPublisher |
listPartsPaginator(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default ListPartsPublisher |
listPartsPaginator(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default CompletableFuture<PutBucketAccelerateConfigurationResponse> |
putBucketAccelerateConfiguration(Consumer<PutBucketAccelerateConfigurationRequest.Builder> putBucketAccelerateConfigurationRequest)
Sets the accelerate configuration of an existing bucket.
|
default CompletableFuture<PutBucketAccelerateConfigurationResponse> |
putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest)
Sets the accelerate configuration of an existing bucket.
|
default CompletableFuture<PutBucketAclResponse> |
putBucketAcl(Consumer<PutBucketAclRequest.Builder> putBucketAclRequest)
Sets the permissions on a bucket using access control lists (ACL).
|
default CompletableFuture<PutBucketAclResponse> |
putBucketAcl(PutBucketAclRequest putBucketAclRequest)
Sets the permissions on a bucket using access control lists (ACL).
|
default CompletableFuture<PutBucketAnalyticsConfigurationResponse> |
putBucketAnalyticsConfiguration(Consumer<PutBucketAnalyticsConfigurationRequest.Builder> putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<PutBucketAnalyticsConfigurationResponse> |
putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<PutBucketCorsResponse> |
putBucketCors(Consumer<PutBucketCorsRequest.Builder> putBucketCorsRequest)
Sets the CORS configuration for a bucket.
|
default CompletableFuture<PutBucketCorsResponse> |
putBucketCors(PutBucketCorsRequest putBucketCorsRequest)
Sets the CORS configuration for a bucket.
|
default CompletableFuture<PutBucketEncryptionResponse> |
putBucketEncryption(Consumer<PutBucketEncryptionRequest.Builder> putBucketEncryptionRequest)
Creates a new server-side encryption configuration (or replaces an existing one, if present).
|
default CompletableFuture<PutBucketEncryptionResponse> |
putBucketEncryption(PutBucketEncryptionRequest putBucketEncryptionRequest)
Creates a new server-side encryption configuration (or replaces an existing one, if present).
|
default CompletableFuture<PutBucketInventoryConfigurationResponse> |
putBucketInventoryConfiguration(Consumer<PutBucketInventoryConfigurationRequest.Builder> putBucketInventoryConfigurationRequest)
Adds an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<PutBucketInventoryConfigurationResponse> |
putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest)
Adds an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<PutBucketLifecycleConfigurationResponse> |
putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
Sets lifecycle configuration for your bucket.
|
default CompletableFuture<PutBucketLifecycleConfigurationResponse> |
putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
Sets lifecycle configuration for your bucket.
|
default CompletableFuture<PutBucketLoggingResponse> |
putBucketLogging(Consumer<PutBucketLoggingRequest.Builder> putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging
parameters.
|
default CompletableFuture<PutBucketLoggingResponse> |
putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging
parameters.
|
default CompletableFuture<PutBucketMetricsConfigurationResponse> |
putBucketMetricsConfiguration(Consumer<PutBucketMetricsConfigurationRequest.Builder> putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
default CompletableFuture<PutBucketMetricsConfigurationResponse> |
putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
default CompletableFuture<PutBucketNotificationConfigurationResponse> |
putBucketNotificationConfiguration(Consumer<PutBucketNotificationConfigurationRequest.Builder> putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
|
default CompletableFuture<PutBucketNotificationConfigurationResponse> |
putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
|
default CompletableFuture<PutBucketPolicyResponse> |
putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
|
default CompletableFuture<PutBucketPolicyResponse> |
putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
|
default CompletableFuture<PutBucketReplicationResponse> |
putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one.
|
default CompletableFuture<PutBucketReplicationResponse> |
putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one.
|
default CompletableFuture<PutBucketRequestPaymentResponse> |
putBucketRequestPayment(Consumer<PutBucketRequestPaymentRequest.Builder> putBucketRequestPaymentRequest)
Sets the request payment configuration for a bucket.
|
default CompletableFuture<PutBucketRequestPaymentResponse> |
putBucketRequestPayment(PutBucketRequestPaymentRequest putBucketRequestPaymentRequest)
Sets the request payment configuration for a bucket.
|
default CompletableFuture<PutBucketTaggingResponse> |
putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
Sets the tags for a bucket.
|
default CompletableFuture<PutBucketTaggingResponse> |
putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
Sets the tags for a bucket.
|
default CompletableFuture<PutBucketVersioningResponse> |
putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)
Sets the versioning state of an existing bucket.
|
default CompletableFuture<PutBucketVersioningResponse> |
putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
Sets the versioning state of an existing bucket.
|
default CompletableFuture<PutBucketWebsiteResponse> |
putBucketWebsite(Consumer<PutBucketWebsiteRequest.Builder> putBucketWebsiteRequest)
Set the website configuration for a bucket.
|
default CompletableFuture<PutBucketWebsiteResponse> |
putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest)
Set the website configuration for a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
AsyncRequestBody requestBody)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
Path sourcePath)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(PutObjectRequest putObjectRequest,
AsyncRequestBody requestBody)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(PutObjectRequest putObjectRequest,
Path sourcePath)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectAclResponse> |
putObjectAcl(Consumer<PutObjectAclRequest.Builder> putObjectAclRequest)
uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a
bucket
|
default CompletableFuture<PutObjectAclResponse> |
putObjectAcl(PutObjectAclRequest putObjectAclRequest)
uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a
bucket
|
default CompletableFuture<PutObjectLegalHoldResponse> |
putObjectLegalHold(Consumer<PutObjectLegalHoldRequest.Builder> putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
|
default CompletableFuture<PutObjectLegalHoldResponse> |
putObjectLegalHold(PutObjectLegalHoldRequest putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
|
default CompletableFuture<PutObjectLockConfigurationResponse> |
putObjectLockConfiguration(Consumer<PutObjectLockConfigurationRequest.Builder> putObjectLockConfigurationRequest)
Places an object lock configuration on the specified bucket.
|
default CompletableFuture<PutObjectLockConfigurationResponse> |
putObjectLockConfiguration(PutObjectLockConfigurationRequest putObjectLockConfigurationRequest)
Places an object lock configuration on the specified bucket.
|
default CompletableFuture<PutObjectRetentionResponse> |
putObjectRetention(Consumer<PutObjectRetentionRequest.Builder> putObjectRetentionRequest)
Places an Object Retention configuration on an object.
|
default CompletableFuture<PutObjectRetentionResponse> |
putObjectRetention(PutObjectRetentionRequest putObjectRetentionRequest)
Places an Object Retention configuration on an object.
|
default CompletableFuture<PutObjectTaggingResponse> |
putObjectTagging(Consumer<PutObjectTaggingRequest.Builder> putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket
|
default CompletableFuture<PutObjectTaggingResponse> |
putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket
|
default CompletableFuture<PutPublicAccessBlockResponse> |
putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<PutPublicAccessBlockResponse> |
putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<RestoreObjectResponse> |
restoreObject(Consumer<RestoreObjectRequest.Builder> restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
|
default CompletableFuture<RestoreObjectResponse> |
restoreObject(RestoreObjectRequest restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
|
default CompletableFuture<UploadPartResponse> |
uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest,
AsyncRequestBody requestBody)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartResponse> |
uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest,
Path sourcePath)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartResponse> |
uploadPart(UploadPartRequest uploadPartRequest,
AsyncRequestBody requestBody)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartResponse> |
uploadPart(UploadPartRequest uploadPartRequest,
Path sourcePath)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartCopyResponse> |
uploadPartCopy(Consumer<UploadPartCopyRequest.Builder> uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
|
default CompletableFuture<UploadPartCopyResponse> |
uploadPartCopy(UploadPartCopyRequest uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
|
default S3Utilities |
utilities()
Creates an instance of
S3Utilities object with the configuration set on this client. |
serviceName
close
static final String SERVICE_NAME
static S3AsyncClient create()
S3AsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static S3AsyncClientBuilder builder()
S3AsyncClient
.default CompletableFuture<AbortMultipartUploadResponse> abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.
abortMultipartUploadRequest
- default CompletableFuture<AbortMultipartUploadResponse> abortMultipartUpload(Consumer<AbortMultipartUploadRequest.Builder> abortMultipartUploadRequest)
Aborts a multipart upload.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.
This is a convenience which creates an instance of the AbortMultipartUploadRequest.Builder
avoiding the
need to create one manually via AbortMultipartUploadRequest.builder()
abortMultipartUploadRequest
- A Consumer
that will call methods on AbortMultipartUploadRequest.Builder
to create a
request.default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
Completes a multipart upload by assembling previously uploaded parts.
completeMultipartUploadRequest
- default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest)
Completes a multipart upload by assembling previously uploaded parts.
This is a convenience which creates an instance of the CompleteMultipartUploadRequest.Builder
avoiding
the need to create one manually via CompleteMultipartUploadRequest.builder()
completeMultipartUploadRequest
- A Consumer
that will call methods on CompleteMultipartUploadRequest.Builder
to create a
request.default CompletableFuture<CopyObjectResponse> copyObject(CopyObjectRequest copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
copyObjectRequest
- default CompletableFuture<CopyObjectResponse> copyObject(Consumer<CopyObjectRequest.Builder> copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
This is a convenience which creates an instance of the CopyObjectRequest.Builder
avoiding the need to
create one manually via CopyObjectRequest.builder()
copyObjectRequest
- A Consumer
that will call methods on CopyObjectRequest.Builder
to create a request.default CompletableFuture<CreateBucketResponse> createBucket(CreateBucketRequest createBucketRequest)
Creates a new bucket.
createBucketRequest
- default CompletableFuture<CreateBucketResponse> createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
Creates a new bucket.
This is a convenience which creates an instance of the CreateBucketRequest.Builder
avoiding the need to
create one manually via CreateBucketRequest.builder()
createBucketRequest
- A Consumer
that will call methods on CreateBucketRequest.Builder
to create a request.default CompletableFuture<CreateMultipartUploadResponse> createMultipartUpload(CreateMultipartUploadRequest createMultipartUploadRequest)
Initiates a multipart upload and returns an upload ID.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
createMultipartUploadRequest
- default CompletableFuture<CreateMultipartUploadResponse> createMultipartUpload(Consumer<CreateMultipartUploadRequest.Builder> createMultipartUploadRequest)
Initiates a multipart upload and returns an upload ID.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
This is a convenience which creates an instance of the CreateMultipartUploadRequest.Builder
avoiding the
need to create one manually via CreateMultipartUploadRequest.builder()
createMultipartUploadRequest
- A Consumer
that will call methods on CreateMultipartUploadRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketResponse> deleteBucket(DeleteBucketRequest deleteBucketRequest)
Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.
deleteBucketRequest
- default CompletableFuture<DeleteBucketResponse> deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.
This is a convenience which creates an instance of the DeleteBucketRequest.Builder
avoiding the need to
create one manually via DeleteBucketRequest.builder()
deleteBucketRequest
- A Consumer
that will call methods on DeleteBucketRequest.Builder
to create a request.default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.
deleteBucketAnalyticsConfigurationRequest
- default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> deleteBucketAnalyticsConfiguration(Consumer<DeleteBucketAnalyticsConfigurationRequest.Builder> deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.
This is a convenience which creates an instance of the DeleteBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketAnalyticsConfigurationRequest.builder()
deleteBucketAnalyticsConfigurationRequest
- A Consumer
that will call methods on DeleteBucketAnalyticsConfigurationRequest.Builder
to
create a request.default CompletableFuture<DeleteBucketCorsResponse> deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest)
Deletes the CORS configuration information set for the bucket.
deleteBucketCorsRequest
- default CompletableFuture<DeleteBucketCorsResponse> deleteBucketCors(Consumer<DeleteBucketCorsRequest.Builder> deleteBucketCorsRequest)
Deletes the CORS configuration information set for the bucket.
This is a convenience which creates an instance of the DeleteBucketCorsRequest.Builder
avoiding the need
to create one manually via DeleteBucketCorsRequest.builder()
deleteBucketCorsRequest
- A Consumer
that will call methods on DeleteBucketCorsRequest.Builder
to create a request.default CompletableFuture<DeleteBucketEncryptionResponse> deleteBucketEncryption(DeleteBucketEncryptionRequest deleteBucketEncryptionRequest)
Deletes the server-side encryption configuration from the bucket.
deleteBucketEncryptionRequest
- default CompletableFuture<DeleteBucketEncryptionResponse> deleteBucketEncryption(Consumer<DeleteBucketEncryptionRequest.Builder> deleteBucketEncryptionRequest)
Deletes the server-side encryption configuration from the bucket.
This is a convenience which creates an instance of the DeleteBucketEncryptionRequest.Builder
avoiding the
need to create one manually via DeleteBucketEncryptionRequest.builder()
deleteBucketEncryptionRequest
- A Consumer
that will call methods on DeleteBucketEncryptionRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketInventoryConfigurationResponse> deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
deleteBucketInventoryConfigurationRequest
- default CompletableFuture<DeleteBucketInventoryConfigurationResponse> deleteBucketInventoryConfiguration(Consumer<DeleteBucketInventoryConfigurationRequest.Builder> deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
This is a convenience which creates an instance of the DeleteBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketInventoryConfigurationRequest.builder()
deleteBucketInventoryConfigurationRequest
- A Consumer
that will call methods on DeleteBucketInventoryConfigurationRequest.Builder
to
create a request.default CompletableFuture<DeleteBucketLifecycleResponse> deleteBucketLifecycle(DeleteBucketLifecycleRequest deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the bucket.
deleteBucketLifecycleRequest
- default CompletableFuture<DeleteBucketLifecycleResponse> deleteBucketLifecycle(Consumer<DeleteBucketLifecycleRequest.Builder> deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the bucket.
This is a convenience which creates an instance of the DeleteBucketLifecycleRequest.Builder
avoiding the
need to create one manually via DeleteBucketLifecycleRequest.builder()
deleteBucketLifecycleRequest
- A Consumer
that will call methods on DeleteBucketLifecycleRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketMetricsConfigurationResponse> deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
deleteBucketMetricsConfigurationRequest
- default CompletableFuture<DeleteBucketMetricsConfigurationResponse> deleteBucketMetricsConfiguration(Consumer<DeleteBucketMetricsConfigurationRequest.Builder> deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.
This is a convenience which creates an instance of the DeleteBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketMetricsConfigurationRequest.builder()
deleteBucketMetricsConfigurationRequest
- A Consumer
that will call methods on DeleteBucketMetricsConfigurationRequest.Builder
to
create a request.default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
Deletes the policy from the bucket.
deleteBucketPolicyRequest
- default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
Deletes the policy from the bucket.
This is a convenience which creates an instance of the DeleteBucketPolicyRequest.Builder
avoiding the
need to create one manually via DeleteBucketPolicyRequest.builder()
deleteBucketPolicyRequest
- A Consumer
that will call methods on DeleteBucketPolicyRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
deleteBucketReplicationRequest
- default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
This is a convenience which creates an instance of the DeleteBucketReplicationRequest.Builder
avoiding
the need to create one manually via DeleteBucketReplicationRequest.builder()
deleteBucketReplicationRequest
- A Consumer
that will call methods on DeleteBucketReplicationRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
Deletes the tags from the bucket.
deleteBucketTaggingRequest
- default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
Deletes the tags from the bucket.
This is a convenience which creates an instance of the DeleteBucketTaggingRequest.Builder
avoiding the
need to create one manually via DeleteBucketTaggingRequest.builder()
deleteBucketTaggingRequest
- A Consumer
that will call methods on DeleteBucketTaggingRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketWebsiteResponse> deleteBucketWebsite(DeleteBucketWebsiteRequest deleteBucketWebsiteRequest)
This operation removes the website configuration from the bucket.
deleteBucketWebsiteRequest
- default CompletableFuture<DeleteBucketWebsiteResponse> deleteBucketWebsite(Consumer<DeleteBucketWebsiteRequest.Builder> deleteBucketWebsiteRequest)
This operation removes the website configuration from the bucket.
This is a convenience which creates an instance of the DeleteBucketWebsiteRequest.Builder
avoiding the
need to create one manually via DeleteBucketWebsiteRequest.builder()
deleteBucketWebsiteRequest
- A Consumer
that will call methods on DeleteBucketWebsiteRequest.Builder
to create a
request.default CompletableFuture<DeleteObjectResponse> deleteObject(DeleteObjectRequest deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
deleteObjectRequest
- default CompletableFuture<DeleteObjectResponse> deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
This is a convenience which creates an instance of the DeleteObjectRequest.Builder
avoiding the need to
create one manually via DeleteObjectRequest.builder()
deleteObjectRequest
- A Consumer
that will call methods on DeleteObjectRequest.Builder
to create a request.default CompletableFuture<DeleteObjectTaggingResponse> deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest)
Removes the tag-set from an existing object.
deleteObjectTaggingRequest
- default CompletableFuture<DeleteObjectTaggingResponse> deleteObjectTagging(Consumer<DeleteObjectTaggingRequest.Builder> deleteObjectTaggingRequest)
Removes the tag-set from an existing object.
This is a convenience which creates an instance of the DeleteObjectTaggingRequest.Builder
avoiding the
need to create one manually via DeleteObjectTaggingRequest.builder()
deleteObjectTaggingRequest
- A Consumer
that will call methods on DeleteObjectTaggingRequest.Builder
to create a
request.default CompletableFuture<DeleteObjectsResponse> deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.
deleteObjectsRequest
- default CompletableFuture<DeleteObjectsResponse> deleteObjects(Consumer<DeleteObjectsRequest.Builder> deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.
This is a convenience which creates an instance of the DeleteObjectsRequest.Builder
avoiding the need to
create one manually via DeleteObjectsRequest.builder()
deleteObjectsRequest
- A Consumer
that will call methods on DeleteObjectsRequest.Builder
to create a request.default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
Removes the PublicAccessBlock
configuration from an Amazon S3 bucket.
deletePublicAccessBlockRequest
- default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
Removes the PublicAccessBlock
configuration from an Amazon S3 bucket.
This is a convenience which creates an instance of the DeletePublicAccessBlockRequest.Builder
avoiding
the need to create one manually via DeletePublicAccessBlockRequest.builder()
deletePublicAccessBlockRequest
- A Consumer
that will call methods on DeletePublicAccessBlockRequest.Builder
to create a
request.default CompletableFuture<GetBucketAccelerateConfigurationResponse> getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest)
Returns the accelerate configuration of a bucket.
getBucketAccelerateConfigurationRequest
- default CompletableFuture<GetBucketAccelerateConfigurationResponse> getBucketAccelerateConfiguration(Consumer<GetBucketAccelerateConfigurationRequest.Builder> getBucketAccelerateConfigurationRequest)
Returns the accelerate configuration of a bucket.
This is a convenience which creates an instance of the GetBucketAccelerateConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketAccelerateConfigurationRequest.builder()
getBucketAccelerateConfigurationRequest
- A Consumer
that will call methods on GetBucketAccelerateConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketAclResponse> getBucketAcl(GetBucketAclRequest getBucketAclRequest)
Gets the access control policy for the bucket.
getBucketAclRequest
- default CompletableFuture<GetBucketAclResponse> getBucketAcl(Consumer<GetBucketAclRequest.Builder> getBucketAclRequest)
Gets the access control policy for the bucket.
This is a convenience which creates an instance of the GetBucketAclRequest.Builder
avoiding the need to
create one manually via GetBucketAclRequest.builder()
getBucketAclRequest
- A Consumer
that will call methods on GetBucketAclRequest.Builder
to create a request.default CompletableFuture<GetBucketAnalyticsConfigurationResponse> getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest)
Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
getBucketAnalyticsConfigurationRequest
- default CompletableFuture<GetBucketAnalyticsConfigurationResponse> getBucketAnalyticsConfiguration(Consumer<GetBucketAnalyticsConfigurationRequest.Builder> getBucketAnalyticsConfigurationRequest)
Gets an analytics configuration for the bucket (specified by the analytics configuration ID).
This is a convenience which creates an instance of the GetBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketAnalyticsConfigurationRequest.builder()
getBucketAnalyticsConfigurationRequest
- A Consumer
that will call methods on GetBucketAnalyticsConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketCorsResponse> getBucketCors(GetBucketCorsRequest getBucketCorsRequest)
Returns the CORS configuration for the bucket.
getBucketCorsRequest
- default CompletableFuture<GetBucketCorsResponse> getBucketCors(Consumer<GetBucketCorsRequest.Builder> getBucketCorsRequest)
Returns the CORS configuration for the bucket.
This is a convenience which creates an instance of the GetBucketCorsRequest.Builder
avoiding the need to
create one manually via GetBucketCorsRequest.builder()
getBucketCorsRequest
- A Consumer
that will call methods on GetBucketCorsRequest.Builder
to create a request.default CompletableFuture<GetBucketEncryptionResponse> getBucketEncryption(GetBucketEncryptionRequest getBucketEncryptionRequest)
Returns the server-side encryption configuration of a bucket.
getBucketEncryptionRequest
- default CompletableFuture<GetBucketEncryptionResponse> getBucketEncryption(Consumer<GetBucketEncryptionRequest.Builder> getBucketEncryptionRequest)
Returns the server-side encryption configuration of a bucket.
This is a convenience which creates an instance of the GetBucketEncryptionRequest.Builder
avoiding the
need to create one manually via GetBucketEncryptionRequest.builder()
getBucketEncryptionRequest
- A Consumer
that will call methods on GetBucketEncryptionRequest.Builder
to create a
request.default CompletableFuture<GetBucketInventoryConfigurationResponse> getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory ID) from the bucket.
getBucketInventoryConfigurationRequest
- default CompletableFuture<GetBucketInventoryConfigurationResponse> getBucketInventoryConfiguration(Consumer<GetBucketInventoryConfigurationRequest.Builder> getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory ID) from the bucket.
This is a convenience which creates an instance of the GetBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketInventoryConfigurationRequest.builder()
getBucketInventoryConfigurationRequest
- A Consumer
that will call methods on GetBucketInventoryConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
Returns the lifecycle configuration information set on the bucket.
getBucketLifecycleConfigurationRequest
- default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
Returns the lifecycle configuration information set on the bucket.
This is a convenience which creates an instance of the GetBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketLifecycleConfigurationRequest.builder()
getBucketLifecycleConfigurationRequest
- A Consumer
that will call methods on GetBucketLifecycleConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketLocationResponse> getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
Returns the region the bucket resides in.
getBucketLocationRequest
- default CompletableFuture<GetBucketLocationResponse> getBucketLocation(Consumer<GetBucketLocationRequest.Builder> getBucketLocationRequest)
Returns the region the bucket resides in.
This is a convenience which creates an instance of the GetBucketLocationRequest.Builder
avoiding the need
to create one manually via GetBucketLocationRequest.builder()
getBucketLocationRequest
- A Consumer
that will call methods on GetBucketLocationRequest.Builder
to create a request.default CompletableFuture<GetBucketLoggingResponse> getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
getBucketLoggingRequest
- default CompletableFuture<GetBucketLoggingResponse> getBucketLogging(Consumer<GetBucketLoggingRequest.Builder> getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
This is a convenience which creates an instance of the GetBucketLoggingRequest.Builder
avoiding the need
to create one manually via GetBucketLoggingRequest.builder()
getBucketLoggingRequest
- A Consumer
that will call methods on GetBucketLoggingRequest.Builder
to create a request.default CompletableFuture<GetBucketMetricsConfigurationResponse> getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
getBucketMetricsConfigurationRequest
- default CompletableFuture<GetBucketMetricsConfigurationResponse> getBucketMetricsConfiguration(Consumer<GetBucketMetricsConfigurationRequest.Builder> getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
This is a convenience which creates an instance of the GetBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketMetricsConfigurationRequest.builder()
getBucketMetricsConfigurationRequest
- A Consumer
that will call methods on GetBucketMetricsConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketNotificationConfigurationResponse> getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
getBucketNotificationConfigurationRequest
- default CompletableFuture<GetBucketNotificationConfigurationResponse> getBucketNotificationConfiguration(Consumer<GetBucketNotificationConfigurationRequest.Builder> getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
This is a convenience which creates an instance of the GetBucketNotificationConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketNotificationConfigurationRequest.builder()
getBucketNotificationConfigurationRequest
- A Consumer
that will call methods on GetBucketNotificationConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
Returns the policy of a specified bucket.
getBucketPolicyRequest
- default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
Returns the policy of a specified bucket.
This is a convenience which creates an instance of the GetBucketPolicyRequest.Builder
avoiding the need
to create one manually via GetBucketPolicyRequest.builder()
getBucketPolicyRequest
- A Consumer
that will call methods on GetBucketPolicyRequest.Builder
to create a request.default CompletableFuture<GetBucketPolicyStatusResponse> getBucketPolicyStatus(GetBucketPolicyStatusRequest getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
getBucketPolicyStatusRequest
- default CompletableFuture<GetBucketPolicyStatusResponse> getBucketPolicyStatus(Consumer<GetBucketPolicyStatusRequest.Builder> getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
This is a convenience which creates an instance of the GetBucketPolicyStatusRequest.Builder
avoiding the
need to create one manually via GetBucketPolicyStatusRequest.builder()
getBucketPolicyStatusRequest
- A Consumer
that will call methods on GetBucketPolicyStatusRequest.Builder
to create a
request.default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
getBucketReplicationRequest
- default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
This is a convenience which creates an instance of the GetBucketReplicationRequest.Builder
avoiding the
need to create one manually via GetBucketReplicationRequest.builder()
getBucketReplicationRequest
- A Consumer
that will call methods on GetBucketReplicationRequest.Builder
to create a
request.default CompletableFuture<GetBucketRequestPaymentResponse> getBucketRequestPayment(GetBucketRequestPaymentRequest getBucketRequestPaymentRequest)
Returns the request payment configuration of a bucket.
getBucketRequestPaymentRequest
- default CompletableFuture<GetBucketRequestPaymentResponse> getBucketRequestPayment(Consumer<GetBucketRequestPaymentRequest.Builder> getBucketRequestPaymentRequest)
Returns the request payment configuration of a bucket.
This is a convenience which creates an instance of the GetBucketRequestPaymentRequest.Builder
avoiding
the need to create one manually via GetBucketRequestPaymentRequest.builder()
getBucketRequestPaymentRequest
- A Consumer
that will call methods on GetBucketRequestPaymentRequest.Builder
to create a
request.default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
Returns the tag set associated with the bucket.
getBucketTaggingRequest
- default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
Returns the tag set associated with the bucket.
This is a convenience which creates an instance of the GetBucketTaggingRequest.Builder
avoiding the need
to create one manually via GetBucketTaggingRequest.builder()
getBucketTaggingRequest
- A Consumer
that will call methods on GetBucketTaggingRequest.Builder
to create a request.default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
Returns the versioning state of a bucket.
getBucketVersioningRequest
- default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)
Returns the versioning state of a bucket.
This is a convenience which creates an instance of the GetBucketVersioningRequest.Builder
avoiding the
need to create one manually via GetBucketVersioningRequest.builder()
getBucketVersioningRequest
- A Consumer
that will call methods on GetBucketVersioningRequest.Builder
to create a
request.default CompletableFuture<GetBucketWebsiteResponse> getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest)
Returns the website configuration for a bucket.
getBucketWebsiteRequest
- default CompletableFuture<GetBucketWebsiteResponse> getBucketWebsite(Consumer<GetBucketWebsiteRequest.Builder> getBucketWebsiteRequest)
Returns the website configuration for a bucket.
This is a convenience which creates an instance of the GetBucketWebsiteRequest.Builder
avoiding the need
to create one manually via GetBucketWebsiteRequest.builder()
getBucketWebsiteRequest
- A Consumer
that will call methods on GetBucketWebsiteRequest.Builder
to create a request.default <ReturnT> CompletableFuture<ReturnT> getObject(GetObjectRequest getObjectRequest, AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3.
getObjectRequest
- asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Object data.
'.default <ReturnT> CompletableFuture<ReturnT> getObject(Consumer<GetObjectRequest.Builder> getObjectRequest, AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3.
This is a convenience which creates an instance of the GetObjectRequest.Builder
avoiding the need to
create one manually via GetObjectRequest.builder()
getObjectRequest
- A Consumer
that will call methods on GetObjectRequest.Builder
to create a request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Object data.
'.default CompletableFuture<GetObjectResponse> getObject(GetObjectRequest getObjectRequest, Path destinationPath)
Retrieves objects from Amazon S3.
getObjectRequest
- destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Object data.
'.default CompletableFuture<GetObjectResponse> getObject(Consumer<GetObjectRequest.Builder> getObjectRequest, Path destinationPath)
Retrieves objects from Amazon S3.
This is a convenience which creates an instance of the GetObjectRequest.Builder
avoiding the need to
create one manually via GetObjectRequest.builder()
getObjectRequest
- A Consumer
that will call methods on GetObjectRequest.Builder
to create a request.destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Object data.
'.default CompletableFuture<GetObjectAclResponse> getObjectAcl(GetObjectAclRequest getObjectAclRequest)
Returns the access control list (ACL) of an object.
getObjectAclRequest
- default CompletableFuture<GetObjectAclResponse> getObjectAcl(Consumer<GetObjectAclRequest.Builder> getObjectAclRequest)
Returns the access control list (ACL) of an object.
This is a convenience which creates an instance of the GetObjectAclRequest.Builder
avoiding the need to
create one manually via GetObjectAclRequest.builder()
getObjectAclRequest
- A Consumer
that will call methods on GetObjectAclRequest.Builder
to create a request.default CompletableFuture<GetObjectLegalHoldResponse> getObjectLegalHold(GetObjectLegalHoldRequest getObjectLegalHoldRequest)
Gets an object's current Legal Hold status.
getObjectLegalHoldRequest
- default CompletableFuture<GetObjectLegalHoldResponse> getObjectLegalHold(Consumer<GetObjectLegalHoldRequest.Builder> getObjectLegalHoldRequest)
Gets an object's current Legal Hold status.
This is a convenience which creates an instance of the GetObjectLegalHoldRequest.Builder
avoiding the
need to create one manually via GetObjectLegalHoldRequest.builder()
getObjectLegalHoldRequest
- A Consumer
that will call methods on GetObjectLegalHoldRequest.Builder
to create a
request.default CompletableFuture<GetObjectLockConfigurationResponse> getObjectLockConfiguration(GetObjectLockConfigurationRequest getObjectLockConfigurationRequest)
Gets the object lock configuration for a bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.
getObjectLockConfigurationRequest
- default CompletableFuture<GetObjectLockConfigurationResponse> getObjectLockConfiguration(Consumer<GetObjectLockConfigurationRequest.Builder> getObjectLockConfigurationRequest)
Gets the object lock configuration for a bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.
This is a convenience which creates an instance of the GetObjectLockConfigurationRequest.Builder
avoiding
the need to create one manually via GetObjectLockConfigurationRequest.builder()
getObjectLockConfigurationRequest
- A Consumer
that will call methods on GetObjectLockConfigurationRequest.Builder
to create a
request.default CompletableFuture<GetObjectRetentionResponse> getObjectRetention(GetObjectRetentionRequest getObjectRetentionRequest)
Retrieves an object's retention settings.
getObjectRetentionRequest
- default CompletableFuture<GetObjectRetentionResponse> getObjectRetention(Consumer<GetObjectRetentionRequest.Builder> getObjectRetentionRequest)
Retrieves an object's retention settings.
This is a convenience which creates an instance of the GetObjectRetentionRequest.Builder
avoiding the
need to create one manually via GetObjectRetentionRequest.builder()
getObjectRetentionRequest
- A Consumer
that will call methods on GetObjectRetentionRequest.Builder
to create a
request.default CompletableFuture<GetObjectTaggingResponse> getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest)
Returns the tag-set of an object.
getObjectTaggingRequest
- default CompletableFuture<GetObjectTaggingResponse> getObjectTagging(Consumer<GetObjectTaggingRequest.Builder> getObjectTaggingRequest)
Returns the tag-set of an object.
This is a convenience which creates an instance of the GetObjectTaggingRequest.Builder
avoiding the need
to create one manually via GetObjectTaggingRequest.builder()
getObjectTaggingRequest
- A Consumer
that will call methods on GetObjectTaggingRequest.Builder
to create a request.default <ReturnT> CompletableFuture<ReturnT> getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest, AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Return torrent files from a bucket.
getObjectTorrentRequest
- asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
'.default <ReturnT> CompletableFuture<ReturnT> getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest, AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Return torrent files from a bucket.
This is a convenience which creates an instance of the GetObjectTorrentRequest.Builder
avoiding the need
to create one manually via GetObjectTorrentRequest.builder()
getObjectTorrentRequest
- A Consumer
that will call methods on GetObjectTorrentRequest.Builder
to create a request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
'.default CompletableFuture<GetObjectTorrentResponse> getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest, Path destinationPath)
Return torrent files from a bucket.
getObjectTorrentRequest
- destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
'.default CompletableFuture<GetObjectTorrentResponse> getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest, Path destinationPath)
Return torrent files from a bucket.
This is a convenience which creates an instance of the GetObjectTorrentRequest.Builder
avoiding the need
to create one manually via GetObjectTorrentRequest.builder()
getObjectTorrentRequest
- A Consumer
that will call methods on GetObjectTorrentRequest.Builder
to create a request.destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
'.default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket.
getPublicAccessBlockRequest
- default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket.
This is a convenience which creates an instance of the GetPublicAccessBlockRequest.Builder
avoiding the
need to create one manually via GetPublicAccessBlockRequest.builder()
getPublicAccessBlockRequest
- A Consumer
that will call methods on GetPublicAccessBlockRequest.Builder
to create a
request.default CompletableFuture<HeadBucketResponse> headBucket(HeadBucketRequest headBucketRequest)
This operation is useful to determine if a bucket exists and you have permission to access it.
headBucketRequest
- default CompletableFuture<HeadBucketResponse> headBucket(Consumer<HeadBucketRequest.Builder> headBucketRequest)
This operation is useful to determine if a bucket exists and you have permission to access it.
This is a convenience which creates an instance of the HeadBucketRequest.Builder
avoiding the need to
create one manually via HeadBucketRequest.builder()
headBucketRequest
- A Consumer
that will call methods on HeadBucketRequest.Builder
to create a request.default CompletableFuture<HeadObjectResponse> headObject(HeadObjectRequest headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
headObjectRequest
- default CompletableFuture<HeadObjectResponse> headObject(Consumer<HeadObjectRequest.Builder> headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
This is a convenience which creates an instance of the HeadObjectRequest.Builder
avoiding the need to
create one manually via HeadObjectRequest.builder()
headObjectRequest
- A Consumer
that will call methods on HeadObjectRequest.Builder
to create a request.default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket.
listBucketAnalyticsConfigurationsRequest
- default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> listBucketAnalyticsConfigurations(Consumer<ListBucketAnalyticsConfigurationsRequest.Builder> listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket.
This is a convenience which creates an instance of the ListBucketAnalyticsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketAnalyticsConfigurationsRequest.builder()
listBucketAnalyticsConfigurationsRequest
- A Consumer
that will call methods on ListBucketAnalyticsConfigurationsRequest.Builder
to
create a request.default CompletableFuture<ListBucketInventoryConfigurationsResponse> listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket.
listBucketInventoryConfigurationsRequest
- default CompletableFuture<ListBucketInventoryConfigurationsResponse> listBucketInventoryConfigurations(Consumer<ListBucketInventoryConfigurationsRequest.Builder> listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket.
This is a convenience which creates an instance of the ListBucketInventoryConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketInventoryConfigurationsRequest.builder()
listBucketInventoryConfigurationsRequest
- A Consumer
that will call methods on ListBucketInventoryConfigurationsRequest.Builder
to
create a request.default CompletableFuture<ListBucketMetricsConfigurationsResponse> listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket.
listBucketMetricsConfigurationsRequest
- default CompletableFuture<ListBucketMetricsConfigurationsResponse> listBucketMetricsConfigurations(Consumer<ListBucketMetricsConfigurationsRequest.Builder> listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket.
This is a convenience which creates an instance of the ListBucketMetricsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketMetricsConfigurationsRequest.builder()
listBucketMetricsConfigurationsRequest
- A Consumer
that will call methods on ListBucketMetricsConfigurationsRequest.Builder
to
create a request.default CompletableFuture<ListBucketsResponse> listBuckets(ListBucketsRequest listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
listBucketsRequest
- default CompletableFuture<ListBucketsResponse> listBuckets(Consumer<ListBucketsRequest.Builder> listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
This is a convenience which creates an instance of the ListBucketsRequest.Builder
avoiding the need to
create one manually via ListBucketsRequest.builder()
listBucketsRequest
- A Consumer
that will call methods on ListBucketsRequest.Builder
to create a request.default CompletableFuture<ListBucketsResponse> listBuckets()
Returns a list of all buckets owned by the authenticated sender of the request.
default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
listMultipartUploadsRequest
- default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
This is a convenience which creates an instance of the ListMultipartUploadsRequest.Builder
avoiding the
need to create one manually via ListMultipartUploadsRequest.builder()
listMultipartUploadsRequest
- A Consumer
that will call methods on ListMultipartUploadsRequest.Builder
to create a
request.default ListMultipartUploadsPublisher listMultipartUploadsPaginator(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
This is a variant of
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
listMultipartUploadsRequest
- default ListMultipartUploadsPublisher listMultipartUploadsPaginator(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
This is a variant of
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
This is a convenience which creates an instance of the ListMultipartUploadsRequest.Builder
avoiding the
need to create one manually via ListMultipartUploadsRequest.builder()
listMultipartUploadsRequest
- A Consumer
that will call methods on ListMultipartUploadsRequest.Builder
to create a
request.default CompletableFuture<ListObjectVersionsResponse> listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
listObjectVersionsRequest
- default CompletableFuture<ListObjectVersionsResponse> listObjectVersions(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
This is a convenience which creates an instance of the ListObjectVersionsRequest.Builder
avoiding the
need to create one manually via ListObjectVersionsRequest.builder()
listObjectVersionsRequest
- A Consumer
that will call methods on ListObjectVersionsRequest.Builder
to create a
request.default ListObjectVersionsPublisher listObjectVersionsPaginator(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
This is a variant of
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation.
listObjectVersionsRequest
- default ListObjectVersionsPublisher listObjectVersionsPaginator(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all of the versions of objects in a bucket.
This is a variant of
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation.
This is a convenience which creates an instance of the ListObjectVersionsRequest.Builder
avoiding the
need to create one manually via ListObjectVersionsRequest.builder()
listObjectVersionsRequest
- A Consumer
that will call methods on ListObjectVersionsRequest.Builder
to create a
request.default CompletableFuture<ListObjectsResponse> listObjects(ListObjectsRequest listObjectsRequest)
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.
listObjectsRequest
- default CompletableFuture<ListObjectsResponse> listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.
This is a convenience which creates an instance of the ListObjectsRequest.Builder
avoiding the need to
create one manually via ListObjectsRequest.builder()
listObjectsRequest
- A Consumer
that will call methods on ListObjectsRequest.Builder
to create a request.default CompletableFuture<ListObjectsV2Response> listObjectsV2(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.
listObjectsV2Request
- default CompletableFuture<ListObjectsV2Response> listObjectsV2(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.
This is a convenience which creates an instance of the ListObjectsV2Request.Builder
avoiding the need to
create one manually via ListObjectsV2Request.builder()
listObjectsV2Request
- A Consumer
that will call methods on ListObjectsV2Request.Builder
to create a request.default ListObjectsV2Publisher listObjectsV2Paginator(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.
This is a variant of listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectsV2Response>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectsV2Response response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation.
listObjectsV2Request
- default ListObjectsV2Publisher listObjectsV2Paginator(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.
This is a variant of listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectsV2Response>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectsV2Response response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation.
This is a convenience which creates an instance of the ListObjectsV2Request.Builder
avoiding the need to
create one manually via ListObjectsV2Request.builder()
listObjectsV2Request
- A Consumer
that will call methods on ListObjectsV2Request.Builder
to create a request.default CompletableFuture<ListPartsResponse> listParts(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
listPartsRequest
- default CompletableFuture<ListPartsResponse> listParts(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
This is a convenience which creates an instance of the ListPartsRequest.Builder
avoiding the need to
create one manually via ListPartsRequest.builder()
listPartsRequest
- A Consumer
that will call methods on ListPartsRequest.Builder
to create a request.default ListPartsPublisher listPartsPaginator(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
This is a variant of listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListPartsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListPartsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation.
listPartsRequest
- default ListPartsPublisher listPartsPaginator(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
This is a variant of listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListPartsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListPartsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation.
This is a convenience which creates an instance of the ListPartsRequest.Builder
avoiding the need to
create one manually via ListPartsRequest.builder()
listPartsRequest
- A Consumer
that will call methods on ListPartsRequest.Builder
to create a request.default CompletableFuture<PutBucketAccelerateConfigurationResponse> putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest)
Sets the accelerate configuration of an existing bucket.
putBucketAccelerateConfigurationRequest
- default CompletableFuture<PutBucketAccelerateConfigurationResponse> putBucketAccelerateConfiguration(Consumer<PutBucketAccelerateConfigurationRequest.Builder> putBucketAccelerateConfigurationRequest)
Sets the accelerate configuration of an existing bucket.
This is a convenience which creates an instance of the PutBucketAccelerateConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAccelerateConfigurationRequest.builder()
putBucketAccelerateConfigurationRequest
- A Consumer
that will call methods on PutBucketAccelerateConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketAclResponse> putBucketAcl(PutBucketAclRequest putBucketAclRequest)
Sets the permissions on a bucket using access control lists (ACL).
putBucketAclRequest
- default CompletableFuture<PutBucketAclResponse> putBucketAcl(Consumer<PutBucketAclRequest.Builder> putBucketAclRequest)
Sets the permissions on a bucket using access control lists (ACL).
This is a convenience which creates an instance of the PutBucketAclRequest.Builder
avoiding the need to
create one manually via PutBucketAclRequest.builder()
putBucketAclRequest
- A Consumer
that will call methods on PutBucketAclRequest.Builder
to create a request.default CompletableFuture<PutBucketAnalyticsConfigurationResponse> putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
putBucketAnalyticsConfigurationRequest
- default CompletableFuture<PutBucketAnalyticsConfigurationResponse> putBucketAnalyticsConfiguration(Consumer<PutBucketAnalyticsConfigurationRequest.Builder> putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
This is a convenience which creates an instance of the PutBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAnalyticsConfigurationRequest.builder()
putBucketAnalyticsConfigurationRequest
- A Consumer
that will call methods on PutBucketAnalyticsConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketCorsResponse> putBucketCors(PutBucketCorsRequest putBucketCorsRequest)
Sets the CORS configuration for a bucket.
putBucketCorsRequest
- default CompletableFuture<PutBucketCorsResponse> putBucketCors(Consumer<PutBucketCorsRequest.Builder> putBucketCorsRequest)
Sets the CORS configuration for a bucket.
This is a convenience which creates an instance of the PutBucketCorsRequest.Builder
avoiding the need to
create one manually via PutBucketCorsRequest.builder()
putBucketCorsRequest
- A Consumer
that will call methods on PutBucketCorsRequest.Builder
to create a request.default CompletableFuture<PutBucketEncryptionResponse> putBucketEncryption(PutBucketEncryptionRequest putBucketEncryptionRequest)
Creates a new server-side encryption configuration (or replaces an existing one, if present).
putBucketEncryptionRequest
- default CompletableFuture<PutBucketEncryptionResponse> putBucketEncryption(Consumer<PutBucketEncryptionRequest.Builder> putBucketEncryptionRequest)
Creates a new server-side encryption configuration (or replaces an existing one, if present).
This is a convenience which creates an instance of the PutBucketEncryptionRequest.Builder
avoiding the
need to create one manually via PutBucketEncryptionRequest.builder()
putBucketEncryptionRequest
- A Consumer
that will call methods on PutBucketEncryptionRequest.Builder
to create a
request.default CompletableFuture<PutBucketInventoryConfigurationResponse> putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest)
Adds an inventory configuration (identified by the inventory ID) from the bucket.
putBucketInventoryConfigurationRequest
- default CompletableFuture<PutBucketInventoryConfigurationResponse> putBucketInventoryConfiguration(Consumer<PutBucketInventoryConfigurationRequest.Builder> putBucketInventoryConfigurationRequest)
Adds an inventory configuration (identified by the inventory ID) from the bucket.
This is a convenience which creates an instance of the PutBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketInventoryConfigurationRequest.builder()
putBucketInventoryConfigurationRequest
- A Consumer
that will call methods on PutBucketInventoryConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.
putBucketLifecycleConfigurationRequest
- default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.
This is a convenience which creates an instance of the PutBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketLifecycleConfigurationRequest.builder()
putBucketLifecycleConfigurationRequest
- A Consumer
that will call methods on PutBucketLifecycleConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketLoggingResponse> putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.
putBucketLoggingRequest
- default CompletableFuture<PutBucketLoggingResponse> putBucketLogging(Consumer<PutBucketLoggingRequest.Builder> putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.
This is a convenience which creates an instance of the PutBucketLoggingRequest.Builder
avoiding the need
to create one manually via PutBucketLoggingRequest.builder()
putBucketLoggingRequest
- A Consumer
that will call methods on PutBucketLoggingRequest.Builder
to create a request.default CompletableFuture<PutBucketMetricsConfigurationResponse> putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
putBucketMetricsConfigurationRequest
- default CompletableFuture<PutBucketMetricsConfigurationResponse> putBucketMetricsConfiguration(Consumer<PutBucketMetricsConfigurationRequest.Builder> putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
This is a convenience which creates an instance of the PutBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketMetricsConfigurationRequest.builder()
putBucketMetricsConfigurationRequest
- A Consumer
that will call methods on PutBucketMetricsConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketNotificationConfigurationResponse> putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
putBucketNotificationConfigurationRequest
- default CompletableFuture<PutBucketNotificationConfigurationResponse> putBucketNotificationConfiguration(Consumer<PutBucketNotificationConfigurationRequest.Builder> putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
This is a convenience which creates an instance of the PutBucketNotificationConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketNotificationConfigurationRequest.builder()
putBucketNotificationConfigurationRequest
- A Consumer
that will call methods on PutBucketNotificationConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
putBucketPolicyRequest
- default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
This is a convenience which creates an instance of the PutBucketPolicyRequest.Builder
avoiding the need
to create one manually via PutBucketPolicyRequest.builder()
putBucketPolicyRequest
- A Consumer
that will call methods on PutBucketPolicyRequest.Builder
to create a request.default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
putBucketReplicationRequest
- default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.
This is a convenience which creates an instance of the PutBucketReplicationRequest.Builder
avoiding the
need to create one manually via PutBucketReplicationRequest.builder()
putBucketReplicationRequest
- A Consumer
that will call methods on PutBucketReplicationRequest.Builder
to create a
request.default CompletableFuture<PutBucketRequestPaymentResponse> putBucketRequestPayment(PutBucketRequestPaymentRequest putBucketRequestPaymentRequest)
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
putBucketRequestPaymentRequest
- default CompletableFuture<PutBucketRequestPaymentResponse> putBucketRequestPayment(Consumer<PutBucketRequestPaymentRequest.Builder> putBucketRequestPaymentRequest)
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
This is a convenience which creates an instance of the PutBucketRequestPaymentRequest.Builder
avoiding
the need to create one manually via PutBucketRequestPaymentRequest.builder()
putBucketRequestPaymentRequest
- A Consumer
that will call methods on PutBucketRequestPaymentRequest.Builder
to create a
request.default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
Sets the tags for a bucket.
putBucketTaggingRequest
- default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
Sets the tags for a bucket.
This is a convenience which creates an instance of the PutBucketTaggingRequest.Builder
avoiding the need
to create one manually via PutBucketTaggingRequest.builder()
putBucketTaggingRequest
- A Consumer
that will call methods on PutBucketTaggingRequest.Builder
to create a request.default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
putBucketVersioningRequest
- default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
This is a convenience which creates an instance of the PutBucketVersioningRequest.Builder
avoiding the
need to create one manually via PutBucketVersioningRequest.builder()
putBucketVersioningRequest
- A Consumer
that will call methods on PutBucketVersioningRequest.Builder
to create a
request.default CompletableFuture<PutBucketWebsiteResponse> putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest)
Set the website configuration for a bucket.
putBucketWebsiteRequest
- default CompletableFuture<PutBucketWebsiteResponse> putBucketWebsite(Consumer<PutBucketWebsiteRequest.Builder> putBucketWebsiteRequest)
Set the website configuration for a bucket.
This is a convenience which creates an instance of the PutBucketWebsiteRequest.Builder
avoiding the need
to create one manually via PutBucketWebsiteRequest.builder()
putBucketWebsiteRequest
- A Consumer
that will call methods on PutBucketWebsiteRequest.Builder
to create a request.default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest, AsyncRequestBody requestBody)
Adds an object to a bucket.
putObjectRequest
- requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<PutObjectResponse> putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, AsyncRequestBody requestBody)
Adds an object to a bucket.
This is a convenience which creates an instance of the PutObjectRequest.Builder
avoiding the need to
create one manually via PutObjectRequest.builder()
putObjectRequest
- A Consumer
that will call methods on PutObjectRequest.Builder
to create a request.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest, Path sourcePath)
Adds an object to a bucket.
putObjectRequest
- sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<PutObjectResponse> putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, Path sourcePath)
Adds an object to a bucket.
This is a convenience which creates an instance of the PutObjectRequest.Builder
avoiding the need to
create one manually via PutObjectRequest.builder()
putObjectRequest
- A Consumer
that will call methods on PutObjectRequest.Builder
to create a request.sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<PutObjectAclResponse> putObjectAcl(PutObjectAclRequest putObjectAclRequest)
uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket
putObjectAclRequest
- default CompletableFuture<PutObjectAclResponse> putObjectAcl(Consumer<PutObjectAclRequest.Builder> putObjectAclRequest)
uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket
This is a convenience which creates an instance of the PutObjectAclRequest.Builder
avoiding the need to
create one manually via PutObjectAclRequest.builder()
putObjectAclRequest
- A Consumer
that will call methods on PutObjectAclRequest.Builder
to create a request.default CompletableFuture<PutObjectLegalHoldResponse> putObjectLegalHold(PutObjectLegalHoldRequest putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
putObjectLegalHoldRequest
- default CompletableFuture<PutObjectLegalHoldResponse> putObjectLegalHold(Consumer<PutObjectLegalHoldRequest.Builder> putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
This is a convenience which creates an instance of the PutObjectLegalHoldRequest.Builder
avoiding the
need to create one manually via PutObjectLegalHoldRequest.builder()
putObjectLegalHoldRequest
- A Consumer
that will call methods on PutObjectLegalHoldRequest.Builder
to create a
request.default CompletableFuture<PutObjectLockConfigurationResponse> putObjectLockConfiguration(PutObjectLockConfigurationRequest putObjectLockConfigurationRequest)
Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.
putObjectLockConfigurationRequest
- default CompletableFuture<PutObjectLockConfigurationResponse> putObjectLockConfiguration(Consumer<PutObjectLockConfigurationRequest.Builder> putObjectLockConfigurationRequest)
Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.
This is a convenience which creates an instance of the PutObjectLockConfigurationRequest.Builder
avoiding
the need to create one manually via PutObjectLockConfigurationRequest.builder()
putObjectLockConfigurationRequest
- A Consumer
that will call methods on PutObjectLockConfigurationRequest.Builder
to create a
request.default CompletableFuture<PutObjectRetentionResponse> putObjectRetention(PutObjectRetentionRequest putObjectRetentionRequest)
Places an Object Retention configuration on an object.
putObjectRetentionRequest
- default CompletableFuture<PutObjectRetentionResponse> putObjectRetention(Consumer<PutObjectRetentionRequest.Builder> putObjectRetentionRequest)
Places an Object Retention configuration on an object.
This is a convenience which creates an instance of the PutObjectRetentionRequest.Builder
avoiding the
need to create one manually via PutObjectRetentionRequest.builder()
putObjectRetentionRequest
- A Consumer
that will call methods on PutObjectRetentionRequest.Builder
to create a
request.default CompletableFuture<PutObjectTaggingResponse> putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket
putObjectTaggingRequest
- default CompletableFuture<PutObjectTaggingResponse> putObjectTagging(Consumer<PutObjectTaggingRequest.Builder> putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket
This is a convenience which creates an instance of the PutObjectTaggingRequest.Builder
avoiding the need
to create one manually via PutObjectTaggingRequest.builder()
putObjectTaggingRequest
- A Consumer
that will call methods on PutObjectTaggingRequest.Builder
to create a request.default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
Creates or modifies the PublicAccessBlock
configuration for an Amazon S3 bucket.
putPublicAccessBlockRequest
- default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
Creates or modifies the PublicAccessBlock
configuration for an Amazon S3 bucket.
This is a convenience which creates an instance of the PutPublicAccessBlockRequest.Builder
avoiding the
need to create one manually via PutPublicAccessBlockRequest.builder()
putPublicAccessBlockRequest
- A Consumer
that will call methods on PutPublicAccessBlockRequest.Builder
to create a
request.default CompletableFuture<RestoreObjectResponse> restoreObject(RestoreObjectRequest restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
restoreObjectRequest
- default CompletableFuture<RestoreObjectResponse> restoreObject(Consumer<RestoreObjectRequest.Builder> restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
This is a convenience which creates an instance of the RestoreObjectRequest.Builder
avoiding the need to
create one manually via RestoreObjectRequest.builder()
restoreObjectRequest
- A Consumer
that will call methods on RestoreObjectRequest.Builder
to create a request.default CompletableFuture<UploadPartResponse> uploadPart(UploadPartRequest uploadPartRequest, AsyncRequestBody requestBody)
Uploads a part in a multipart upload.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
uploadPartRequest
- requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<UploadPartResponse> uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest, AsyncRequestBody requestBody)
Uploads a part in a multipart upload.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
This is a convenience which creates an instance of the UploadPartRequest.Builder
avoiding the need to
create one manually via UploadPartRequest.builder()
uploadPartRequest
- A Consumer
that will call methods on UploadPartRequest.Builder
to create a request.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<UploadPartResponse> uploadPart(UploadPartRequest uploadPartRequest, Path sourcePath)
Uploads a part in a multipart upload.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
uploadPartRequest
- sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<UploadPartResponse> uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest, Path sourcePath)
Uploads a part in a multipart upload.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
This is a convenience which creates an instance of the UploadPartRequest.Builder
avoiding the need to
create one manually via UploadPartRequest.builder()
uploadPartRequest
- A Consumer
that will call methods on UploadPartRequest.Builder
to create a request.sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<UploadPartCopyResponse> uploadPartCopy(UploadPartCopyRequest uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
uploadPartCopyRequest
- default CompletableFuture<UploadPartCopyResponse> uploadPartCopy(Consumer<UploadPartCopyRequest.Builder> uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
This is a convenience which creates an instance of the UploadPartCopyRequest.Builder
avoiding the need to
create one manually via UploadPartCopyRequest.builder()
uploadPartCopyRequest
- A Consumer
that will call methods on UploadPartCopyRequest.Builder
to create a request.default S3Utilities utilities()
S3Utilities
object with the configuration set on this client.Copyright © 2019. All rights reserved.