@Generated(value="software.amazon.awssdk:codegen") public interface S3AsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
nullModifier 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.
This is a convenience which creates an instance of the CompleteMultipartUploadRequest.Builder avoiding
the need to create one manually via CompleteMultipartUploadRequest.builder() |
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() |
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.
This is a convenience which creates an instance of the CreateBucketRequest.Builder avoiding the need to
create one manually via CreateBucketRequest.builder() |
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).
This is a convenience which creates an instance of the DeleteBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketAnalyticsConfigurationRequest.builder() |
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.
This is a convenience which creates an instance of the DeleteBucketCorsRequest.Builder avoiding the need
to create one manually via DeleteBucketCorsRequest.builder() |
default CompletableFuture<DeleteBucketCorsResponse> |
deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest)
Deletes the cors configuration information set for the bucket.
|
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() |
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.
This is a convenience which creates an instance of the DeleteBucketLifecycleRequest.Builder avoiding the
need to create one manually via DeleteBucketLifecycleRequest.builder() |
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.
This is a convenience which creates an instance of the DeleteBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketMetricsConfigurationRequest.builder() |
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.
This is a convenience which creates an instance of the DeleteBucketPolicyRequest.Builder avoiding the
need to create one manually via DeleteBucketPolicyRequest.builder() |
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.
This is a convenience which creates an instance of the DeleteBucketReplicationRequest.Builder avoiding
the need to create one manually via DeleteBucketReplicationRequest.builder() |
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.
This is a convenience which creates an instance of the DeleteBucketTaggingRequest.Builder avoiding the
need to create one manually via DeleteBucketTaggingRequest.builder() |
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.
This is a convenience which creates an instance of the DeleteBucketWebsiteRequest.Builder avoiding the
need to create one manually via DeleteBucketWebsiteRequest.builder() |
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.
This is a convenience which creates an instance of the DeleteObjectTaggingRequest.Builder avoiding the
need to create one manually via DeleteObjectTaggingRequest.builder() |
default CompletableFuture<DeleteObjectTaggingResponse> |
deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest)
Removes the tag-set from an existing object.
|
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() |
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.
This is a convenience which creates an instance of the GetBucketAclRequest.Builder avoiding the need to
create one manually via GetBucketAclRequest.builder() |
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).
This is a convenience which creates an instance of the GetBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketAnalyticsConfigurationRequest.builder() |
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.
This is a convenience which creates an instance of the GetBucketCorsRequest.Builder avoiding the need to
create one manually via GetBucketCorsRequest.builder() |
default CompletableFuture<GetBucketCorsResponse> |
getBucketCors(GetBucketCorsRequest getBucketCorsRequest)
Returns the cors configuration for the bucket.
|
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() |
default CompletableFuture<GetBucketInventoryConfigurationResponse> |
getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<GetBucketLifecycleResponse> |
getBucketLifecycle(Consumer<GetBucketLifecycleRequest.Builder> getBucketLifecycleRequest)
Deprecated, see the GetBucketLifecycleConfiguration operation.
This is a convenience which creates an instance of the GetBucketLifecycleRequest.Builder avoiding the
need to create one manually via GetBucketLifecycleRequest.builder() |
default CompletableFuture<GetBucketLifecycleResponse> |
getBucketLifecycle(GetBucketLifecycleRequest getBucketLifecycleRequest)
Deprecated, see the GetBucketLifecycleConfiguration operation.
|
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() |
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.
This is a convenience which creates an instance of the GetBucketLocationRequest.Builder avoiding the need
to create one manually via GetBucketLocationRequest.builder() |
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.
This is a convenience which creates an instance of the GetBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketMetricsConfigurationRequest.builder() |
default CompletableFuture<GetBucketMetricsConfigurationResponse> |
getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default CompletableFuture<GetBucketNotificationResponse> |
getBucketNotification(Consumer<GetBucketNotificationRequest.Builder> getBucketNotificationRequest)
Deprecated, see the GetBucketNotificationConfiguration operation.
This is a convenience which creates an instance of the GetBucketNotificationRequest.Builder avoiding the
need to create one manually via GetBucketNotificationRequest.builder() |
default CompletableFuture<GetBucketNotificationResponse> |
getBucketNotification(GetBucketNotificationRequest getBucketNotificationRequest)
Deprecated, see the GetBucketNotificationConfiguration operation.
|
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() |
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.
This is a convenience which creates an instance of the GetBucketPolicyRequest.Builder avoiding the need
to create one manually via GetBucketPolicyRequest.builder() |
default CompletableFuture<GetBucketPolicyResponse> |
getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
Returns the policy of a specified bucket.
|
default CompletableFuture<GetBucketReplicationResponse> |
getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
Returns the replication configuration of a bucket.
This is a convenience which creates an instance of the GetBucketReplicationRequest.Builder avoiding the
need to create one manually via GetBucketReplicationRequest.builder() |
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.
This is a convenience which creates an instance of the GetBucketRequestPaymentRequest.Builder avoiding
the need to create one manually via GetBucketRequestPaymentRequest.builder() |
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.
This is a convenience which creates an instance of the GetBucketTaggingRequest.Builder avoiding the need
to create one manually via GetBucketTaggingRequest.builder() |
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.
This is a convenience which creates an instance of the GetBucketVersioningRequest.Builder avoiding the
need to create one manually via GetBucketVersioningRequest.builder() |
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.
This is a convenience which creates an instance of the GetBucketWebsiteRequest.Builder avoiding the need
to create one manually via GetBucketWebsiteRequest.builder() |
default CompletableFuture<GetBucketWebsiteResponse> |
getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest)
Returns the website configuration for a bucket.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObject(GetObjectRequest getObjectRequest,
AsyncResponseHandler<GetObjectResponse,ReturnT> asyncResponseHandler)
Retrieves objects from Amazon S3.
|
default CompletableFuture<GetObjectResponse> |
getObject(GetObjectRequest getObjectRequest,
Path path)
Retrieves objects from Amazon S3.
|
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() |
default CompletableFuture<GetObjectAclResponse> |
getObjectAcl(GetObjectAclRequest getObjectAclRequest)
Returns the access control list (ACL) of an object.
|
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() |
default CompletableFuture<GetObjectTaggingResponse> |
getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest)
Returns the tag-set of an object.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
AsyncResponseHandler<GetObjectTorrentResponse,ReturnT> asyncResponseHandler)
Return torrent files from a bucket.
|
default CompletableFuture<GetObjectTorrentResponse> |
getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
Path path)
Return torrent files from a 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.
This is a convenience which creates an instance of the HeadBucketRequest.Builder avoiding the need to
create one manually via HeadBucketRequest.builder() |
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.
This is a convenience which creates an instance of the ListBucketAnalyticsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketAnalyticsConfigurationsRequest.builder() |
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.
This is a convenience which creates an instance of the ListBucketInventoryConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketInventoryConfigurationsRequest.builder() |
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.
This is a convenience which creates an instance of the ListBucketMetricsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketMetricsConfigurationsRequest.builder() |
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.
This is a convenience which creates an instance of the ListBucketsRequest.Builder avoiding the need to
create one manually via ListBucketsRequest.builder() |
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.
This is a convenience which creates an instance of the ListMultipartUploadsRequest.Builder avoiding the
need to create one manually via ListMultipartUploadsRequest.builder() |
default CompletableFuture<ListMultipartUploadsResponse> |
listMultipartUploads(ListMultipartUploadsRequest 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(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.
This is a convenience which creates an instance of the ListObjectVersionsRequest.Builder avoiding the
need to create one manually via ListObjectVersionsRequest.builder() |
default CompletableFuture<ListObjectVersionsResponse> |
listObjectVersions(ListObjectVersionsRequest 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.
This is a convenience which creates an instance of the ListPartsRequest.Builder avoiding the need to
create one manually via ListPartsRequest.builder() |
default CompletableFuture<ListPartsResponse> |
listParts(ListPartsRequest 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.
This is a convenience which creates an instance of the PutBucketAccelerateConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAccelerateConfigurationRequest.builder() |
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).
This is a convenience which creates an instance of the PutBucketAclRequest.Builder avoiding the need to
create one manually via PutBucketAclRequest.builder() |
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).
This is a convenience which creates an instance of the PutBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAnalyticsConfigurationRequest.builder() |
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.
This is a convenience which creates an instance of the PutBucketCorsRequest.Builder avoiding the need to
create one manually via PutBucketCorsRequest.builder() |
default CompletableFuture<PutBucketCorsResponse> |
putBucketCors(PutBucketCorsRequest putBucketCorsRequest)
Sets the cors configuration for a bucket.
|
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() |
default CompletableFuture<PutBucketInventoryConfigurationResponse> |
putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest)
Adds an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<PutBucketLifecycleResponse> |
putBucketLifecycle(Consumer<PutBucketLifecycleRequest.Builder> putBucketLifecycleRequest)
Deprecated, see the PutBucketLifecycleConfiguration operation.
This is a convenience which creates an instance of the PutBucketLifecycleRequest.Builder avoiding the
need to create one manually via PutBucketLifecycleRequest.builder() |
default CompletableFuture<PutBucketLifecycleResponse> |
putBucketLifecycle(PutBucketLifecycleRequest putBucketLifecycleRequest)
Deprecated, see the PutBucketLifecycleConfiguration operation.
|
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.
This is a convenience which creates an instance of the PutBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketMetricsConfigurationRequest.builder() |
default CompletableFuture<PutBucketMetricsConfigurationResponse> |
putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
default CompletableFuture<PutBucketNotificationResponse> |
putBucketNotification(Consumer<PutBucketNotificationRequest.Builder> putBucketNotificationRequest)
Deprecated, see the PutBucketNotificationConfiguraiton operation.
This is a convenience which creates an instance of the PutBucketNotificationRequest.Builder avoiding the
need to create one manually via PutBucketNotificationRequest.builder() |
default CompletableFuture<PutBucketNotificationResponse> |
putBucketNotification(PutBucketNotificationRequest putBucketNotificationRequest)
Deprecated, see the PutBucketNotificationConfiguraiton operation.
|
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() |
default CompletableFuture<PutBucketNotificationConfigurationResponse> |
putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
|
default CompletableFuture<PutBucketPolicyResponse> |
putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
Replaces a policy on a bucket.
|
default CompletableFuture<PutBucketPolicyResponse> |
putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
Replaces a policy on a bucket.
|
default CompletableFuture<PutBucketReplicationResponse> |
putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
Creates a new replication configuration (or replaces an existing one, if present).
This is a convenience which creates an instance of the PutBucketReplicationRequest.Builder avoiding the
need to create one manually via PutBucketReplicationRequest.builder() |
default CompletableFuture<PutBucketReplicationResponse> |
putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
Creates a new replication configuration (or replaces an existing one, if present).
|
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.
This is a convenience which creates an instance of the PutBucketTaggingRequest.Builder avoiding the need
to create one manually via PutBucketTaggingRequest.builder() |
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.
This is a convenience which creates an instance of the PutBucketWebsiteRequest.Builder avoiding the need
to create one manually via PutBucketWebsiteRequest.builder() |
default CompletableFuture<PutBucketWebsiteResponse> |
putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest)
Set the website configuration for a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(PutObjectRequest putObjectRequest,
AsyncRequestProvider requestProvider)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(PutObjectRequest putObjectRequest,
Path path)
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
This is a convenience which creates an instance of the PutObjectAclRequest.Builder avoiding the need to
create one manually via PutObjectAclRequest.builder() |
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<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() |
default CompletableFuture<PutObjectTaggingResponse> |
putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket
|
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() |
default CompletableFuture<RestoreObjectResponse> |
restoreObject(RestoreObjectRequest restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
|
default CompletableFuture<UploadPartResponse> |
uploadPart(UploadPartRequest uploadPartRequest,
AsyncRequestProvider requestProvider)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartResponse> |
uploadPart(UploadPartRequest uploadPartRequest,
Path path)
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.
This is a convenience which creates an instance of the UploadPartCopyRequest.Builder avoiding the need to
create one manually via UploadPartCopyRequest.builder() |
default CompletableFuture<UploadPartCopyResponse> |
uploadPartCopy(UploadPartCopyRequest uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
|
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.
AbortMultipartUploadRequest.Builder
avoiding the
need to create one manually via AbortMultipartUploadRequest.builder()
abortMultipartUploadRequest
- a Consumer
that will call methods on AbortMultipartUploadRequest.Builder
.default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
completeMultipartUploadRequest
- default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest)
CompleteMultipartUploadRequest.Builder
avoiding
the need to create one manually via CompleteMultipartUploadRequest.builder()
completeMultipartUploadRequest
- a Consumer
that will call methods on CompleteMultipartUploadRequest.Builder
.default CompletableFuture<CopyObjectResponse> copyObject(CopyObjectRequest copyObjectRequest)
copyObjectRequest
- default CompletableFuture<CopyObjectResponse> copyObject(Consumer<CopyObjectRequest.Builder> copyObjectRequest)
CopyObjectRequest.Builder
avoiding the need to
create one manually via CopyObjectRequest.builder()
copyObjectRequest
- a Consumer
that will call methods on CopyObjectRequest.Builder
.default CompletableFuture<CreateBucketResponse> createBucket(CreateBucketRequest createBucketRequest)
createBucketRequest
- default CompletableFuture<CreateBucketResponse> createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
CreateBucketRequest.Builder
avoiding the need to
create one manually via CreateBucketRequest.builder()
createBucketRequest
- a Consumer
that will call methods on CreateBucketRequest.Builder
.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.
CreateMultipartUploadRequest.Builder
avoiding the
need to create one manually via CreateMultipartUploadRequest.builder()
createMultipartUploadRequest
- a Consumer
that will call methods on CreateMultipartUploadRequest.Builder
.default CompletableFuture<DeleteBucketResponse> deleteBucket(DeleteBucketRequest deleteBucketRequest)
deleteBucketRequest
- default CompletableFuture<DeleteBucketResponse> deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
DeleteBucketRequest.Builder
avoiding the need to
create one manually via DeleteBucketRequest.builder()
deleteBucketRequest
- a Consumer
that will call methods on DeleteBucketRequest.Builder
.default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest)
deleteBucketAnalyticsConfigurationRequest
- default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> deleteBucketAnalyticsConfiguration(Consumer<DeleteBucketAnalyticsConfigurationRequest.Builder> deleteBucketAnalyticsConfigurationRequest)
DeleteBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketAnalyticsConfigurationRequest.builder()
deleteBucketAnalyticsConfigurationRequest
- a Consumer
that will call methods on DeleteBucketAnalyticsConfigurationRequest.Builder
.default CompletableFuture<DeleteBucketCorsResponse> deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest)
deleteBucketCorsRequest
- default CompletableFuture<DeleteBucketCorsResponse> deleteBucketCors(Consumer<DeleteBucketCorsRequest.Builder> deleteBucketCorsRequest)
DeleteBucketCorsRequest.Builder
avoiding the need
to create one manually via DeleteBucketCorsRequest.builder()
deleteBucketCorsRequest
- a Consumer
that will call methods on DeleteBucketCorsRequest.Builder
.default CompletableFuture<DeleteBucketInventoryConfigurationResponse> deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest)
deleteBucketInventoryConfigurationRequest
- default CompletableFuture<DeleteBucketInventoryConfigurationResponse> deleteBucketInventoryConfiguration(Consumer<DeleteBucketInventoryConfigurationRequest.Builder> deleteBucketInventoryConfigurationRequest)
DeleteBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketInventoryConfigurationRequest.builder()
deleteBucketInventoryConfigurationRequest
- a Consumer
that will call methods on DeleteBucketInventoryConfigurationRequest.Builder
.default CompletableFuture<DeleteBucketLifecycleResponse> deleteBucketLifecycle(DeleteBucketLifecycleRequest deleteBucketLifecycleRequest)
deleteBucketLifecycleRequest
- default CompletableFuture<DeleteBucketLifecycleResponse> deleteBucketLifecycle(Consumer<DeleteBucketLifecycleRequest.Builder> deleteBucketLifecycleRequest)
DeleteBucketLifecycleRequest.Builder
avoiding the
need to create one manually via DeleteBucketLifecycleRequest.builder()
deleteBucketLifecycleRequest
- a Consumer
that will call methods on DeleteBucketLifecycleRequest.Builder
.default CompletableFuture<DeleteBucketMetricsConfigurationResponse> deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest)
deleteBucketMetricsConfigurationRequest
- default CompletableFuture<DeleteBucketMetricsConfigurationResponse> deleteBucketMetricsConfiguration(Consumer<DeleteBucketMetricsConfigurationRequest.Builder> deleteBucketMetricsConfigurationRequest)
DeleteBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketMetricsConfigurationRequest.builder()
deleteBucketMetricsConfigurationRequest
- a Consumer
that will call methods on DeleteBucketMetricsConfigurationRequest.Builder
.default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
deleteBucketPolicyRequest
- default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
DeleteBucketPolicyRequest.Builder
avoiding the
need to create one manually via DeleteBucketPolicyRequest.builder()
deleteBucketPolicyRequest
- a Consumer
that will call methods on DeleteBucketPolicyRequest.Builder
.default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
deleteBucketReplicationRequest
- default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)
DeleteBucketReplicationRequest.Builder
avoiding
the need to create one manually via DeleteBucketReplicationRequest.builder()
deleteBucketReplicationRequest
- a Consumer
that will call methods on DeleteBucketReplicationRequest.Builder
.default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
deleteBucketTaggingRequest
- default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
DeleteBucketTaggingRequest.Builder
avoiding the
need to create one manually via DeleteBucketTaggingRequest.builder()
deleteBucketTaggingRequest
- a Consumer
that will call methods on DeleteBucketTaggingRequest.Builder
.default CompletableFuture<DeleteBucketWebsiteResponse> deleteBucketWebsite(DeleteBucketWebsiteRequest deleteBucketWebsiteRequest)
deleteBucketWebsiteRequest
- default CompletableFuture<DeleteBucketWebsiteResponse> deleteBucketWebsite(Consumer<DeleteBucketWebsiteRequest.Builder> deleteBucketWebsiteRequest)
DeleteBucketWebsiteRequest.Builder
avoiding the
need to create one manually via DeleteBucketWebsiteRequest.builder()
deleteBucketWebsiteRequest
- a Consumer
that will call methods on DeleteBucketWebsiteRequest.Builder
.default CompletableFuture<DeleteObjectResponse> deleteObject(DeleteObjectRequest deleteObjectRequest)
deleteObjectRequest
- default CompletableFuture<DeleteObjectResponse> deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
DeleteObjectRequest.Builder
avoiding the need to
create one manually via DeleteObjectRequest.builder()
deleteObjectRequest
- a Consumer
that will call methods on DeleteObjectRequest.Builder
.default CompletableFuture<DeleteObjectTaggingResponse> deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest)
deleteObjectTaggingRequest
- default CompletableFuture<DeleteObjectTaggingResponse> deleteObjectTagging(Consumer<DeleteObjectTaggingRequest.Builder> deleteObjectTaggingRequest)
DeleteObjectTaggingRequest.Builder
avoiding the
need to create one manually via DeleteObjectTaggingRequest.builder()
deleteObjectTaggingRequest
- a Consumer
that will call methods on DeleteObjectTaggingRequest.Builder
.default CompletableFuture<DeleteObjectsResponse> deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
deleteObjectsRequest
- default CompletableFuture<DeleteObjectsResponse> deleteObjects(Consumer<DeleteObjectsRequest.Builder> deleteObjectsRequest)
DeleteObjectsRequest.Builder
avoiding the need to
create one manually via DeleteObjectsRequest.builder()
deleteObjectsRequest
- a Consumer
that will call methods on DeleteObjectsRequest.Builder
.default CompletableFuture<GetBucketAccelerateConfigurationResponse> getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest)
getBucketAccelerateConfigurationRequest
- default CompletableFuture<GetBucketAccelerateConfigurationResponse> getBucketAccelerateConfiguration(Consumer<GetBucketAccelerateConfigurationRequest.Builder> getBucketAccelerateConfigurationRequest)
GetBucketAccelerateConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketAccelerateConfigurationRequest.builder()
getBucketAccelerateConfigurationRequest
- a Consumer
that will call methods on GetBucketAccelerateConfigurationRequest.Builder
.default CompletableFuture<GetBucketAclResponse> getBucketAcl(GetBucketAclRequest getBucketAclRequest)
getBucketAclRequest
- default CompletableFuture<GetBucketAclResponse> getBucketAcl(Consumer<GetBucketAclRequest.Builder> getBucketAclRequest)
GetBucketAclRequest.Builder
avoiding the need to
create one manually via GetBucketAclRequest.builder()
getBucketAclRequest
- a Consumer
that will call methods on GetBucketAclRequest.Builder
.default CompletableFuture<GetBucketAnalyticsConfigurationResponse> getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest)
getBucketAnalyticsConfigurationRequest
- default CompletableFuture<GetBucketAnalyticsConfigurationResponse> getBucketAnalyticsConfiguration(Consumer<GetBucketAnalyticsConfigurationRequest.Builder> getBucketAnalyticsConfigurationRequest)
GetBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketAnalyticsConfigurationRequest.builder()
getBucketAnalyticsConfigurationRequest
- a Consumer
that will call methods on GetBucketAnalyticsConfigurationRequest.Builder
.default CompletableFuture<GetBucketCorsResponse> getBucketCors(GetBucketCorsRequest getBucketCorsRequest)
getBucketCorsRequest
- default CompletableFuture<GetBucketCorsResponse> getBucketCors(Consumer<GetBucketCorsRequest.Builder> getBucketCorsRequest)
GetBucketCorsRequest.Builder
avoiding the need to
create one manually via GetBucketCorsRequest.builder()
getBucketCorsRequest
- a Consumer
that will call methods on GetBucketCorsRequest.Builder
.default CompletableFuture<GetBucketInventoryConfigurationResponse> getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest)
getBucketInventoryConfigurationRequest
- default CompletableFuture<GetBucketInventoryConfigurationResponse> getBucketInventoryConfiguration(Consumer<GetBucketInventoryConfigurationRequest.Builder> getBucketInventoryConfigurationRequest)
GetBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketInventoryConfigurationRequest.builder()
getBucketInventoryConfigurationRequest
- a Consumer
that will call methods on GetBucketInventoryConfigurationRequest.Builder
.default CompletableFuture<GetBucketLifecycleResponse> getBucketLifecycle(GetBucketLifecycleRequest getBucketLifecycleRequest)
getBucketLifecycleRequest
- default CompletableFuture<GetBucketLifecycleResponse> getBucketLifecycle(Consumer<GetBucketLifecycleRequest.Builder> getBucketLifecycleRequest)
GetBucketLifecycleRequest.Builder
avoiding the
need to create one manually via GetBucketLifecycleRequest.builder()
getBucketLifecycleRequest
- a Consumer
that will call methods on GetBucketLifecycleRequest.Builder
.default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
getBucketLifecycleConfigurationRequest
- default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
GetBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketLifecycleConfigurationRequest.builder()
getBucketLifecycleConfigurationRequest
- a Consumer
that will call methods on GetBucketLifecycleConfigurationRequest.Builder
.default CompletableFuture<GetBucketLocationResponse> getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
getBucketLocationRequest
- default CompletableFuture<GetBucketLocationResponse> getBucketLocation(Consumer<GetBucketLocationRequest.Builder> getBucketLocationRequest)
GetBucketLocationRequest.Builder
avoiding the need
to create one manually via GetBucketLocationRequest.builder()
getBucketLocationRequest
- a Consumer
that will call methods on GetBucketLocationRequest.Builder
.default CompletableFuture<GetBucketLoggingResponse> getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest)
getBucketLoggingRequest
- default CompletableFuture<GetBucketLoggingResponse> getBucketLogging(Consumer<GetBucketLoggingRequest.Builder> getBucketLoggingRequest)
GetBucketLoggingRequest.Builder
avoiding the need
to create one manually via GetBucketLoggingRequest.builder()
getBucketLoggingRequest
- a Consumer
that will call methods on GetBucketLoggingRequest.Builder
.default CompletableFuture<GetBucketMetricsConfigurationResponse> getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest)
getBucketMetricsConfigurationRequest
- default CompletableFuture<GetBucketMetricsConfigurationResponse> getBucketMetricsConfiguration(Consumer<GetBucketMetricsConfigurationRequest.Builder> getBucketMetricsConfigurationRequest)
GetBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketMetricsConfigurationRequest.builder()
getBucketMetricsConfigurationRequest
- a Consumer
that will call methods on GetBucketMetricsConfigurationRequest.Builder
.default CompletableFuture<GetBucketNotificationResponse> getBucketNotification(GetBucketNotificationRequest getBucketNotificationRequest)
getBucketNotificationRequest
- default CompletableFuture<GetBucketNotificationResponse> getBucketNotification(Consumer<GetBucketNotificationRequest.Builder> getBucketNotificationRequest)
GetBucketNotificationRequest.Builder
avoiding the
need to create one manually via GetBucketNotificationRequest.builder()
getBucketNotificationRequest
- a Consumer
that will call methods on GetBucketNotificationConfigurationRequest.Builder
.default CompletableFuture<GetBucketNotificationConfigurationResponse> getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest)
getBucketNotificationConfigurationRequest
- default CompletableFuture<GetBucketNotificationConfigurationResponse> getBucketNotificationConfiguration(Consumer<GetBucketNotificationConfigurationRequest.Builder> getBucketNotificationConfigurationRequest)
GetBucketNotificationConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketNotificationConfigurationRequest.builder()
getBucketNotificationConfigurationRequest
- a Consumer
that will call methods on GetBucketNotificationConfigurationRequest.Builder
.default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
getBucketPolicyRequest
- default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
GetBucketPolicyRequest.Builder
avoiding the need
to create one manually via GetBucketPolicyRequest.builder()
getBucketPolicyRequest
- a Consumer
that will call methods on GetBucketPolicyRequest.Builder
.default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
getBucketReplicationRequest
- default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
GetBucketReplicationRequest.Builder
avoiding the
need to create one manually via GetBucketReplicationRequest.builder()
getBucketReplicationRequest
- a Consumer
that will call methods on GetBucketReplicationRequest.Builder
.default CompletableFuture<GetBucketRequestPaymentResponse> getBucketRequestPayment(GetBucketRequestPaymentRequest getBucketRequestPaymentRequest)
getBucketRequestPaymentRequest
- default CompletableFuture<GetBucketRequestPaymentResponse> getBucketRequestPayment(Consumer<GetBucketRequestPaymentRequest.Builder> getBucketRequestPaymentRequest)
GetBucketRequestPaymentRequest.Builder
avoiding
the need to create one manually via GetBucketRequestPaymentRequest.builder()
getBucketRequestPaymentRequest
- a Consumer
that will call methods on GetBucketRequestPaymentRequest.Builder
.default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
getBucketTaggingRequest
- default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
GetBucketTaggingRequest.Builder
avoiding the need
to create one manually via GetBucketTaggingRequest.builder()
getBucketTaggingRequest
- a Consumer
that will call methods on GetBucketTaggingRequest.Builder
.default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
getBucketVersioningRequest
- default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)
GetBucketVersioningRequest.Builder
avoiding the
need to create one manually via GetBucketVersioningRequest.builder()
getBucketVersioningRequest
- a Consumer
that will call methods on GetBucketVersioningRequest.Builder
.default CompletableFuture<GetBucketWebsiteResponse> getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest)
getBucketWebsiteRequest
- default CompletableFuture<GetBucketWebsiteResponse> getBucketWebsite(Consumer<GetBucketWebsiteRequest.Builder> getBucketWebsiteRequest)
GetBucketWebsiteRequest.Builder
avoiding the need
to create one manually via GetBucketWebsiteRequest.builder()
getBucketWebsiteRequest
- a Consumer
that will call methods on GetBucketWebsiteRequest.Builder
.default <ReturnT> CompletableFuture<ReturnT> getObject(GetObjectRequest getObjectRequest, AsyncResponseHandler<GetObjectResponse,ReturnT> asyncResponseHandler)
getObjectRequest
- asyncResponseHandler
- The response handler for processing the streaming response in a non-blocking manner. See
AsyncResponseHandler
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 path)
getObjectRequest
- path
- 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)
getObjectAclRequest
- default CompletableFuture<GetObjectAclResponse> getObjectAcl(Consumer<GetObjectAclRequest.Builder> getObjectAclRequest)
GetObjectAclRequest.Builder
avoiding the need to
create one manually via GetObjectAclRequest.builder()
getObjectAclRequest
- a Consumer
that will call methods on GetObjectAclRequest.Builder
.default CompletableFuture<GetObjectTaggingResponse> getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest)
getObjectTaggingRequest
- default CompletableFuture<GetObjectTaggingResponse> getObjectTagging(Consumer<GetObjectTaggingRequest.Builder> getObjectTaggingRequest)
GetObjectTaggingRequest.Builder
avoiding the need
to create one manually via GetObjectTaggingRequest.builder()
getObjectTaggingRequest
- a Consumer
that will call methods on GetObjectTaggingRequest.Builder
.default <ReturnT> CompletableFuture<ReturnT> getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest, AsyncResponseHandler<GetObjectTorrentResponse,ReturnT> asyncResponseHandler)
getObjectTorrentRequest
- asyncResponseHandler
- The response handler for processing the streaming response in a non-blocking manner. See
AsyncResponseHandler
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 path)
getObjectTorrentRequest
- path
- 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<HeadBucketResponse> headBucket(HeadBucketRequest headBucketRequest)
headBucketRequest
- default CompletableFuture<HeadBucketResponse> headBucket(Consumer<HeadBucketRequest.Builder> headBucketRequest)
HeadBucketRequest.Builder
avoiding the need to
create one manually via HeadBucketRequest.builder()
headBucketRequest
- a Consumer
that will call methods on HeadBucketRequest.Builder
.default CompletableFuture<HeadObjectResponse> headObject(HeadObjectRequest headObjectRequest)
headObjectRequest
- default CompletableFuture<HeadObjectResponse> headObject(Consumer<HeadObjectRequest.Builder> headObjectRequest)
HeadObjectRequest.Builder
avoiding the need to
create one manually via HeadObjectRequest.builder()
headObjectRequest
- a Consumer
that will call methods on HeadObjectRequest.Builder
.default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest)
listBucketAnalyticsConfigurationsRequest
- default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> listBucketAnalyticsConfigurations(Consumer<ListBucketAnalyticsConfigurationsRequest.Builder> listBucketAnalyticsConfigurationsRequest)
ListBucketAnalyticsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketAnalyticsConfigurationsRequest.builder()
listBucketAnalyticsConfigurationsRequest
- a Consumer
that will call methods on ListBucketAnalyticsConfigurationsRequest.Builder
.default CompletableFuture<ListBucketInventoryConfigurationsResponse> listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest)
listBucketInventoryConfigurationsRequest
- default CompletableFuture<ListBucketInventoryConfigurationsResponse> listBucketInventoryConfigurations(Consumer<ListBucketInventoryConfigurationsRequest.Builder> listBucketInventoryConfigurationsRequest)
ListBucketInventoryConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketInventoryConfigurationsRequest.builder()
listBucketInventoryConfigurationsRequest
- a Consumer
that will call methods on ListBucketInventoryConfigurationsRequest.Builder
.default CompletableFuture<ListBucketMetricsConfigurationsResponse> listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest)
listBucketMetricsConfigurationsRequest
- default CompletableFuture<ListBucketMetricsConfigurationsResponse> listBucketMetricsConfigurations(Consumer<ListBucketMetricsConfigurationsRequest.Builder> listBucketMetricsConfigurationsRequest)
ListBucketMetricsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketMetricsConfigurationsRequest.builder()
listBucketMetricsConfigurationsRequest
- a Consumer
that will call methods on ListBucketMetricsConfigurationsRequest.Builder
.default CompletableFuture<ListBucketsResponse> listBuckets(ListBucketsRequest listBucketsRequest)
listBucketsRequest
- default CompletableFuture<ListBucketsResponse> listBuckets()
default CompletableFuture<ListBucketsResponse> listBuckets(Consumer<ListBucketsRequest.Builder> listBucketsRequest)
ListBucketsRequest.Builder
avoiding the need to
create one manually via ListBucketsRequest.builder()
listBucketsRequest
- a Consumer
that will call methods on ListBucketsRequest.Builder
.default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
listMultipartUploadsRequest
- default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
ListMultipartUploadsRequest.Builder
avoiding the
need to create one manually via ListMultipartUploadsRequest.builder()
listMultipartUploadsRequest
- a Consumer
that will call methods on ListMultipartUploadsRequest.Builder
.default ListMultipartUploadsPublisher listMultipartUploadsPaginator(ListMultipartUploadsRequest listMultipartUploadsRequest)
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 forEach helper method
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(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 CompletableFuture<ListObjectVersionsResponse> listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest)
listObjectVersionsRequest
- default CompletableFuture<ListObjectVersionsResponse> listObjectVersions(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
ListObjectVersionsRequest.Builder
avoiding the
need to create one manually via ListObjectVersionsRequest.builder()
listObjectVersionsRequest
- a Consumer
that will call methods on ListObjectVersionsRequest.Builder
.default ListObjectVersionsPublisher listObjectVersionsPaginator(ListObjectVersionsRequest listObjectVersionsRequest)
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 forEach helper method
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(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 CompletableFuture<ListObjectsResponse> listObjects(ListObjectsRequest listObjectsRequest)
listObjectsRequest
- default CompletableFuture<ListObjectsResponse> listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
ListObjectsRequest.Builder
avoiding the need to
create one manually via ListObjectsRequest.builder()
listObjectsRequest
- a Consumer
that will call methods on ListObjectsRequest.Builder
.default CompletableFuture<ListObjectsV2Response> listObjectsV2(ListObjectsV2Request listObjectsV2Request)
listObjectsV2Request
- default CompletableFuture<ListObjectsV2Response> listObjectsV2(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
ListObjectsV2Request.Builder
avoiding the need to
create one manually via ListObjectsV2Request.builder()
listObjectsV2Request
- a Consumer
that will call methods on ListObjectsV2Request.Builder
.default ListObjectsV2Publisher listObjectsV2Paginator(ListObjectsV2Request listObjectsV2Request)
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 forEach helper method
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
CompletableFuture<Void> future = publisher.forEach(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 CompletableFuture<ListPartsResponse> listParts(ListPartsRequest listPartsRequest)
listPartsRequest
- default CompletableFuture<ListPartsResponse> listParts(Consumer<ListPartsRequest.Builder> listPartsRequest)
ListPartsRequest.Builder
avoiding the need to
create one manually via ListPartsRequest.builder()
listPartsRequest
- a Consumer
that will call methods on ListPartsRequest.Builder
.default ListPartsPublisher listPartsPaginator(ListPartsRequest listPartsRequest)
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 forEach helper method
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(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 CompletableFuture<PutBucketAccelerateConfigurationResponse> putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest)
putBucketAccelerateConfigurationRequest
- default CompletableFuture<PutBucketAccelerateConfigurationResponse> putBucketAccelerateConfiguration(Consumer<PutBucketAccelerateConfigurationRequest.Builder> putBucketAccelerateConfigurationRequest)
PutBucketAccelerateConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAccelerateConfigurationRequest.builder()
putBucketAccelerateConfigurationRequest
- a Consumer
that will call methods on PutBucketAccelerateConfigurationRequest.Builder
.default CompletableFuture<PutBucketAclResponse> putBucketAcl(PutBucketAclRequest putBucketAclRequest)
putBucketAclRequest
- default CompletableFuture<PutBucketAclResponse> putBucketAcl(Consumer<PutBucketAclRequest.Builder> putBucketAclRequest)
PutBucketAclRequest.Builder
avoiding the need to
create one manually via PutBucketAclRequest.builder()
putBucketAclRequest
- a Consumer
that will call methods on PutBucketAclRequest.Builder
.default CompletableFuture<PutBucketAnalyticsConfigurationResponse> putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest)
putBucketAnalyticsConfigurationRequest
- default CompletableFuture<PutBucketAnalyticsConfigurationResponse> putBucketAnalyticsConfiguration(Consumer<PutBucketAnalyticsConfigurationRequest.Builder> putBucketAnalyticsConfigurationRequest)
PutBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAnalyticsConfigurationRequest.builder()
putBucketAnalyticsConfigurationRequest
- a Consumer
that will call methods on PutBucketAnalyticsConfigurationRequest.Builder
.default CompletableFuture<PutBucketCorsResponse> putBucketCors(PutBucketCorsRequest putBucketCorsRequest)
putBucketCorsRequest
- default CompletableFuture<PutBucketCorsResponse> putBucketCors(Consumer<PutBucketCorsRequest.Builder> putBucketCorsRequest)
PutBucketCorsRequest.Builder
avoiding the need to
create one manually via PutBucketCorsRequest.builder()
putBucketCorsRequest
- a Consumer
that will call methods on PutBucketCorsRequest.Builder
.default CompletableFuture<PutBucketInventoryConfigurationResponse> putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest)
putBucketInventoryConfigurationRequest
- default CompletableFuture<PutBucketInventoryConfigurationResponse> putBucketInventoryConfiguration(Consumer<PutBucketInventoryConfigurationRequest.Builder> putBucketInventoryConfigurationRequest)
PutBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketInventoryConfigurationRequest.builder()
putBucketInventoryConfigurationRequest
- a Consumer
that will call methods on PutBucketInventoryConfigurationRequest.Builder
.default CompletableFuture<PutBucketLifecycleResponse> putBucketLifecycle(PutBucketLifecycleRequest putBucketLifecycleRequest)
putBucketLifecycleRequest
- default CompletableFuture<PutBucketLifecycleResponse> putBucketLifecycle(Consumer<PutBucketLifecycleRequest.Builder> putBucketLifecycleRequest)
PutBucketLifecycleRequest.Builder
avoiding the
need to create one manually via PutBucketLifecycleRequest.builder()
putBucketLifecycleRequest
- a Consumer
that will call methods on PutBucketLifecycleRequest.Builder
.default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
putBucketLifecycleConfigurationRequest
- default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
PutBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketLifecycleConfigurationRequest.builder()
putBucketLifecycleConfigurationRequest
- a Consumer
that will call methods on PutBucketLifecycleConfigurationRequest.Builder
.default CompletableFuture<PutBucketLoggingResponse> putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest)
putBucketLoggingRequest
- default CompletableFuture<PutBucketLoggingResponse> putBucketLogging(Consumer<PutBucketLoggingRequest.Builder> putBucketLoggingRequest)
PutBucketLoggingRequest.Builder
avoiding the need
to create one manually via PutBucketLoggingRequest.builder()
putBucketLoggingRequest
- a Consumer
that will call methods on PutBucketLoggingRequest.Builder
.default CompletableFuture<PutBucketMetricsConfigurationResponse> putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest)
putBucketMetricsConfigurationRequest
- default CompletableFuture<PutBucketMetricsConfigurationResponse> putBucketMetricsConfiguration(Consumer<PutBucketMetricsConfigurationRequest.Builder> putBucketMetricsConfigurationRequest)
PutBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketMetricsConfigurationRequest.builder()
putBucketMetricsConfigurationRequest
- a Consumer
that will call methods on PutBucketMetricsConfigurationRequest.Builder
.default CompletableFuture<PutBucketNotificationResponse> putBucketNotification(PutBucketNotificationRequest putBucketNotificationRequest)
putBucketNotificationRequest
- default CompletableFuture<PutBucketNotificationResponse> putBucketNotification(Consumer<PutBucketNotificationRequest.Builder> putBucketNotificationRequest)
PutBucketNotificationRequest.Builder
avoiding the
need to create one manually via PutBucketNotificationRequest.builder()
putBucketNotificationRequest
- a Consumer
that will call methods on PutBucketNotificationRequest.Builder
.default CompletableFuture<PutBucketNotificationConfigurationResponse> putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest)
putBucketNotificationConfigurationRequest
- default CompletableFuture<PutBucketNotificationConfigurationResponse> putBucketNotificationConfiguration(Consumer<PutBucketNotificationConfigurationRequest.Builder> putBucketNotificationConfigurationRequest)
PutBucketNotificationConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketNotificationConfigurationRequest.builder()
putBucketNotificationConfigurationRequest
- a Consumer
that will call methods on PutBucketNotificationConfigurationRequest.Builder
.default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
putBucketPolicyRequest
- default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
PutBucketPolicyRequest.Builder
avoiding the need
to create one manually via PutBucketPolicyRequest.builder()
putBucketPolicyRequest
- a Consumer
that will call methods on PutBucketPolicyRequest.Builder
.default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
putBucketReplicationRequest
- default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
PutBucketReplicationRequest.Builder
avoiding the
need to create one manually via PutBucketReplicationRequest.builder()
putBucketReplicationRequest
- a Consumer
that will call methods on PutBucketReplicationRequest.Builder
.default CompletableFuture<PutBucketRequestPaymentResponse> putBucketRequestPayment(PutBucketRequestPaymentRequest putBucketRequestPaymentRequest)
putBucketRequestPaymentRequest
- default CompletableFuture<PutBucketRequestPaymentResponse> putBucketRequestPayment(Consumer<PutBucketRequestPaymentRequest.Builder> putBucketRequestPaymentRequest)
PutBucketRequestPaymentRequest.Builder
avoiding
the need to create one manually via PutBucketRequestPaymentRequest.builder()
putBucketRequestPaymentRequest
- a Consumer
that will call methods on PutBucketRequestPaymentRequest.Builder
.default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
putBucketTaggingRequest
- default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
PutBucketTaggingRequest.Builder
avoiding the need
to create one manually via PutBucketTaggingRequest.builder()
putBucketTaggingRequest
- a Consumer
that will call methods on PutBucketTaggingRequest.Builder
.default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
putBucketVersioningRequest
- default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)
PutBucketVersioningRequest.Builder
avoiding the
need to create one manually via PutBucketVersioningRequest.builder()
putBucketVersioningRequest
- a Consumer
that will call methods on PutBucketVersioningRequest.Builder
.default CompletableFuture<PutBucketWebsiteResponse> putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest)
putBucketWebsiteRequest
- default CompletableFuture<PutBucketWebsiteResponse> putBucketWebsite(Consumer<PutBucketWebsiteRequest.Builder> putBucketWebsiteRequest)
PutBucketWebsiteRequest.Builder
avoiding the need
to create one manually via PutBucketWebsiteRequest.builder()
putBucketWebsiteRequest
- a Consumer
that will call methods on PutBucketWebsiteRequest.Builder
.default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest, AsyncRequestProvider requestProvider)
putObjectRequest
- requestProvider
- 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 AsyncRequestProvider
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 path)
putObjectRequest
- path
- 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)
putObjectAclRequest
- default CompletableFuture<PutObjectAclResponse> putObjectAcl(Consumer<PutObjectAclRequest.Builder> putObjectAclRequest)
PutObjectAclRequest.Builder
avoiding the need to
create one manually via PutObjectAclRequest.builder()
putObjectAclRequest
- a Consumer
that will call methods on PutObjectAclRequest.Builder
.default CompletableFuture<PutObjectTaggingResponse> putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest)
putObjectTaggingRequest
- default CompletableFuture<PutObjectTaggingResponse> putObjectTagging(Consumer<PutObjectTaggingRequest.Builder> putObjectTaggingRequest)
PutObjectTaggingRequest.Builder
avoiding the need
to create one manually via PutObjectTaggingRequest.builder()
putObjectTaggingRequest
- a Consumer
that will call methods on PutObjectTaggingRequest.Builder
.default CompletableFuture<RestoreObjectResponse> restoreObject(RestoreObjectRequest restoreObjectRequest)
restoreObjectRequest
- default CompletableFuture<RestoreObjectResponse> restoreObject(Consumer<RestoreObjectRequest.Builder> restoreObjectRequest)
RestoreObjectRequest.Builder
avoiding the need to
create one manually via RestoreObjectRequest.builder()
restoreObjectRequest
- a Consumer
that will call methods on RestoreObjectRequest.Builder
.default CompletableFuture<UploadPartResponse> uploadPart(UploadPartRequest uploadPartRequest, AsyncRequestProvider requestProvider)
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
- requestProvider
- 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 AsyncRequestProvider
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 path)
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
- path
- 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)
uploadPartCopyRequest
- default CompletableFuture<UploadPartCopyResponse> uploadPartCopy(Consumer<UploadPartCopyRequest.Builder> uploadPartCopyRequest)
UploadPartCopyRequest.Builder
avoiding the need to
create one manually via UploadPartCopyRequest.builder()
uploadPartCopyRequest
- a Consumer
that will call methods on UploadPartCopyRequest.Builder
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.