Interface PrivateNetworksAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacknowledgeOrderReceipt
(Consumer<AcknowledgeOrderReceiptRequest.Builder> acknowledgeOrderReceiptRequest) Acknowledges that the specified network order was received.acknowledgeOrderReceipt
(AcknowledgeOrderReceiptRequest acknowledgeOrderReceiptRequest) Acknowledges that the specified network order was received.activateDeviceIdentifier
(Consumer<ActivateDeviceIdentifierRequest.Builder> activateDeviceIdentifierRequest) Activates the specified device identifier.activateDeviceIdentifier
(ActivateDeviceIdentifierRequest activateDeviceIdentifierRequest) Activates the specified device identifier.activateNetworkSite
(Consumer<ActivateNetworkSiteRequest.Builder> activateNetworkSiteRequest) Activates the specified network site.activateNetworkSite
(ActivateNetworkSiteRequest activateNetworkSiteRequest) Activates the specified network site.builder()
Create a builder that can be used to configure and create aPrivateNetworksAsyncClient
.configureAccessPoint
(Consumer<ConfigureAccessPointRequest.Builder> configureAccessPointRequest) Configures the specified network resource.configureAccessPoint
(ConfigureAccessPointRequest configureAccessPointRequest) Configures the specified network resource.static PrivateNetworksAsyncClient
create()
Create aPrivateNetworksAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateNetworkResponse> createNetwork
(Consumer<CreateNetworkRequest.Builder> createNetworkRequest) Creates a network.default CompletableFuture
<CreateNetworkResponse> createNetwork
(CreateNetworkRequest createNetworkRequest) Creates a network.createNetworkSite
(Consumer<CreateNetworkSiteRequest.Builder> createNetworkSiteRequest) Creates a network site.createNetworkSite
(CreateNetworkSiteRequest createNetworkSiteRequest) Creates a network site.deactivateDeviceIdentifier
(Consumer<DeactivateDeviceIdentifierRequest.Builder> deactivateDeviceIdentifierRequest) Deactivates the specified device identifier.deactivateDeviceIdentifier
(DeactivateDeviceIdentifierRequest deactivateDeviceIdentifierRequest) Deactivates the specified device identifier.default CompletableFuture
<DeleteNetworkResponse> deleteNetwork
(Consumer<DeleteNetworkRequest.Builder> deleteNetworkRequest) Deletes the specified network.default CompletableFuture
<DeleteNetworkResponse> deleteNetwork
(DeleteNetworkRequest deleteNetworkRequest) Deletes the specified network.deleteNetworkSite
(Consumer<DeleteNetworkSiteRequest.Builder> deleteNetworkSiteRequest) Deletes the specified network site.deleteNetworkSite
(DeleteNetworkSiteRequest deleteNetworkSiteRequest) Deletes the specified network site.getDeviceIdentifier
(Consumer<GetDeviceIdentifierRequest.Builder> getDeviceIdentifierRequest) Gets the specified device identifier.getDeviceIdentifier
(GetDeviceIdentifierRequest getDeviceIdentifierRequest) Gets the specified device identifier.default CompletableFuture
<GetNetworkResponse> getNetwork
(Consumer<GetNetworkRequest.Builder> getNetworkRequest) Gets the specified network.default CompletableFuture
<GetNetworkResponse> getNetwork
(GetNetworkRequest getNetworkRequest) Gets the specified network.getNetworkResource
(Consumer<GetNetworkResourceRequest.Builder> getNetworkResourceRequest) Gets the specified network resource.getNetworkResource
(GetNetworkResourceRequest getNetworkResourceRequest) Gets the specified network resource.default CompletableFuture
<GetNetworkSiteResponse> getNetworkSite
(Consumer<GetNetworkSiteRequest.Builder> getNetworkSiteRequest) Gets the specified network site.default CompletableFuture
<GetNetworkSiteResponse> getNetworkSite
(GetNetworkSiteRequest getNetworkSiteRequest) Gets the specified network site.default CompletableFuture
<GetOrderResponse> getOrder
(Consumer<GetOrderRequest.Builder> getOrderRequest) Gets the specified order.default CompletableFuture
<GetOrderResponse> getOrder
(GetOrderRequest getOrderRequest) Gets the specified order.listDeviceIdentifiers
(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest) Lists device identifiers.listDeviceIdentifiers
(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest) Lists device identifiers.default ListDeviceIdentifiersPublisher
listDeviceIdentifiersPaginator
(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest) This is a variant oflistDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest)
operation.default ListDeviceIdentifiersPublisher
listDeviceIdentifiersPaginator
(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest) This is a variant oflistDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest)
operation.listNetworkResources
(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest) Lists network resources.listNetworkResources
(ListNetworkResourcesRequest listNetworkResourcesRequest) Lists network resources.default ListNetworkResourcesPublisher
listNetworkResourcesPaginator
(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest) This is a variant oflistNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest)
operation.default ListNetworkResourcesPublisher
listNetworkResourcesPaginator
(ListNetworkResourcesRequest listNetworkResourcesRequest) This is a variant oflistNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest)
operation.default CompletableFuture
<ListNetworksResponse> listNetworks
(Consumer<ListNetworksRequest.Builder> listNetworksRequest) Lists networks.default CompletableFuture
<ListNetworksResponse> listNetworks
(ListNetworksRequest listNetworksRequest) Lists networks.listNetworkSites
(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest) Lists network sites.listNetworkSites
(ListNetworkSitesRequest listNetworkSitesRequest) Lists network sites.default ListNetworkSitesPublisher
listNetworkSitesPaginator
(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest) This is a variant oflistNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest)
operation.default ListNetworkSitesPublisher
listNetworkSitesPaginator
(ListNetworkSitesRequest listNetworkSitesRequest) This is a variant oflistNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest)
operation.default ListNetworksPublisher
listNetworksPaginator
(Consumer<ListNetworksRequest.Builder> listNetworksRequest) This is a variant oflistNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest)
operation.default ListNetworksPublisher
listNetworksPaginator
(ListNetworksRequest listNetworksRequest) This is a variant oflistNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest)
operation.default CompletableFuture
<ListOrdersResponse> listOrders
(Consumer<ListOrdersRequest.Builder> listOrdersRequest) Lists orders.default CompletableFuture
<ListOrdersResponse> listOrders
(ListOrdersRequest listOrdersRequest) Lists orders.default ListOrdersPublisher
listOrdersPaginator
(Consumer<ListOrdersRequest.Builder> listOrdersRequest) This is a variant oflistOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest)
operation.default ListOrdersPublisher
listOrdersPaginator
(ListOrdersRequest listOrdersRequest) This is a variant oflistOrders(software.amazon.awssdk.services.privatenetworks.model.ListOrdersRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.default CompletableFuture
<PingResponse> ping
(Consumer<PingRequest.Builder> pingRequest) Checks the health of the service.default CompletableFuture
<PingResponse> ping
(PingRequest pingRequest) Checks the health of the service.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartNetworkResourceUpdate
(Consumer<StartNetworkResourceUpdateRequest.Builder> startNetworkResourceUpdateRequest) Use this action to do the following tasks:startNetworkResourceUpdate
(StartNetworkResourceUpdateRequest startNetworkResourceUpdateRequest) Use this action to do the following tasks: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.updateNetworkSite
(Consumer<UpdateNetworkSiteRequest.Builder> updateNetworkSiteRequest) Updates the specified network site.updateNetworkSite
(UpdateNetworkSiteRequest updateNetworkSiteRequest) Updates the specified network site.updateNetworkSitePlan
(Consumer<UpdateNetworkSitePlanRequest.Builder> updateNetworkSitePlanRequest) Updates the specified network site plan.updateNetworkSitePlan
(UpdateNetworkSitePlanRequest updateNetworkSitePlanRequest) Updates the specified network site plan.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acknowledgeOrderReceipt
default CompletableFuture<AcknowledgeOrderReceiptResponse> acknowledgeOrderReceipt(AcknowledgeOrderReceiptRequest acknowledgeOrderReceiptRequest) Acknowledges that the specified network order was received.
- Parameters:
acknowledgeOrderReceiptRequest
-- Returns:
- A Java Future containing the result of the AcknowledgeOrderReceipt operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acknowledgeOrderReceipt
default CompletableFuture<AcknowledgeOrderReceiptResponse> acknowledgeOrderReceipt(Consumer<AcknowledgeOrderReceiptRequest.Builder> acknowledgeOrderReceiptRequest) Acknowledges that the specified network order was received.
This is a convenience which creates an instance of the
AcknowledgeOrderReceiptRequest.Builder
avoiding the need to create one manually viaAcknowledgeOrderReceiptRequest.builder()
- Parameters:
acknowledgeOrderReceiptRequest
- AConsumer
that will call methods onAcknowledgeOrderReceiptRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AcknowledgeOrderReceipt operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
activateDeviceIdentifier
default CompletableFuture<ActivateDeviceIdentifierResponse> activateDeviceIdentifier(ActivateDeviceIdentifierRequest activateDeviceIdentifierRequest) Activates the specified device identifier.
- Parameters:
activateDeviceIdentifierRequest
-- Returns:
- A Java Future containing the result of the ActivateDeviceIdentifier operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
activateDeviceIdentifier
default CompletableFuture<ActivateDeviceIdentifierResponse> activateDeviceIdentifier(Consumer<ActivateDeviceIdentifierRequest.Builder> activateDeviceIdentifierRequest) Activates the specified device identifier.
This is a convenience which creates an instance of the
ActivateDeviceIdentifierRequest.Builder
avoiding the need to create one manually viaActivateDeviceIdentifierRequest.builder()
- Parameters:
activateDeviceIdentifierRequest
- AConsumer
that will call methods onActivateDeviceIdentifierRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ActivateDeviceIdentifier operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
activateNetworkSite
default CompletableFuture<ActivateNetworkSiteResponse> activateNetworkSite(ActivateNetworkSiteRequest activateNetworkSiteRequest) Activates the specified network site.
- Parameters:
activateNetworkSiteRequest
-- Returns:
- A Java Future containing the result of the ActivateNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
activateNetworkSite
default CompletableFuture<ActivateNetworkSiteResponse> activateNetworkSite(Consumer<ActivateNetworkSiteRequest.Builder> activateNetworkSiteRequest) Activates the specified network site.
This is a convenience which creates an instance of the
ActivateNetworkSiteRequest.Builder
avoiding the need to create one manually viaActivateNetworkSiteRequest.builder()
- Parameters:
activateNetworkSiteRequest
- AConsumer
that will call methods onActivateNetworkSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ActivateNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
configureAccessPoint
default CompletableFuture<ConfigureAccessPointResponse> configureAccessPoint(ConfigureAccessPointRequest configureAccessPointRequest) Configures the specified network resource.
Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide.
- Parameters:
configureAccessPointRequest
-- Returns:
- A Java Future containing the result of the ConfigureAccessPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
configureAccessPoint
default CompletableFuture<ConfigureAccessPointResponse> configureAccessPoint(Consumer<ConfigureAccessPointRequest.Builder> configureAccessPointRequest) Configures the specified network resource.
Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide.
This is a convenience which creates an instance of the
ConfigureAccessPointRequest.Builder
avoiding the need to create one manually viaConfigureAccessPointRequest.builder()
- Parameters:
configureAccessPointRequest
- AConsumer
that will call methods onConfigureAccessPointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ConfigureAccessPoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNetwork
default CompletableFuture<CreateNetworkResponse> createNetwork(CreateNetworkRequest createNetworkRequest) Creates a network.
- Parameters:
createNetworkRequest
-- Returns:
- A Java Future containing the result of the CreateNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The limit was exceeded.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNetwork
default CompletableFuture<CreateNetworkResponse> createNetwork(Consumer<CreateNetworkRequest.Builder> createNetworkRequest) Creates a network.
This is a convenience which creates an instance of the
CreateNetworkRequest.Builder
avoiding the need to create one manually viaCreateNetworkRequest.builder()
- Parameters:
createNetworkRequest
- AConsumer
that will call methods onCreateNetworkRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException The limit was exceeded.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNetworkSite
default CompletableFuture<CreateNetworkSiteResponse> createNetworkSite(CreateNetworkSiteRequest createNetworkSiteRequest) Creates a network site.
- Parameters:
createNetworkSiteRequest
-- Returns:
- A Java Future containing the result of the CreateNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNetworkSite
default CompletableFuture<CreateNetworkSiteResponse> createNetworkSite(Consumer<CreateNetworkSiteRequest.Builder> createNetworkSiteRequest) Creates a network site.
This is a convenience which creates an instance of the
CreateNetworkSiteRequest.Builder
avoiding the need to create one manually viaCreateNetworkSiteRequest.builder()
- Parameters:
createNetworkSiteRequest
- AConsumer
that will call methods onCreateNetworkSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deactivateDeviceIdentifier
default CompletableFuture<DeactivateDeviceIdentifierResponse> deactivateDeviceIdentifier(DeactivateDeviceIdentifierRequest deactivateDeviceIdentifierRequest) Deactivates the specified device identifier.
- Parameters:
deactivateDeviceIdentifierRequest
-- Returns:
- A Java Future containing the result of the DeactivateDeviceIdentifier operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deactivateDeviceIdentifier
default CompletableFuture<DeactivateDeviceIdentifierResponse> deactivateDeviceIdentifier(Consumer<DeactivateDeviceIdentifierRequest.Builder> deactivateDeviceIdentifierRequest) Deactivates the specified device identifier.
This is a convenience which creates an instance of the
DeactivateDeviceIdentifierRequest.Builder
avoiding the need to create one manually viaDeactivateDeviceIdentifierRequest.builder()
- Parameters:
deactivateDeviceIdentifierRequest
- AConsumer
that will call methods onDeactivateDeviceIdentifierRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeactivateDeviceIdentifier operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNetwork
default CompletableFuture<DeleteNetworkResponse> deleteNetwork(DeleteNetworkRequest deleteNetworkRequest) Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.
- Parameters:
deleteNetworkRequest
-- Returns:
- A Java Future containing the result of the DeleteNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNetwork
default CompletableFuture<DeleteNetworkResponse> deleteNetwork(Consumer<DeleteNetworkRequest.Builder> deleteNetworkRequest) Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.
This is a convenience which creates an instance of the
DeleteNetworkRequest.Builder
avoiding the need to create one manually viaDeleteNetworkRequest.builder()
- Parameters:
deleteNetworkRequest
- AConsumer
that will call methods onDeleteNetworkRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNetworkSite
default CompletableFuture<DeleteNetworkSiteResponse> deleteNetworkSite(DeleteNetworkSiteRequest deleteNetworkSiteRequest) Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide.
- Parameters:
deleteNetworkSiteRequest
-- Returns:
- A Java Future containing the result of the DeleteNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNetworkSite
default CompletableFuture<DeleteNetworkSiteResponse> deleteNetworkSite(Consumer<DeleteNetworkSiteRequest.Builder> deleteNetworkSiteRequest) Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide.
This is a convenience which creates an instance of the
DeleteNetworkSiteRequest.Builder
avoiding the need to create one manually viaDeleteNetworkSiteRequest.builder()
- Parameters:
deleteNetworkSiteRequest
- AConsumer
that will call methods onDeleteNetworkSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeviceIdentifier
default CompletableFuture<GetDeviceIdentifierResponse> getDeviceIdentifier(GetDeviceIdentifierRequest getDeviceIdentifierRequest) Gets the specified device identifier.
- Parameters:
getDeviceIdentifierRequest
-- Returns:
- A Java Future containing the result of the GetDeviceIdentifier operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeviceIdentifier
default CompletableFuture<GetDeviceIdentifierResponse> getDeviceIdentifier(Consumer<GetDeviceIdentifierRequest.Builder> getDeviceIdentifierRequest) Gets the specified device identifier.
This is a convenience which creates an instance of the
GetDeviceIdentifierRequest.Builder
avoiding the need to create one manually viaGetDeviceIdentifierRequest.builder()
- Parameters:
getDeviceIdentifierRequest
- AConsumer
that will call methods onGetDeviceIdentifierRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDeviceIdentifier operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNetwork
Gets the specified network.
- Parameters:
getNetworkRequest
-- Returns:
- A Java Future containing the result of the GetNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNetwork
default CompletableFuture<GetNetworkResponse> getNetwork(Consumer<GetNetworkRequest.Builder> getNetworkRequest) Gets the specified network.
This is a convenience which creates an instance of the
GetNetworkRequest.Builder
avoiding the need to create one manually viaGetNetworkRequest.builder()
- Parameters:
getNetworkRequest
- AConsumer
that will call methods onGetNetworkRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNetworkResource
default CompletableFuture<GetNetworkResourceResponse> getNetworkResource(GetNetworkResourceRequest getNetworkResourceRequest) Gets the specified network resource.
- Parameters:
getNetworkResourceRequest
-- Returns:
- A Java Future containing the result of the GetNetworkResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNetworkResource
default CompletableFuture<GetNetworkResourceResponse> getNetworkResource(Consumer<GetNetworkResourceRequest.Builder> getNetworkResourceRequest) Gets the specified network resource.
This is a convenience which creates an instance of the
GetNetworkResourceRequest.Builder
avoiding the need to create one manually viaGetNetworkResourceRequest.builder()
- Parameters:
getNetworkResourceRequest
- AConsumer
that will call methods onGetNetworkResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetNetworkResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNetworkSite
default CompletableFuture<GetNetworkSiteResponse> getNetworkSite(GetNetworkSiteRequest getNetworkSiteRequest) Gets the specified network site.
- Parameters:
getNetworkSiteRequest
-- Returns:
- A Java Future containing the result of the GetNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNetworkSite
default CompletableFuture<GetNetworkSiteResponse> getNetworkSite(Consumer<GetNetworkSiteRequest.Builder> getNetworkSiteRequest) Gets the specified network site.
This is a convenience which creates an instance of the
GetNetworkSiteRequest.Builder
avoiding the need to create one manually viaGetNetworkSiteRequest.builder()
- Parameters:
getNetworkSiteRequest
- AConsumer
that will call methods onGetNetworkSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrder
Gets the specified order.
- Parameters:
getOrderRequest
-- Returns:
- A Java Future containing the result of the GetOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrder
default CompletableFuture<GetOrderResponse> getOrder(Consumer<GetOrderRequest.Builder> getOrderRequest) Gets the specified order.
This is a convenience which creates an instance of the
GetOrderRequest.Builder
avoiding the need to create one manually viaGetOrderRequest.builder()
- Parameters:
getOrderRequest
- AConsumer
that will call methods onGetOrderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOrder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeviceIdentifiers
default CompletableFuture<ListDeviceIdentifiersResponse> listDeviceIdentifiers(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest) Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
- Parameters:
listDeviceIdentifiersRequest
-- Returns:
- A Java Future containing the result of the ListDeviceIdentifiers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeviceIdentifiers
default CompletableFuture<ListDeviceIdentifiersResponse> listDeviceIdentifiers(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest) Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
This is a convenience which creates an instance of the
ListDeviceIdentifiersRequest.Builder
avoiding the need to create one manually viaListDeviceIdentifiersRequest.builder()
- Parameters:
listDeviceIdentifiersRequest
- AConsumer
that will call methods onListDeviceIdentifiersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDeviceIdentifiers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeviceIdentifiersPaginator
default ListDeviceIdentifiersPublisher listDeviceIdentifiersPaginator(ListDeviceIdentifiersRequest listDeviceIdentifiersRequest) This is a variant of
listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersPublisher publisher = client.listDeviceIdentifiersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersPublisher publisher = client.listDeviceIdentifiersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersResponse response) { //... }; });
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
listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest)
operation.- Parameters:
listDeviceIdentifiersRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeviceIdentifiersPaginator
default ListDeviceIdentifiersPublisher listDeviceIdentifiersPaginator(Consumer<ListDeviceIdentifiersRequest.Builder> listDeviceIdentifiersRequest) This is a variant of
listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersPublisher publisher = client.listDeviceIdentifiersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListDeviceIdentifiersPublisher publisher = client.listDeviceIdentifiersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersResponse response) { //... }; });
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
listDeviceIdentifiers(software.amazon.awssdk.services.privatenetworks.model.ListDeviceIdentifiersRequest)
operation.
This is a convenience which creates an instance of the
ListDeviceIdentifiersRequest.Builder
avoiding the need to create one manually viaListDeviceIdentifiersRequest.builder()
- Parameters:
listDeviceIdentifiersRequest
- AConsumer
that will call methods onListDeviceIdentifiersRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkResources
default CompletableFuture<ListNetworkResourcesResponse> listNetworkResources(ListNetworkResourcesRequest listNetworkResourcesRequest) Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
- Parameters:
listNetworkResourcesRequest
-- Returns:
- A Java Future containing the result of the ListNetworkResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkResources
default CompletableFuture<ListNetworkResourcesResponse> listNetworkResources(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest) Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
This is a convenience which creates an instance of the
ListNetworkResourcesRequest.Builder
avoiding the need to create one manually viaListNetworkResourcesRequest.builder()
- Parameters:
listNetworkResourcesRequest
- AConsumer
that will call methods onListNetworkResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNetworkResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkResourcesPaginator
default ListNetworkResourcesPublisher listNetworkResourcesPaginator(ListNetworkResourcesRequest listNetworkResourcesRequest) This is a variant of
listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesPublisher publisher = client.listNetworkResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesPublisher publisher = client.listNetworkResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesResponse response) { //... }; });
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
listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest)
operation.- Parameters:
listNetworkResourcesRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkResourcesPaginator
default ListNetworkResourcesPublisher listNetworkResourcesPaginator(Consumer<ListNetworkResourcesRequest.Builder> listNetworkResourcesRequest) This is a variant of
listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesPublisher publisher = client.listNetworkResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkResourcesPublisher publisher = client.listNetworkResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesResponse response) { //... }; });
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
listNetworkResources(software.amazon.awssdk.services.privatenetworks.model.ListNetworkResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListNetworkResourcesRequest.Builder
avoiding the need to create one manually viaListNetworkResourcesRequest.builder()
- Parameters:
listNetworkResourcesRequest
- AConsumer
that will call methods onListNetworkResourcesRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkSites
default CompletableFuture<ListNetworkSitesResponse> listNetworkSites(ListNetworkSitesRequest listNetworkSitesRequest) Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.
- Parameters:
listNetworkSitesRequest
-- Returns:
- A Java Future containing the result of the ListNetworkSites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkSites
default CompletableFuture<ListNetworkSitesResponse> listNetworkSites(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest) Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.
This is a convenience which creates an instance of the
ListNetworkSitesRequest.Builder
avoiding the need to create one manually viaListNetworkSitesRequest.builder()
- Parameters:
listNetworkSitesRequest
- AConsumer
that will call methods onListNetworkSitesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNetworkSites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkSitesPaginator
default ListNetworkSitesPublisher listNetworkSitesPaginator(ListNetworkSitesRequest listNetworkSitesRequest) This is a variant of
listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesPublisher publisher = client.listNetworkSitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesPublisher publisher = client.listNetworkSitesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesResponse response) { //... }; });
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
listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest)
operation.- Parameters:
listNetworkSitesRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworkSitesPaginator
default ListNetworkSitesPublisher listNetworkSitesPaginator(Consumer<ListNetworkSitesRequest.Builder> listNetworkSitesRequest) This is a variant of
listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesPublisher publisher = client.listNetworkSitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListNetworkSitesPublisher publisher = client.listNetworkSitesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesResponse response) { //... }; });
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
listNetworkSites(software.amazon.awssdk.services.privatenetworks.model.ListNetworkSitesRequest)
operation.
This is a convenience which creates an instance of the
ListNetworkSitesRequest.Builder
avoiding the need to create one manually viaListNetworkSitesRequest.builder()
- Parameters:
listNetworkSitesRequest
- AConsumer
that will call methods onListNetworkSitesRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworks
default CompletableFuture<ListNetworksResponse> listNetworks(ListNetworksRequest listNetworksRequest) Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
- Parameters:
listNetworksRequest
-- Returns:
- A Java Future containing the result of the ListNetworks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworks
default CompletableFuture<ListNetworksResponse> listNetworks(Consumer<ListNetworksRequest.Builder> listNetworksRequest) Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
This is a convenience which creates an instance of the
ListNetworksRequest.Builder
avoiding the need to create one manually viaListNetworksRequest.builder()
- Parameters:
listNetworksRequest
- AConsumer
that will call methods onListNetworksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNetworks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworksPaginator
This is a variant of
listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListNetworksPublisher publisher = client.listNetworksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksPublisher publisher = client.listNetworksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListNetworksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListNetworksResponse response) { //... }; });
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
listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest)
operation.- Parameters:
listNetworksRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNetworksPaginator
default ListNetworksPublisher listNetworksPaginator(Consumer<ListNetworksRequest.Builder> listNetworksRequest) This is a variant of
listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListNetworksPublisher publisher = client.listNetworksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListNetworksPublisher publisher = client.listNetworksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListNetworksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListNetworksResponse response) { //... }; });
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
listNetworks(software.amazon.awssdk.services.privatenetworks.model.ListNetworksRequest)
operation.
This is a convenience which creates an instance of the
ListNetworksRequest.Builder
avoiding the need to create one manually viaListNetworksRequest.builder()
- Parameters:
listNetworksRequest
- AConsumer
that will call methods onListNetworksRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrders
Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
- Parameters:
listOrdersRequest
-- Returns:
- A Java Future containing the result of the ListOrders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrders
default CompletableFuture<ListOrdersResponse> listOrders(Consumer<ListOrdersRequest.Builder> listOrdersRequest) Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
This is a convenience which creates an instance of the
ListOrdersRequest.Builder
avoiding the need to create one manually viaListOrdersRequest.builder()
- Parameters:
listOrdersRequest
- AConsumer
that will call methods onListOrdersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOrders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrdersPaginator
This is a variant of
listOrders(software.amazon.awssdk.services.privatenetworks.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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListOrdersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListOrdersResponse response) { //... }; });
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.privatenetworks.model.ListOrdersRequest)
operation.- Parameters:
listOrdersRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOrdersPaginator
default ListOrdersPublisher listOrdersPaginator(Consumer<ListOrdersRequest.Builder> listOrdersRequest) This is a variant of
listOrders(software.amazon.awssdk.services.privatenetworks.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 newSubscription
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 methodsoftware.amazon.awssdk.services.privatenetworks.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.privatenetworks.paginators.ListOrdersPublisher publisher = client.listOrdersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.privatenetworks.model.ListOrdersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.privatenetworks.model.ListOrdersResponse response) { //... }; });
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.privatenetworks.model.ListOrdersRequest)
operation.
This is a convenience which creates an instance of the
ListOrdersRequest.Builder
avoiding the need to create one manually viaListOrdersRequest.builder()
- Parameters:
listOrdersRequest
- AConsumer
that will call methods onListOrdersRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- ThrottlingException The request was denied due to request throttling.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- ThrottlingException The request was denied due to request throttling.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
ping
Checks the health of the service.
- Parameters:
pingRequest
-- Returns:
- A Java Future containing the result of the Ping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
ping
Checks the health of the service.
This is a convenience which creates an instance of the
PingRequest.Builder
avoiding the need to create one manually viaPingRequest.builder()
- Parameters:
pingRequest
- AConsumer
that will call methods onPingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the Ping operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startNetworkResourceUpdate
default CompletableFuture<StartNetworkResourceUpdateResponse> startNetworkResourceUpdate(StartNetworkResourceUpdateRequest startNetworkResourceUpdateRequest) Use this action to do the following tasks:
-
Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
-
Request a replacement for a network resource.
-
Request that you return a network resource.
After you submit a request to replace or return a network resource, the status of the network resource changes to
CREATING_SHIPPING_LABEL
. The shipping label is available when the status of the network resource isPENDING_RETURN
. After the network resource is successfully returned, its status changes toDELETED
. For more information, see Return a radio unit.- Parameters:
startNetworkResourceUpdateRequest
-- Returns:
- A Java Future containing the result of the StartNetworkResourceUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startNetworkResourceUpdate
default CompletableFuture<StartNetworkResourceUpdateResponse> startNetworkResourceUpdate(Consumer<StartNetworkResourceUpdateRequest.Builder> startNetworkResourceUpdateRequest) Use this action to do the following tasks:
-
Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
-
Request a replacement for a network resource.
-
Request that you return a network resource.
After you submit a request to replace or return a network resource, the status of the network resource changes to
CREATING_SHIPPING_LABEL
. The shipping label is available when the status of the network resource isPENDING_RETURN
. After the network resource is successfully returned, its status changes toDELETED
. For more information, see Return a radio unit.
This is a convenience which creates an instance of the
StartNetworkResourceUpdateRequest.Builder
avoiding the need to create one manually viaStartNetworkResourceUpdateRequest.builder()
- Parameters:
startNetworkResourceUpdateRequest
- AConsumer
that will call methods onStartNetworkResourceUpdateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartNetworkResourceUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
Adds tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- ThrottlingException The request was denied due to request throttling.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- ThrottlingException The request was denied due to request throttling.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- ThrottlingException The request was denied due to request throttling.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- AccessDeniedException You do not have permission to perform this operation.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- ThrottlingException The request was denied due to request throttling.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNetworkSite
default CompletableFuture<UpdateNetworkSiteResponse> updateNetworkSite(UpdateNetworkSiteRequest updateNetworkSiteRequest) Updates the specified network site.
- Parameters:
updateNetworkSiteRequest
-- Returns:
- A Java Future containing the result of the UpdateNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNetworkSite
default CompletableFuture<UpdateNetworkSiteResponse> updateNetworkSite(Consumer<UpdateNetworkSiteRequest.Builder> updateNetworkSiteRequest) Updates the specified network site.
This is a convenience which creates an instance of the
UpdateNetworkSiteRequest.Builder
avoiding the need to create one manually viaUpdateNetworkSiteRequest.builder()
- Parameters:
updateNetworkSiteRequest
- AConsumer
that will call methods onUpdateNetworkSiteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateNetworkSite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNetworkSitePlan
default CompletableFuture<UpdateNetworkSitePlanResponse> updateNetworkSitePlan(UpdateNetworkSitePlanRequest updateNetworkSitePlanRequest) Updates the specified network site plan.
- Parameters:
updateNetworkSitePlanRequest
-- Returns:
- A Java Future containing the result of the UpdateNetworkSitePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNetworkSitePlan
default CompletableFuture<UpdateNetworkSitePlanResponse> updateNetworkSitePlan(Consumer<UpdateNetworkSitePlanRequest.Builder> updateNetworkSitePlanRequest) Updates the specified network site plan.
This is a convenience which creates an instance of the
UpdateNetworkSitePlanRequest.Builder
avoiding the need to create one manually viaUpdateNetworkSitePlanRequest.builder()
- Parameters:
updateNetworkSitePlanRequest
- AConsumer
that will call methods onUpdateNetworkSitePlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateNetworkSitePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource was not found.
- ValidationException The request failed validation.
- InternalServerException Information about an internal error.
- 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.
- PrivateNetworksException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aPrivateNetworksAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPrivateNetworksAsyncClient
.
-