software.amazon.awssdk.services.s3outposts.S3OutpostsAsyncClient Maven / Gradle / Ivy
Show all versions of s3outposts Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.s3outposts;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.s3outposts.model.CreateEndpointRequest;
import software.amazon.awssdk.services.s3outposts.model.CreateEndpointResponse;
import software.amazon.awssdk.services.s3outposts.model.DeleteEndpointRequest;
import software.amazon.awssdk.services.s3outposts.model.DeleteEndpointResponse;
import software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest;
import software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse;
import software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest;
import software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse;
import software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsPublisher;
import software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsPublisher;
/**
* Service client for accessing Amazon S3 Outposts asynchronously. This can be created using the static
* {@link #builder()} method.
*
*
* Amazon S3 on Outposts provides access to S3 on Outposts operations.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface S3OutpostsAsyncClient extends SdkClient {
String SERVICE_NAME = "s3-outposts";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "s3-outposts";
/**
* Create a {@link S3OutpostsAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static S3OutpostsAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link S3OutpostsAsyncClient}.
*/
static S3OutpostsAsyncClientBuilder builder() {
return new DefaultS3OutpostsAsyncClientBuilder();
}
/**
*
* Creates an endpoint and associates it with the specified Outpost.
*
*
*
* It can take up to 5 minutes for this action to finish.
*
*
*
*
* Related actions include:
*
*
* -
*
* DeleteEndpoint
*
*
* -
*
* ListEndpoints
*
*
*
*
* @param createEndpointRequest
* @return A Java Future containing the result of the CreateEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ValidationException There was an exception validating this data.
* - AccessDeniedException Access was denied for this action.
* - ResourceNotFoundException The requested resource was not found.
* - ConflictException There was a conflict with this action, and it could not be completed.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.CreateEndpoint
* @see AWS API
* Documentation
*/
default CompletableFuture createEndpoint(CreateEndpointRequest createEndpointRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an endpoint and associates it with the specified Outpost.
*
*
*
* It can take up to 5 minutes for this action to finish.
*
*
*
*
* Related actions include:
*
*
* -
*
* DeleteEndpoint
*
*
* -
*
* ListEndpoints
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateEndpointRequest.Builder} avoiding the need to
* create one manually via {@link CreateEndpointRequest#builder()}
*
*
* @param createEndpointRequest
* A {@link Consumer} that will call methods on {@link CreateEndpointRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ValidationException There was an exception validating this data.
* - AccessDeniedException Access was denied for this action.
* - ResourceNotFoundException The requested resource was not found.
* - ConflictException There was a conflict with this action, and it could not be completed.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.CreateEndpoint
* @see AWS API
* Documentation
*/
default CompletableFuture createEndpoint(Consumer createEndpointRequest) {
return createEndpoint(CreateEndpointRequest.builder().applyMutation(createEndpointRequest).build());
}
/**
*
* Deletes an endpoint.
*
*
*
* It can take up to 5 minutes for this action to finish.
*
*
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* ListEndpoints
*
*
*
*
* @param deleteEndpointRequest
* @return A Java Future containing the result of the DeleteEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - AccessDeniedException Access was denied for this action.
* - ResourceNotFoundException The requested resource was not found.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.DeleteEndpoint
* @see AWS API
* Documentation
*/
default CompletableFuture deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an endpoint.
*
*
*
* It can take up to 5 minutes for this action to finish.
*
*
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* ListEndpoints
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEndpointRequest.Builder} avoiding the need to
* create one manually via {@link DeleteEndpointRequest#builder()}
*
*
* @param deleteEndpointRequest
* A {@link Consumer} that will call methods on {@link DeleteEndpointRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteEndpoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - AccessDeniedException Access was denied for this action.
* - ResourceNotFoundException The requested resource was not found.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.DeleteEndpoint
* @see AWS API
* Documentation
*/
default CompletableFuture deleteEndpoint(Consumer deleteEndpointRequest) {
return deleteEndpoint(DeleteEndpointRequest.builder().applyMutation(deleteEndpointRequest).build());
}
/**
*
* Lists endpoints associated with the specified Outpost.
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
* @param listEndpointsRequest
* @return A Java Future containing the result of the ListEndpoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListEndpoints
* @see AWS API
* Documentation
*/
default CompletableFuture listEndpoints(ListEndpointsRequest listEndpointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists endpoints associated with the specified Outpost.
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListEndpointsRequest.Builder} avoiding the need to
* create one manually via {@link ListEndpointsRequest#builder()}
*
*
* @param listEndpointsRequest
* A {@link Consumer} that will call methods on {@link ListEndpointsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListEndpoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListEndpoints
* @see AWS API
* Documentation
*/
default CompletableFuture listEndpoints(Consumer listEndpointsRequest) {
return listEndpoints(ListEndpointsRequest.builder().applyMutation(listEndpointsRequest).build());
}
/**
*
* Lists endpoints associated with the specified Outpost.
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
*
* This is a variant of
* {@link #listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest)} operation.
*
*
* @param listEndpointsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListEndpoints
* @see AWS API
* Documentation
*/
default ListEndpointsPublisher listEndpointsPaginator(ListEndpointsRequest listEndpointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists endpoints associated with the specified Outpost.
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
*
* This is a variant of
* {@link #listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListEndpointsPublisher publisher = client.listEndpointsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3outposts.model.ListEndpointsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listEndpoints(software.amazon.awssdk.services.s3outposts.model.ListEndpointsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListEndpointsRequest.Builder} avoiding the need to
* create one manually via {@link ListEndpointsRequest#builder()}
*
*
* @param listEndpointsRequest
* A {@link Consumer} that will call methods on {@link ListEndpointsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListEndpoints
* @see AWS API
* Documentation
*/
default ListEndpointsPublisher listEndpointsPaginator(Consumer listEndpointsRequest) {
return listEndpointsPaginator(ListEndpointsRequest.builder().applyMutation(listEndpointsRequest).build());
}
/**
*
* Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access
* Manager (RAM).
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
* @param listSharedEndpointsRequest
* @return A Java Future containing the result of the ListSharedEndpoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListSharedEndpoints
* @see AWS API Documentation
*/
default CompletableFuture listSharedEndpoints(
ListSharedEndpointsRequest listSharedEndpointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access
* Manager (RAM).
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListSharedEndpointsRequest.Builder} avoiding the
* need to create one manually via {@link ListSharedEndpointsRequest#builder()}
*
*
* @param listSharedEndpointsRequest
* A {@link Consumer} that will call methods on {@link ListSharedEndpointsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListSharedEndpoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListSharedEndpoints
* @see AWS API Documentation
*/
default CompletableFuture listSharedEndpoints(
Consumer listSharedEndpointsRequest) {
return listSharedEndpoints(ListSharedEndpointsRequest.builder().applyMutation(listSharedEndpointsRequest).build());
}
/**
*
* Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access
* Manager (RAM).
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
*
* This is a variant of
* {@link #listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest)}
* operation.
*
*
* @param listSharedEndpointsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListSharedEndpoints
* @see AWS API Documentation
*/
default ListSharedEndpointsPublisher listSharedEndpointsPaginator(ListSharedEndpointsRequest listSharedEndpointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access
* Manager (RAM).
*
*
* Related actions include:
*
*
* -
*
* CreateEndpoint
*
*
* -
*
* DeleteEndpoint
*
*
*
*
*
* This is a variant of
* {@link #listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.s3outposts.paginators.ListSharedEndpointsPublisher publisher = client.listSharedEndpointsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSharedEndpoints(software.amazon.awssdk.services.s3outposts.model.ListSharedEndpointsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListSharedEndpointsRequest.Builder} avoiding the
* need to create one manually via {@link ListSharedEndpointsRequest#builder()}
*
*
* @param listSharedEndpointsRequest
* A {@link Consumer} that will call methods on {@link ListSharedEndpointsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InternalServerException There was an exception with the internal server.
* - ResourceNotFoundException The requested resource was not found.
* - AccessDeniedException Access was denied for this action.
* - ValidationException There was an exception validating this data.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - S3OutpostsException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample S3OutpostsAsyncClient.ListSharedEndpoints
* @see AWS API Documentation
*/
default ListSharedEndpointsPublisher listSharedEndpointsPaginator(
Consumer listSharedEndpointsRequest) {
return listSharedEndpointsPaginator(ListSharedEndpointsRequest.builder().applyMutation(listSharedEndpointsRequest)
.build());
}
}