@Generated(value="software.amazon.awssdk:codegen") public interface S3ControlAsyncClient extends SdkClient
builder()
method.
AWS S3 Control provides access to Amazon S3 control plane operations.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static S3ControlAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
S3ControlAsyncClient. |
static S3ControlAsyncClient |
create()
Create a
S3ControlAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAccessPointResponse> |
createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
Creates an access point and associates it with the specified bucket.
|
default CompletableFuture<CreateAccessPointResponse> |
createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
Creates an access point and associates it with the specified bucket.
|
default CompletableFuture<CreateJobResponse> |
createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates an Amazon S3 batch operations job.
|
default CompletableFuture<CreateJobResponse> |
createJob(CreateJobRequest createJobRequest)
Creates an Amazon S3 batch operations job.
|
default CompletableFuture<DeleteAccessPointResponse> |
deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
Deletes the specified access point.
|
default CompletableFuture<DeleteAccessPointResponse> |
deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
Deletes the specified access point.
|
default CompletableFuture<DeleteAccessPointPolicyResponse> |
deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest)
Deletes the access point policy for the specified access point.
|
default CompletableFuture<DeleteAccessPointPolicyResponse> |
deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)
Deletes the access point policy for the specified access point.
|
default CompletableFuture<DeleteJobTaggingResponse> |
deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest)
Delete the tags on a Amazon S3 batch operations job, if any.
|
default CompletableFuture<DeleteJobTaggingResponse> |
deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)
Delete the tags on a Amazon S3 batch operations job, if any.
|
default CompletableFuture<DeletePublicAccessBlockResponse> |
deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration for an Amazon Web Services account. |
default CompletableFuture<DeletePublicAccessBlockResponse> |
deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration for an Amazon Web Services account. |
default CompletableFuture<DescribeJobResponse> |
describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
Retrieves the configuration parameters and status for a batch operations job.
|
default CompletableFuture<DescribeJobResponse> |
describeJob(DescribeJobRequest describeJobRequest)
Retrieves the configuration parameters and status for a batch operations job.
|
default CompletableFuture<GetAccessPointResponse> |
getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest)
Returns configuration information about the specified access point.
|
default CompletableFuture<GetAccessPointResponse> |
getAccessPoint(GetAccessPointRequest getAccessPointRequest)
Returns configuration information about the specified access point.
|
default CompletableFuture<GetAccessPointPolicyResponse> |
getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest)
Returns the access point policy associated with the specified access point.
|
default CompletableFuture<GetAccessPointPolicyResponse> |
getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)
Returns the access point policy associated with the specified access point.
|
default CompletableFuture<GetAccessPointPolicyStatusResponse> |
getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest)
Indicates whether the specified access point currently has a policy that allows public access.
|
default CompletableFuture<GetAccessPointPolicyStatusResponse> |
getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)
Indicates whether the specified access point currently has a policy that allows public access.
|
default CompletableFuture<GetJobTaggingResponse> |
getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest)
Retrieve the tags on a Amazon S3 batch operations job.
|
default CompletableFuture<GetJobTaggingResponse> |
getJobTagging(GetJobTaggingRequest getJobTaggingRequest)
Retrieve the tags on a Amazon S3 batch operations job.
|
default CompletableFuture<GetPublicAccessBlockResponse> |
getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an Amazon Web Services account. |
default CompletableFuture<GetPublicAccessBlockResponse> |
getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an Amazon Web Services account. |
default CompletableFuture<ListAccessPointsResponse> |
listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default CompletableFuture<ListAccessPointsResponse> |
listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default ListAccessPointsPublisher |
listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default ListAccessPointsPublisher |
listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket.
|
default CompletableFuture<ListJobsResponse> |
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
|
default CompletableFuture<ListJobsResponse> |
listJobs(ListJobsRequest listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
|
default ListJobsPublisher |
listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
|
default ListJobsPublisher |
listJobsPaginator(ListJobsRequest listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
|
default CompletableFuture<PutAccessPointPolicyResponse> |
putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest)
Associates an access policy with the specified access point.
|
default CompletableFuture<PutAccessPointPolicyResponse> |
putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)
Associates an access policy with the specified access point.
|
default CompletableFuture<PutJobTaggingResponse> |
putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest)
Replace the set of tags on a Amazon S3 batch operations job.
|
default CompletableFuture<PutJobTaggingResponse> |
putJobTagging(PutJobTaggingRequest putJobTaggingRequest)
Replace the set of tags on a Amazon S3 batch operations job.
|
default CompletableFuture<PutPublicAccessBlockResponse> |
putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an Amazon Web Services account. |
default CompletableFuture<PutPublicAccessBlockResponse> |
putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an Amazon Web Services account. |
default CompletableFuture<UpdateJobPriorityResponse> |
updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest)
Updates an existing job's priority.
|
default CompletableFuture<UpdateJobPriorityResponse> |
updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)
Updates an existing job's priority.
|
default CompletableFuture<UpdateJobStatusResponse> |
updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest)
Updates the status for the specified job.
|
default CompletableFuture<UpdateJobStatusResponse> |
updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)
Updates the status for the specified job.
|
serviceNameclosestatic final String SERVICE_NAME
static S3ControlAsyncClient create()
S3ControlAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static S3ControlAsyncClientBuilder builder()
S3ControlAsyncClient.default CompletableFuture<CreateAccessPointResponse> createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
Creates an access point and associates it with the specified bucket.
createAccessPointRequest - default CompletableFuture<CreateAccessPointResponse> createAccessPoint(Consumer<CreateAccessPointRequest.Builder> createAccessPointRequest)
Creates an access point and associates it with the specified bucket.
This is a convenience which creates an instance of the CreateAccessPointRequest.Builder avoiding the need
to create one manually via CreateAccessPointRequest.builder()
createAccessPointRequest - A Consumer that will call methods on CreateAccessPointRequest.Builder to create a request.default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)
Creates an Amazon S3 batch operations job.
createJobRequest - default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates an Amazon S3 batch operations job.
This is a convenience which creates an instance of the CreateJobRequest.Builder avoiding the need to
create one manually via CreateJobRequest.builder()
createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
Deletes the specified access point.
deleteAccessPointRequest - default CompletableFuture<DeleteAccessPointResponse> deleteAccessPoint(Consumer<DeleteAccessPointRequest.Builder> deleteAccessPointRequest)
Deletes the specified access point.
This is a convenience which creates an instance of the DeleteAccessPointRequest.Builder avoiding the need
to create one manually via DeleteAccessPointRequest.builder()
deleteAccessPointRequest - A Consumer that will call methods on DeleteAccessPointRequest.Builder to create a request.default CompletableFuture<DeleteAccessPointPolicyResponse> deleteAccessPointPolicy(DeleteAccessPointPolicyRequest deleteAccessPointPolicyRequest)
Deletes the access point policy for the specified access point.
deleteAccessPointPolicyRequest - default CompletableFuture<DeleteAccessPointPolicyResponse> deleteAccessPointPolicy(Consumer<DeleteAccessPointPolicyRequest.Builder> deleteAccessPointPolicyRequest)
Deletes the access point policy for the specified access point.
This is a convenience which creates an instance of the DeleteAccessPointPolicyRequest.Builder avoiding
the need to create one manually via DeleteAccessPointPolicyRequest.builder()
deleteAccessPointPolicyRequest - A Consumer that will call methods on DeleteAccessPointPolicyRequest.Builder to create a
request.default CompletableFuture<DeleteJobTaggingResponse> deleteJobTagging(DeleteJobTaggingRequest deleteJobTaggingRequest)
Delete the tags on a Amazon S3 batch operations job, if any.
deleteJobTaggingRequest - default CompletableFuture<DeleteJobTaggingResponse> deleteJobTagging(Consumer<DeleteJobTaggingRequest.Builder> deleteJobTaggingRequest)
Delete the tags on a Amazon S3 batch operations job, if any.
This is a convenience which creates an instance of the DeleteJobTaggingRequest.Builder avoiding the need
to create one manually via DeleteJobTaggingRequest.builder()
deleteJobTaggingRequest - A Consumer that will call methods on DeleteJobTaggingRequest.Builder to create a request.default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
Removes the PublicAccessBlock configuration for an Amazon Web Services account.
deletePublicAccessBlockRequest - default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
Removes the PublicAccessBlock configuration for an Amazon Web Services account.
This is a convenience which creates an instance of the DeletePublicAccessBlockRequest.Builder avoiding
the need to create one manually via DeletePublicAccessBlockRequest.builder()
deletePublicAccessBlockRequest - A Consumer that will call methods on DeletePublicAccessBlockRequest.Builder to create a
request.default CompletableFuture<DescribeJobResponse> describeJob(DescribeJobRequest describeJobRequest)
Retrieves the configuration parameters and status for a batch operations job.
describeJobRequest - default CompletableFuture<DescribeJobResponse> describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
Retrieves the configuration parameters and status for a batch operations job.
This is a convenience which creates an instance of the DescribeJobRequest.Builder avoiding the need to
create one manually via DescribeJobRequest.builder()
describeJobRequest - A Consumer that will call methods on DescribeJobRequest.Builder to create a request.default CompletableFuture<GetAccessPointResponse> getAccessPoint(GetAccessPointRequest getAccessPointRequest)
Returns configuration information about the specified access point.
getAccessPointRequest - default CompletableFuture<GetAccessPointResponse> getAccessPoint(Consumer<GetAccessPointRequest.Builder> getAccessPointRequest)
Returns configuration information about the specified access point.
This is a convenience which creates an instance of the GetAccessPointRequest.Builder avoiding the need to
create one manually via GetAccessPointRequest.builder()
getAccessPointRequest - A Consumer that will call methods on GetAccessPointRequest.Builder to create a request.default CompletableFuture<GetAccessPointPolicyResponse> getAccessPointPolicy(GetAccessPointPolicyRequest getAccessPointPolicyRequest)
Returns the access point policy associated with the specified access point.
getAccessPointPolicyRequest - default CompletableFuture<GetAccessPointPolicyResponse> getAccessPointPolicy(Consumer<GetAccessPointPolicyRequest.Builder> getAccessPointPolicyRequest)
Returns the access point policy associated with the specified access point.
This is a convenience which creates an instance of the GetAccessPointPolicyRequest.Builder avoiding the
need to create one manually via GetAccessPointPolicyRequest.builder()
getAccessPointPolicyRequest - A Consumer that will call methods on GetAccessPointPolicyRequest.Builder to create a
request.default CompletableFuture<GetAccessPointPolicyStatusResponse> getAccessPointPolicyStatus(GetAccessPointPolicyStatusRequest getAccessPointPolicyStatusRequest)
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
getAccessPointPolicyStatusRequest - default CompletableFuture<GetAccessPointPolicyStatusResponse> getAccessPointPolicyStatus(Consumer<GetAccessPointPolicyStatusRequest.Builder> getAccessPointPolicyStatusRequest)
Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
This is a convenience which creates an instance of the GetAccessPointPolicyStatusRequest.Builder avoiding
the need to create one manually via GetAccessPointPolicyStatusRequest.builder()
getAccessPointPolicyStatusRequest - A Consumer that will call methods on GetAccessPointPolicyStatusRequest.Builder to create a
request.default CompletableFuture<GetJobTaggingResponse> getJobTagging(GetJobTaggingRequest getJobTaggingRequest)
Retrieve the tags on a Amazon S3 batch operations job.
getJobTaggingRequest - default CompletableFuture<GetJobTaggingResponse> getJobTagging(Consumer<GetJobTaggingRequest.Builder> getJobTaggingRequest)
Retrieve the tags on a Amazon S3 batch operations job.
This is a convenience which creates an instance of the GetJobTaggingRequest.Builder avoiding the need to
create one manually via GetJobTaggingRequest.builder()
getJobTaggingRequest - A Consumer that will call methods on GetJobTaggingRequest.Builder to create a request.default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
getPublicAccessBlockRequest - GetPublicAccessBlock request against an account that doesn't have a
PublicAccessBlockConfiguration set.default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
This is a convenience which creates an instance of the GetPublicAccessBlockRequest.Builder avoiding the
need to create one manually via GetPublicAccessBlockRequest.builder()
getPublicAccessBlockRequest - A Consumer that will call methods on GetPublicAccessBlockRequest.Builder to create a
request.GetPublicAccessBlock request against an account that doesn't have a
PublicAccessBlockConfiguration set.default CompletableFuture<ListAccessPointsResponse> listAccessPoints(ListAccessPointsRequest listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000
access points per call. If the specified bucket has more than 1000 access points (or the number specified in
maxResults, whichever is less), then the response will include a continuation token that you can use
to list the additional access points.
listAccessPointsRequest - default CompletableFuture<ListAccessPointsResponse> listAccessPoints(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000
access points per call. If the specified bucket has more than 1000 access points (or the number specified in
maxResults, whichever is less), then the response will include a continuation token that you can use
to list the additional access points.
This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need
to create one manually via ListAccessPointsRequest.builder()
listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.default ListAccessPointsPublisher listAccessPointsPaginator(ListAccessPointsRequest listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000
access points per call. If the specified bucket has more than 1000 access points (or the number specified in
maxResults, whichever is less), then the response will include a continuation token that you can use
to list the additional access points.
This is a variant of
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse 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
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.
listAccessPointsRequest - default ListAccessPointsPublisher listAccessPointsPaginator(Consumer<ListAccessPointsRequest.Builder> listAccessPointsRequest)
Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000
access points per call. If the specified bucket has more than 1000 access points (or the number specified in
maxResults, whichever is less), then the response will include a continuation token that you can use
to list the additional access points.
This is a variant of
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3control.paginators.ListAccessPointsPublisher publisher = client.listAccessPointsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3control.model.ListAccessPointsResponse 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
listAccessPoints(software.amazon.awssdk.services.s3control.model.ListAccessPointsRequest) operation.
This is a convenience which creates an instance of the ListAccessPointsRequest.Builder avoiding the need
to create one manually via ListAccessPointsRequest.builder()
listAccessPointsRequest - A Consumer that will call methods on ListAccessPointsRequest.Builder to create a request.default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
listJobsRequest - default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3control.model.ListJobsResponse 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
listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.
listJobsRequest - default ListJobsPublisher listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
This is a variant of listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3control.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3control.model.ListJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3control.model.ListJobsResponse 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
listJobs(software.amazon.awssdk.services.s3control.model.ListJobsRequest) operation.
This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.default CompletableFuture<PutAccessPointPolicyResponse> putAccessPointPolicy(PutAccessPointPolicyRequest putAccessPointPolicyRequest)
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
putAccessPointPolicyRequest - default CompletableFuture<PutAccessPointPolicyResponse> putAccessPointPolicy(Consumer<PutAccessPointPolicyRequest.Builder> putAccessPointPolicyRequest)
Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
This is a convenience which creates an instance of the PutAccessPointPolicyRequest.Builder avoiding the
need to create one manually via PutAccessPointPolicyRequest.builder()
putAccessPointPolicyRequest - A Consumer that will call methods on PutAccessPointPolicyRequest.Builder to create a
request.default CompletableFuture<PutJobTaggingResponse> putJobTagging(PutJobTaggingRequest putJobTaggingRequest)
Replace the set of tags on a Amazon S3 batch operations job.
putJobTaggingRequest - default CompletableFuture<PutJobTaggingResponse> putJobTagging(Consumer<PutJobTaggingRequest.Builder> putJobTaggingRequest)
Replace the set of tags on a Amazon S3 batch operations job.
This is a convenience which creates an instance of the PutJobTaggingRequest.Builder avoiding the need to
create one manually via PutJobTaggingRequest.builder()
putJobTaggingRequest - A Consumer that will call methods on PutJobTaggingRequest.Builder to create a request.default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
putPublicAccessBlockRequest - default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
This is a convenience which creates an instance of the PutPublicAccessBlockRequest.Builder avoiding the
need to create one manually via PutPublicAccessBlockRequest.builder()
putPublicAccessBlockRequest - A Consumer that will call methods on PutPublicAccessBlockRequest.Builder to create a
request.default CompletableFuture<UpdateJobPriorityResponse> updateJobPriority(UpdateJobPriorityRequest updateJobPriorityRequest)
Updates an existing job's priority.
updateJobPriorityRequest - default CompletableFuture<UpdateJobPriorityResponse> updateJobPriority(Consumer<UpdateJobPriorityRequest.Builder> updateJobPriorityRequest)
Updates an existing job's priority.
This is a convenience which creates an instance of the UpdateJobPriorityRequest.Builder avoiding the need
to create one manually via UpdateJobPriorityRequest.builder()
updateJobPriorityRequest - A Consumer that will call methods on UpdateJobPriorityRequest.Builder to create a request.default CompletableFuture<UpdateJobStatusResponse> updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)
Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job.
updateJobStatusRequest - default CompletableFuture<UpdateJobStatusResponse> updateJobStatus(Consumer<UpdateJobStatusRequest.Builder> updateJobStatusRequest)
Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job.
This is a convenience which creates an instance of the UpdateJobStatusRequest.Builder avoiding the need
to create one manually via UpdateJobStatusRequest.builder()
updateJobStatusRequest - A Consumer that will call methods on UpdateJobStatusRequest.Builder to create a request.Copyright © 2020. All rights reserved.