@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OutpostsAsyncClient extends SdkClient
builder() method.
Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static OutpostsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
OutpostsAsyncClient. |
default CompletableFuture<CancelOrderResponse> |
cancelOrder(CancelOrderRequest cancelOrderRequest)
Cancels an order for an Outpost.
|
default CompletableFuture<CancelOrderResponse> |
cancelOrder(Consumer<CancelOrderRequest.Builder> cancelOrderRequest)
Cancels an order for an Outpost.
|
static OutpostsAsyncClient |
create()
Create a
OutpostsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateOrderResponse> |
createOrder(Consumer<CreateOrderRequest.Builder> createOrderRequest)
Creates an order for an Outpost.
|
default CompletableFuture<CreateOrderResponse> |
createOrder(CreateOrderRequest createOrderRequest)
Creates an order for an Outpost.
|
default CompletableFuture<CreateOutpostResponse> |
createOutpost(Consumer<CreateOutpostRequest.Builder> createOutpostRequest)
Creates an Outpost.
|
default CompletableFuture<CreateOutpostResponse> |
createOutpost(CreateOutpostRequest createOutpostRequest)
Creates an Outpost.
|
default CompletableFuture<CreateSiteResponse> |
createSite(Consumer<CreateSiteRequest.Builder> createSiteRequest)
Creates a site for an Outpost.
|
default CompletableFuture<CreateSiteResponse> |
createSite(CreateSiteRequest createSiteRequest)
Creates a site for an Outpost.
|
default CompletableFuture<DeleteOutpostResponse> |
deleteOutpost(Consumer<DeleteOutpostRequest.Builder> deleteOutpostRequest)
Deletes the Outpost.
|
default CompletableFuture<DeleteOutpostResponse> |
deleteOutpost(DeleteOutpostRequest deleteOutpostRequest)
Deletes the Outpost.
|
default CompletableFuture<DeleteSiteResponse> |
deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest)
Deletes the site.
|
default CompletableFuture<DeleteSiteResponse> |
deleteSite(DeleteSiteRequest deleteSiteRequest)
Deletes the site.
|
default CompletableFuture<GetCatalogItemResponse> |
getCatalogItem(Consumer<GetCatalogItemRequest.Builder> getCatalogItemRequest)
Gets information about a catalog item.
|
default CompletableFuture<GetCatalogItemResponse> |
getCatalogItem(GetCatalogItemRequest getCatalogItemRequest)
Gets information about a catalog item.
|
default CompletableFuture<GetOrderResponse> |
getOrder(Consumer<GetOrderRequest.Builder> getOrderRequest)
Gets an order.
|
default CompletableFuture<GetOrderResponse> |
getOrder(GetOrderRequest getOrderRequest)
Gets an order.
|
default CompletableFuture<GetOutpostResponse> |
getOutpost(Consumer<GetOutpostRequest.Builder> getOutpostRequest)
Gets information about the specified Outpost.
|
default CompletableFuture<GetOutpostResponse> |
getOutpost(GetOutpostRequest getOutpostRequest)
Gets information about the specified Outpost.
|
default CompletableFuture<GetOutpostInstanceTypesResponse> |
getOutpostInstanceTypes(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest)
Lists the instance types for the specified Outpost.
|
default CompletableFuture<GetOutpostInstanceTypesResponse> |
getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest)
Lists the instance types for the specified Outpost.
|
default CompletableFuture<GetSiteResponse> |
getSite(Consumer<GetSiteRequest.Builder> getSiteRequest)
Gets information about the specified Outpost site.
|
default CompletableFuture<GetSiteResponse> |
getSite(GetSiteRequest getSiteRequest)
Gets information about the specified Outpost site.
|
default CompletableFuture<GetSiteAddressResponse> |
getSiteAddress(Consumer<GetSiteAddressRequest.Builder> getSiteAddressRequest)
Gets the site address.
|
default CompletableFuture<GetSiteAddressResponse> |
getSiteAddress(GetSiteAddressRequest getSiteAddressRequest)
Gets the site address.
|
default CompletableFuture<ListCatalogItemsResponse> |
listCatalogItems(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest)
Use to create a list of every item in the catalog.
|
default CompletableFuture<ListCatalogItemsResponse> |
listCatalogItems(ListCatalogItemsRequest listCatalogItemsRequest)
Use to create a list of every item in the catalog.
|
default ListCatalogItemsPublisher |
listCatalogItemsPaginator(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest)
Use to create a list of every item in the catalog.
|
default ListCatalogItemsPublisher |
listCatalogItemsPaginator(ListCatalogItemsRequest listCatalogItemsRequest)
Use to create a list of every item in the catalog.
|
default CompletableFuture<ListOrdersResponse> |
listOrders(Consumer<ListOrdersRequest.Builder> listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account.
|
default CompletableFuture<ListOrdersResponse> |
listOrders(ListOrdersRequest listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account.
|
default ListOrdersPublisher |
listOrdersPaginator(Consumer<ListOrdersRequest.Builder> listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account.
|
default ListOrdersPublisher |
listOrdersPaginator(ListOrdersRequest listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account.
|
default CompletableFuture<ListOutpostsResponse> |
listOutposts(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account.
|
default CompletableFuture<ListOutpostsResponse> |
listOutposts(ListOutpostsRequest listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account.
|
default ListOutpostsPublisher |
listOutpostsPaginator(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account.
|
default ListOutpostsPublisher |
listOutpostsPaginator(ListOutpostsRequest listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account.
|
default CompletableFuture<ListSitesResponse> |
listSites(Consumer<ListSitesRequest.Builder> listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account.
|
default CompletableFuture<ListSitesResponse> |
listSites(ListSitesRequest listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account.
|
default ListSitesPublisher |
listSitesPaginator(Consumer<ListSitesRequest.Builder> listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account.
|
default ListSitesPublisher |
listSitesPaginator(ListSitesRequest listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags for the specified resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to the specified resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified resource.
|
default CompletableFuture<UpdateOutpostResponse> |
updateOutpost(Consumer<UpdateOutpostRequest.Builder> updateOutpostRequest)
Updates an Outpost.
|
default CompletableFuture<UpdateOutpostResponse> |
updateOutpost(UpdateOutpostRequest updateOutpostRequest)
Updates an Outpost.
|
default CompletableFuture<UpdateSiteResponse> |
updateSite(Consumer<UpdateSiteRequest.Builder> updateSiteRequest)
Updates the site.
|
default CompletableFuture<UpdateSiteResponse> |
updateSite(UpdateSiteRequest updateSiteRequest)
Updates the site.
|
default CompletableFuture<UpdateSiteAddressResponse> |
updateSiteAddress(Consumer<UpdateSiteAddressRequest.Builder> updateSiteAddressRequest)
Updates the site address.
|
default CompletableFuture<UpdateSiteAddressResponse> |
updateSiteAddress(UpdateSiteAddressRequest updateSiteAddressRequest)
Updates the site address.
|
default CompletableFuture<UpdateSiteRackPhysicalPropertiesResponse> |
updateSiteRackPhysicalProperties(Consumer<UpdateSiteRackPhysicalPropertiesRequest.Builder> updateSiteRackPhysicalPropertiesRequest)
Update the physical and logistical details for a rack at a site.
|
default CompletableFuture<UpdateSiteRackPhysicalPropertiesResponse> |
updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest updateSiteRackPhysicalPropertiesRequest)
Update the physical and logistical details for a rack at a site.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static OutpostsAsyncClient create()
OutpostsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OutpostsAsyncClientBuilder builder()
OutpostsAsyncClient.default CompletableFuture<CancelOrderResponse> cancelOrder(CancelOrderRequest cancelOrderRequest)
Cancels an order for an Outpost.
cancelOrderRequest - default CompletableFuture<CancelOrderResponse> cancelOrder(Consumer<CancelOrderRequest.Builder> cancelOrderRequest)
Cancels an order for an Outpost.
This is a convenience which creates an instance of the CancelOrderRequest.Builder avoiding the need to
create one manually via CancelOrderRequest.builder()
cancelOrderRequest - A Consumer that will call methods on CancelOrderInput.Builder to create a request.default CompletableFuture<CreateOrderResponse> createOrder(CreateOrderRequest createOrderRequest)
Creates an order for an Outpost.
createOrderRequest - default CompletableFuture<CreateOrderResponse> createOrder(Consumer<CreateOrderRequest.Builder> createOrderRequest)
Creates an order for an Outpost.
This is a convenience which creates an instance of the CreateOrderRequest.Builder avoiding the need to
create one manually via CreateOrderRequest.builder()
createOrderRequest - A Consumer that will call methods on CreateOrderInput.Builder to create a request.default CompletableFuture<CreateOutpostResponse> createOutpost(CreateOutpostRequest createOutpostRequest)
Creates an Outpost.
You can specify AvailabilityZone or AvailabilityZoneId.
createOutpostRequest - default CompletableFuture<CreateOutpostResponse> createOutpost(Consumer<CreateOutpostRequest.Builder> createOutpostRequest)
Creates an Outpost.
You can specify AvailabilityZone or AvailabilityZoneId.
This is a convenience which creates an instance of the CreateOutpostRequest.Builder avoiding the need to
create one manually via CreateOutpostRequest.builder()
createOutpostRequest - A Consumer that will call methods on CreateOutpostInput.Builder to create a request.default CompletableFuture<CreateSiteResponse> createSite(CreateSiteRequest createSiteRequest)
Creates a site for an Outpost.
createSiteRequest - default CompletableFuture<CreateSiteResponse> createSite(Consumer<CreateSiteRequest.Builder> createSiteRequest)
Creates a site for an Outpost.
This is a convenience which creates an instance of the CreateSiteRequest.Builder avoiding the need to
create one manually via CreateSiteRequest.builder()
createSiteRequest - A Consumer that will call methods on CreateSiteInput.Builder to create a request.default CompletableFuture<DeleteOutpostResponse> deleteOutpost(DeleteOutpostRequest deleteOutpostRequest)
Deletes the Outpost.
deleteOutpostRequest - default CompletableFuture<DeleteOutpostResponse> deleteOutpost(Consumer<DeleteOutpostRequest.Builder> deleteOutpostRequest)
Deletes the Outpost.
This is a convenience which creates an instance of the DeleteOutpostRequest.Builder avoiding the need to
create one manually via DeleteOutpostRequest.builder()
deleteOutpostRequest - A Consumer that will call methods on DeleteOutpostInput.Builder to create a request.default CompletableFuture<DeleteSiteResponse> deleteSite(DeleteSiteRequest deleteSiteRequest)
Deletes the site.
deleteSiteRequest - default CompletableFuture<DeleteSiteResponse> deleteSite(Consumer<DeleteSiteRequest.Builder> deleteSiteRequest)
Deletes the site.
This is a convenience which creates an instance of the DeleteSiteRequest.Builder avoiding the need to
create one manually via DeleteSiteRequest.builder()
deleteSiteRequest - A Consumer that will call methods on DeleteSiteInput.Builder to create a request.default CompletableFuture<GetCatalogItemResponse> getCatalogItem(GetCatalogItemRequest getCatalogItemRequest)
Gets information about a catalog item.
getCatalogItemRequest - default CompletableFuture<GetCatalogItemResponse> getCatalogItem(Consumer<GetCatalogItemRequest.Builder> getCatalogItemRequest)
Gets information about a catalog item.
This is a convenience which creates an instance of the GetCatalogItemRequest.Builder avoiding the need to
create one manually via GetCatalogItemRequest.builder()
getCatalogItemRequest - A Consumer that will call methods on GetCatalogItemInput.Builder to create a request.default CompletableFuture<GetOrderResponse> getOrder(GetOrderRequest getOrderRequest)
Gets an order.
getOrderRequest - default CompletableFuture<GetOrderResponse> getOrder(Consumer<GetOrderRequest.Builder> getOrderRequest)
Gets an order.
This is a convenience which creates an instance of the GetOrderRequest.Builder avoiding the need to
create one manually via GetOrderRequest.builder()
getOrderRequest - A Consumer that will call methods on GetOrderInput.Builder to create a request.default CompletableFuture<GetOutpostResponse> getOutpost(GetOutpostRequest getOutpostRequest)
Gets information about the specified Outpost.
getOutpostRequest - default CompletableFuture<GetOutpostResponse> getOutpost(Consumer<GetOutpostRequest.Builder> getOutpostRequest)
Gets information about the specified Outpost.
This is a convenience which creates an instance of the GetOutpostRequest.Builder avoiding the need to
create one manually via GetOutpostRequest.builder()
getOutpostRequest - A Consumer that will call methods on GetOutpostInput.Builder to create a request.default CompletableFuture<GetOutpostInstanceTypesResponse> getOutpostInstanceTypes(GetOutpostInstanceTypesRequest getOutpostInstanceTypesRequest)
Lists the instance types for the specified Outpost.
getOutpostInstanceTypesRequest - default CompletableFuture<GetOutpostInstanceTypesResponse> getOutpostInstanceTypes(Consumer<GetOutpostInstanceTypesRequest.Builder> getOutpostInstanceTypesRequest)
Lists the instance types for the specified Outpost.
This is a convenience which creates an instance of the GetOutpostInstanceTypesRequest.Builder avoiding
the need to create one manually via GetOutpostInstanceTypesRequest.builder()
getOutpostInstanceTypesRequest - A Consumer that will call methods on GetOutpostInstanceTypesInput.Builder to create a
request.default CompletableFuture<GetSiteResponse> getSite(GetSiteRequest getSiteRequest)
Gets information about the specified Outpost site.
getSiteRequest - default CompletableFuture<GetSiteResponse> getSite(Consumer<GetSiteRequest.Builder> getSiteRequest)
Gets information about the specified Outpost site.
This is a convenience which creates an instance of the GetSiteRequest.Builder avoiding the need to create
one manually via GetSiteRequest.builder()
getSiteRequest - A Consumer that will call methods on GetSiteInput.Builder to create a request.default CompletableFuture<GetSiteAddressResponse> getSiteAddress(GetSiteAddressRequest getSiteAddressRequest)
Gets the site address.
getSiteAddressRequest - default CompletableFuture<GetSiteAddressResponse> getSiteAddress(Consumer<GetSiteAddressRequest.Builder> getSiteAddressRequest)
Gets the site address.
This is a convenience which creates an instance of the GetSiteAddressRequest.Builder avoiding the need to
create one manually via GetSiteAddressRequest.builder()
getSiteAddressRequest - A Consumer that will call methods on GetSiteAddressInput.Builder to create a request.default CompletableFuture<ListCatalogItemsResponse> listCatalogItems(ListCatalogItemsRequest listCatalogItemsRequest)
Use to create a list of every item in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
listCatalogItemsRequest - default CompletableFuture<ListCatalogItemsResponse> listCatalogItems(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest)
Use to create a list of every item in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a convenience which creates an instance of the ListCatalogItemsRequest.Builder avoiding the need
to create one manually via ListCatalogItemsRequest.builder()
listCatalogItemsRequest - A Consumer that will call methods on ListCatalogItemsInput.Builder to create a request.default ListCatalogItemsPublisher listCatalogItemsPaginator(ListCatalogItemsRequest listCatalogItemsRequest)
Use to create a list of every item in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest) 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.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse 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
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest) operation.
listCatalogItemsRequest - default ListCatalogItemsPublisher listCatalogItemsPaginator(Consumer<ListCatalogItemsRequest.Builder> listCatalogItemsRequest)
Use to create a list of every item in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest) 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.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListCatalogItemsPublisher publisher = client.listCatalogItemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListCatalogItemsResponse 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
listCatalogItems(software.amazon.awssdk.services.outposts.model.ListCatalogItemsRequest) operation.
This is a convenience which creates an instance of the ListCatalogItemsRequest.Builder avoiding the need
to create one manually via ListCatalogItemsRequest.builder()
listCatalogItemsRequest - A Consumer that will call methods on ListCatalogItemsInput.Builder to create a request.default CompletableFuture<ListOrdersResponse> listOrders(ListOrdersRequest listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.
listOrdersRequest - default CompletableFuture<ListOrdersResponse> listOrders(Consumer<ListOrdersRequest.Builder> listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.
This is a convenience which creates an instance of the ListOrdersRequest.Builder avoiding the need to
create one manually via ListOrdersRequest.builder()
listOrdersRequest - A Consumer that will call methods on ListOrdersInput.Builder to create a request.default ListOrdersPublisher listOrdersPaginator(ListOrdersRequest listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.
This is a variant of listOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest)
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.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOrdersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListOrdersResponse 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
listOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest) operation.
listOrdersRequest - default ListOrdersPublisher listOrdersPaginator(Consumer<ListOrdersRequest.Builder> listOrdersRequest)
Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.
This is a variant of listOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest)
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.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOrdersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListOrdersResponse 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
listOrders(software.amazon.awssdk.services.outposts.model.ListOrdersRequest) operation.
This is a convenience which creates an instance of the ListOrdersRequest.Builder avoiding the need to
create one manually via ListOrdersRequest.builder()
listOrdersRequest - A Consumer that will call methods on ListOrdersInput.Builder to create a request.default CompletableFuture<ListOutpostsResponse> listOutposts(ListOutpostsRequest listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return a more
specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (
us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
listOutpostsRequest - default CompletableFuture<ListOutpostsResponse> listOutposts(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return a more
specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (
us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a convenience which creates an instance of the ListOutpostsRequest.Builder avoiding the need to
create one manually via ListOutpostsRequest.builder()
listOutpostsRequest - A Consumer that will call methods on ListOutpostsInput.Builder to create a request.default ListOutpostsPublisher listOutpostsPaginator(ListOutpostsRequest listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return a more
specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (
us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
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.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOutpostsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListOutpostsResponse 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
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation.
listOutpostsRequest - default ListOutpostsPublisher listOutpostsPaginator(Consumer<ListOutpostsRequest.Builder> listOutpostsRequest)
Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return a more
specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (
us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest)
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.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListOutpostsPublisher publisher = client.listOutpostsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListOutpostsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListOutpostsResponse 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
listOutposts(software.amazon.awssdk.services.outposts.model.ListOutpostsRequest) operation.
This is a convenience which creates an instance of the ListOutpostsRequest.Builder avoiding the need to
create one manually via ListOutpostsRequest.builder()
listOutpostsRequest - A Consumer that will call methods on ListOutpostsInput.Builder to create a request.default CompletableFuture<ListSitesResponse> listSites(ListSitesRequest listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
listSitesRequest - default CompletableFuture<ListSitesResponse> listSites(Consumer<ListSitesRequest.Builder> listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a convenience which creates an instance of the ListSitesRequest.Builder avoiding the need to
create one manually via ListSitesRequest.builder()
listSitesRequest - A Consumer that will call methods on ListSitesInput.Builder to create a request.default ListSitesPublisher listSitesPaginator(ListSitesRequest listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
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.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListSitesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListSitesResponse 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
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation.
listSitesRequest - default ListSitesPublisher listSitesPaginator(Consumer<ListSitesRequest.Builder> listSitesRequest)
Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.
If you specify multiple filters, the filters are joined with an AND, and the request returns only
results that match all of the specified filters.
This is a variant of listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest)
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.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.outposts.paginators.ListSitesPublisher publisher = client.listSitesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.outposts.model.ListSitesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.outposts.model.ListSitesResponse 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
listSites(software.amazon.awssdk.services.outposts.model.ListSitesRequest) operation.
This is a convenience which creates an instance of the ListSitesRequest.Builder avoiding the need to
create one manually via ListSitesRequest.builder()
listSitesRequest - A Consumer that will call methods on ListSitesInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for the specified resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags for the specified resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds tags to the specified resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to the specified resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateOutpostResponse> updateOutpost(UpdateOutpostRequest updateOutpostRequest)
Updates an Outpost.
updateOutpostRequest - default CompletableFuture<UpdateOutpostResponse> updateOutpost(Consumer<UpdateOutpostRequest.Builder> updateOutpostRequest)
Updates an Outpost.
This is a convenience which creates an instance of the UpdateOutpostRequest.Builder avoiding the need to
create one manually via UpdateOutpostRequest.builder()
updateOutpostRequest - A Consumer that will call methods on UpdateOutpostInput.Builder to create a request.default CompletableFuture<UpdateSiteResponse> updateSite(UpdateSiteRequest updateSiteRequest)
Updates the site.
updateSiteRequest - default CompletableFuture<UpdateSiteResponse> updateSite(Consumer<UpdateSiteRequest.Builder> updateSiteRequest)
Updates the site.
This is a convenience which creates an instance of the UpdateSiteRequest.Builder avoiding the need to
create one manually via UpdateSiteRequest.builder()
updateSiteRequest - A Consumer that will call methods on UpdateSiteInput.Builder to create a request.default CompletableFuture<UpdateSiteAddressResponse> updateSiteAddress(UpdateSiteAddressRequest updateSiteAddressRequest)
Updates the site address.
To update a site address with an order IN_PROGRESS, you must wait for the order to complete or
cancel the order.
You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
updateSiteAddressRequest - default CompletableFuture<UpdateSiteAddressResponse> updateSiteAddress(Consumer<UpdateSiteAddressRequest.Builder> updateSiteAddressRequest)
Updates the site address.
To update a site address with an order IN_PROGRESS, you must wait for the order to complete or
cancel the order.
You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
This is a convenience which creates an instance of the UpdateSiteAddressRequest.Builder avoiding the need
to create one manually via UpdateSiteAddressRequest.builder()
updateSiteAddressRequest - A Consumer that will call methods on UpdateSiteAddressInput.Builder to create a request.default CompletableFuture<UpdateSiteRackPhysicalPropertiesResponse> updateSiteRackPhysicalProperties(UpdateSiteRackPhysicalPropertiesRequest updateSiteRackPhysicalPropertiesRequest)
Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or
cancel the order.
updateSiteRackPhysicalPropertiesRequest - default CompletableFuture<UpdateSiteRackPhysicalPropertiesResponse> updateSiteRackPhysicalProperties(Consumer<UpdateSiteRackPhysicalPropertiesRequest.Builder> updateSiteRackPhysicalPropertiesRequest)
Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or
cancel the order.
This is a convenience which creates an instance of the UpdateSiteRackPhysicalPropertiesRequest.Builder
avoiding the need to create one manually via UpdateSiteRackPhysicalPropertiesRequest.builder()
updateSiteRackPhysicalPropertiesRequest - A Consumer that will call methods on UpdateSiteRackPhysicalPropertiesInput.Builder to
create a request.Copyright © 2022. All rights reserved.