Interface PanoramaAsyncClient
- 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.
Overview
This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic PanoramaAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aPanoramaAsyncClient
.static PanoramaAsyncClient
create()
Create aPanoramaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createApplicationInstance
(Consumer<CreateApplicationInstanceRequest.Builder> createApplicationInstanceRequest) Creates an application instance and deploys it to a device.createApplicationInstance
(CreateApplicationInstanceRequest createApplicationInstanceRequest) Creates an application instance and deploys it to a device.createJobForDevices
(Consumer<CreateJobForDevicesRequest.Builder> createJobForDevicesRequest) Creates a job to run on a device.createJobForDevices
(CreateJobForDevicesRequest createJobForDevicesRequest) Creates a job to run on a device.createNodeFromTemplateJob
(Consumer<CreateNodeFromTemplateJobRequest.Builder> createNodeFromTemplateJobRequest) Creates a camera stream node.createNodeFromTemplateJob
(CreateNodeFromTemplateJobRequest createNodeFromTemplateJobRequest) Creates a camera stream node.default CompletableFuture
<CreatePackageResponse> createPackage
(Consumer<CreatePackageRequest.Builder> createPackageRequest) Creates a package and storage location in an Amazon S3 access point.default CompletableFuture
<CreatePackageResponse> createPackage
(CreatePackageRequest createPackageRequest) Creates a package and storage location in an Amazon S3 access point.createPackageImportJob
(Consumer<CreatePackageImportJobRequest.Builder> createPackageImportJobRequest) Imports a node package.createPackageImportJob
(CreatePackageImportJobRequest createPackageImportJobRequest) Imports a node package.default CompletableFuture
<DeleteDeviceResponse> deleteDevice
(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest) Deletes a device.default CompletableFuture
<DeleteDeviceResponse> deleteDevice
(DeleteDeviceRequest deleteDeviceRequest) Deletes a device.default CompletableFuture
<DeletePackageResponse> deletePackage
(Consumer<DeletePackageRequest.Builder> deletePackageRequest) Deletes a package.default CompletableFuture
<DeletePackageResponse> deletePackage
(DeletePackageRequest deletePackageRequest) Deletes a package.deregisterPackageVersion
(Consumer<DeregisterPackageVersionRequest.Builder> deregisterPackageVersionRequest) Deregisters a package version.deregisterPackageVersion
(DeregisterPackageVersionRequest deregisterPackageVersionRequest) Deregisters a package version.describeApplicationInstance
(Consumer<DescribeApplicationInstanceRequest.Builder> describeApplicationInstanceRequest) Returns information about an application instance on a device.describeApplicationInstance
(DescribeApplicationInstanceRequest describeApplicationInstanceRequest) Returns information about an application instance on a device.describeApplicationInstanceDetails
(Consumer<DescribeApplicationInstanceDetailsRequest.Builder> describeApplicationInstanceDetailsRequest) Returns information about an application instance's configuration manifest.describeApplicationInstanceDetails
(DescribeApplicationInstanceDetailsRequest describeApplicationInstanceDetailsRequest) Returns information about an application instance's configuration manifest.default CompletableFuture
<DescribeDeviceResponse> describeDevice
(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest) Returns information about a device.default CompletableFuture
<DescribeDeviceResponse> describeDevice
(DescribeDeviceRequest describeDeviceRequest) Returns information about a device.describeDeviceJob
(Consumer<DescribeDeviceJobRequest.Builder> describeDeviceJobRequest) Returns information about a device job.describeDeviceJob
(DescribeDeviceJobRequest describeDeviceJobRequest) Returns information about a device job.default CompletableFuture
<DescribeNodeResponse> describeNode
(Consumer<DescribeNodeRequest.Builder> describeNodeRequest) Returns information about a node.default CompletableFuture
<DescribeNodeResponse> describeNode
(DescribeNodeRequest describeNodeRequest) Returns information about a node.describeNodeFromTemplateJob
(Consumer<DescribeNodeFromTemplateJobRequest.Builder> describeNodeFromTemplateJobRequest) Returns information about a job to create a camera stream node.describeNodeFromTemplateJob
(DescribeNodeFromTemplateJobRequest describeNodeFromTemplateJobRequest) Returns information about a job to create a camera stream node.default CompletableFuture
<DescribePackageResponse> describePackage
(Consumer<DescribePackageRequest.Builder> describePackageRequest) Returns information about a package.default CompletableFuture
<DescribePackageResponse> describePackage
(DescribePackageRequest describePackageRequest) Returns information about a package.describePackageImportJob
(Consumer<DescribePackageImportJobRequest.Builder> describePackageImportJobRequest) Returns information about a package import job.describePackageImportJob
(DescribePackageImportJobRequest describePackageImportJobRequest) Returns information about a package import job.describePackageVersion
(Consumer<DescribePackageVersionRequest.Builder> describePackageVersionRequest) Returns information about a package version.describePackageVersion
(DescribePackageVersionRequest describePackageVersionRequest) Returns information about a package version.listApplicationInstanceDependencies
(Consumer<ListApplicationInstanceDependenciesRequest.Builder> listApplicationInstanceDependenciesRequest) Returns a list of application instance dependencies.listApplicationInstanceDependencies
(ListApplicationInstanceDependenciesRequest listApplicationInstanceDependenciesRequest) Returns a list of application instance dependencies.listApplicationInstanceDependenciesPaginator
(Consumer<ListApplicationInstanceDependenciesRequest.Builder> listApplicationInstanceDependenciesRequest) This is a variant oflistApplicationInstanceDependencies(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesRequest)
operation.listApplicationInstanceDependenciesPaginator
(ListApplicationInstanceDependenciesRequest listApplicationInstanceDependenciesRequest) This is a variant oflistApplicationInstanceDependencies(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesRequest)
operation.listApplicationInstanceNodeInstances
(Consumer<ListApplicationInstanceNodeInstancesRequest.Builder> listApplicationInstanceNodeInstancesRequest) Returns a list of application node instances.listApplicationInstanceNodeInstances
(ListApplicationInstanceNodeInstancesRequest listApplicationInstanceNodeInstancesRequest) Returns a list of application node instances.listApplicationInstanceNodeInstancesPaginator
(Consumer<ListApplicationInstanceNodeInstancesRequest.Builder> listApplicationInstanceNodeInstancesRequest) This is a variant oflistApplicationInstanceNodeInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesRequest)
operation.listApplicationInstanceNodeInstancesPaginator
(ListApplicationInstanceNodeInstancesRequest listApplicationInstanceNodeInstancesRequest) This is a variant oflistApplicationInstanceNodeInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesRequest)
operation.listApplicationInstances
(Consumer<ListApplicationInstancesRequest.Builder> listApplicationInstancesRequest) Returns a list of application instances.listApplicationInstances
(ListApplicationInstancesRequest listApplicationInstancesRequest) Returns a list of application instances.listApplicationInstancesPaginator
(Consumer<ListApplicationInstancesRequest.Builder> listApplicationInstancesRequest) This is a variant oflistApplicationInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesRequest)
operation.listApplicationInstancesPaginator
(ListApplicationInstancesRequest listApplicationInstancesRequest) This is a variant oflistApplicationInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesRequest)
operation.default CompletableFuture
<ListDevicesResponse> listDevices
(Consumer<ListDevicesRequest.Builder> listDevicesRequest) Returns a list of devices.default CompletableFuture
<ListDevicesResponse> listDevices
(ListDevicesRequest listDevicesRequest) Returns a list of devices.default CompletableFuture
<ListDevicesJobsResponse> listDevicesJobs
(Consumer<ListDevicesJobsRequest.Builder> listDevicesJobsRequest) Returns a list of jobs.default CompletableFuture
<ListDevicesJobsResponse> listDevicesJobs
(ListDevicesJobsRequest listDevicesJobsRequest) Returns a list of jobs.default ListDevicesJobsPublisher
listDevicesJobsPaginator
(Consumer<ListDevicesJobsRequest.Builder> listDevicesJobsRequest) This is a variant oflistDevicesJobs(software.amazon.awssdk.services.panorama.model.ListDevicesJobsRequest)
operation.default ListDevicesJobsPublisher
listDevicesJobsPaginator
(ListDevicesJobsRequest listDevicesJobsRequest) This is a variant oflistDevicesJobs(software.amazon.awssdk.services.panorama.model.ListDevicesJobsRequest)
operation.default ListDevicesPublisher
listDevicesPaginator
(Consumer<ListDevicesRequest.Builder> listDevicesRequest) This is a variant oflistDevices(software.amazon.awssdk.services.panorama.model.ListDevicesRequest)
operation.default ListDevicesPublisher
listDevicesPaginator
(ListDevicesRequest listDevicesRequest) This is a variant oflistDevices(software.amazon.awssdk.services.panorama.model.ListDevicesRequest)
operation.listNodeFromTemplateJobs
(Consumer<ListNodeFromTemplateJobsRequest.Builder> listNodeFromTemplateJobsRequest) Returns a list of camera stream node jobs.listNodeFromTemplateJobs
(ListNodeFromTemplateJobsRequest listNodeFromTemplateJobsRequest) Returns a list of camera stream node jobs.listNodeFromTemplateJobsPaginator
(Consumer<ListNodeFromTemplateJobsRequest.Builder> listNodeFromTemplateJobsRequest) This is a variant oflistNodeFromTemplateJobs(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsRequest)
operation.listNodeFromTemplateJobsPaginator
(ListNodeFromTemplateJobsRequest listNodeFromTemplateJobsRequest) This is a variant oflistNodeFromTemplateJobs(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsRequest)
operation.default CompletableFuture
<ListNodesResponse> listNodes
(Consumer<ListNodesRequest.Builder> listNodesRequest) Returns a list of nodes.default CompletableFuture
<ListNodesResponse> listNodes
(ListNodesRequest listNodesRequest) Returns a list of nodes.default ListNodesPublisher
listNodesPaginator
(Consumer<ListNodesRequest.Builder> listNodesRequest) This is a variant oflistNodes(software.amazon.awssdk.services.panorama.model.ListNodesRequest)
operation.default ListNodesPublisher
listNodesPaginator
(ListNodesRequest listNodesRequest) This is a variant oflistNodes(software.amazon.awssdk.services.panorama.model.ListNodesRequest)
operation.listPackageImportJobs
(Consumer<ListPackageImportJobsRequest.Builder> listPackageImportJobsRequest) Returns a list of package import jobs.listPackageImportJobs
(ListPackageImportJobsRequest listPackageImportJobsRequest) Returns a list of package import jobs.default ListPackageImportJobsPublisher
listPackageImportJobsPaginator
(Consumer<ListPackageImportJobsRequest.Builder> listPackageImportJobsRequest) This is a variant oflistPackageImportJobs(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsRequest)
operation.default ListPackageImportJobsPublisher
listPackageImportJobsPaginator
(ListPackageImportJobsRequest listPackageImportJobsRequest) This is a variant oflistPackageImportJobs(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsRequest)
operation.default CompletableFuture
<ListPackagesResponse> listPackages
(Consumer<ListPackagesRequest.Builder> listPackagesRequest) Returns a list of packages.default CompletableFuture
<ListPackagesResponse> listPackages
(ListPackagesRequest listPackagesRequest) Returns a list of packages.default ListPackagesPublisher
listPackagesPaginator
(Consumer<ListPackagesRequest.Builder> listPackagesRequest) This is a variant oflistPackages(software.amazon.awssdk.services.panorama.model.ListPackagesRequest)
operation.default ListPackagesPublisher
listPackagesPaginator
(ListPackagesRequest listPackagesRequest) This is a variant oflistPackages(software.amazon.awssdk.services.panorama.model.ListPackagesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a resource.default CompletableFuture
<ProvisionDeviceResponse> provisionDevice
(Consumer<ProvisionDeviceRequest.Builder> provisionDeviceRequest) Creates a device and returns a configuration archive.default CompletableFuture
<ProvisionDeviceResponse> provisionDevice
(ProvisionDeviceRequest provisionDeviceRequest) Creates a device and returns a configuration archive.registerPackageVersion
(Consumer<RegisterPackageVersionRequest.Builder> registerPackageVersionRequest) Registers a package version.registerPackageVersion
(RegisterPackageVersionRequest registerPackageVersionRequest) Registers a package version.removeApplicationInstance
(Consumer<RemoveApplicationInstanceRequest.Builder> removeApplicationInstanceRequest) Removes an application instance.removeApplicationInstance
(RemoveApplicationInstanceRequest removeApplicationInstanceRequest) Removes an application instance.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsignalApplicationInstanceNodeInstances
(Consumer<SignalApplicationInstanceNodeInstancesRequest.Builder> signalApplicationInstanceNodeInstancesRequest) Signal camera nodes to stop or resume.signalApplicationInstanceNodeInstances
(SignalApplicationInstanceNodeInstancesRequest signalApplicationInstanceNodeInstancesRequest) Signal camera nodes to stop or resume.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Tags a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from a resource.updateDeviceMetadata
(Consumer<UpdateDeviceMetadataRequest.Builder> updateDeviceMetadataRequest) Updates a device's metadata.updateDeviceMetadata
(UpdateDeviceMetadataRequest updateDeviceMetadataRequest) Updates a device's metadata.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
-
createApplicationInstance
default CompletableFuture<CreateApplicationInstanceResponse> createApplicationInstance(CreateApplicationInstanceRequest createApplicationInstanceRequest) Creates an application instance and deploys it to a device.
- Parameters:
createApplicationInstanceRequest
-- Returns:
- A Java Future containing the result of the CreateApplicationInstance 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.- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ServiceQuotaExceededException The request would cause a limit to be exceeded.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplicationInstance
default CompletableFuture<CreateApplicationInstanceResponse> createApplicationInstance(Consumer<CreateApplicationInstanceRequest.Builder> createApplicationInstanceRequest) Creates an application instance and deploys it to a device.
This is a convenience which creates an instance of the
CreateApplicationInstanceRequest.Builder
avoiding the need to create one manually viaCreateApplicationInstanceRequest.builder()
- Parameters:
createApplicationInstanceRequest
- AConsumer
that will call methods onCreateApplicationInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApplicationInstance 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.- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ServiceQuotaExceededException The request would cause a limit to be exceeded.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createJobForDevices
default CompletableFuture<CreateJobForDevicesResponse> createJobForDevices(CreateJobForDevicesRequest createJobForDevicesRequest) Creates a job to run on a device. A job can update a device's software or reboot it.
- Parameters:
createJobForDevicesRequest
-- Returns:
- A Java Future containing the result of the CreateJobForDevices 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createJobForDevices
default CompletableFuture<CreateJobForDevicesResponse> createJobForDevices(Consumer<CreateJobForDevicesRequest.Builder> createJobForDevicesRequest) Creates a job to run on a device. A job can update a device's software or reboot it.
This is a convenience which creates an instance of the
CreateJobForDevicesRequest.Builder
avoiding the need to create one manually viaCreateJobForDevicesRequest.builder()
- Parameters:
createJobForDevicesRequest
- AConsumer
that will call methods onCreateJobForDevicesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateJobForDevices 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNodeFromTemplateJob
default CompletableFuture<CreateNodeFromTemplateJobResponse> createNodeFromTemplateJob(CreateNodeFromTemplateJobRequest createNodeFromTemplateJobRequest) Creates a camera stream node.
- Parameters:
createNodeFromTemplateJobRequest
-- Returns:
- A Java Future containing the result of the CreateNodeFromTemplateJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNodeFromTemplateJob
default CompletableFuture<CreateNodeFromTemplateJobResponse> createNodeFromTemplateJob(Consumer<CreateNodeFromTemplateJobRequest.Builder> createNodeFromTemplateJobRequest) Creates a camera stream node.
This is a convenience which creates an instance of the
CreateNodeFromTemplateJobRequest.Builder
avoiding the need to create one manually viaCreateNodeFromTemplateJobRequest.builder()
- Parameters:
createNodeFromTemplateJobRequest
- AConsumer
that will call methods onCreateNodeFromTemplateJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateNodeFromTemplateJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPackage
default CompletableFuture<CreatePackageResponse> createPackage(CreatePackageRequest createPackageRequest) Creates a package and storage location in an Amazon S3 access point.
- Parameters:
createPackageRequest
-- Returns:
- A Java Future containing the result of the CreatePackage 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPackage
default CompletableFuture<CreatePackageResponse> createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) Creates a package and storage location in an Amazon S3 access point.
This is a convenience which creates an instance of the
CreatePackageRequest.Builder
avoiding the need to create one manually viaCreatePackageRequest.builder()
- Parameters:
createPackageRequest
- AConsumer
that will call methods onCreatePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePackage 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPackageImportJob
default CompletableFuture<CreatePackageImportJobResponse> createPackageImportJob(CreatePackageImportJobRequest createPackageImportJobRequest) Imports a node package.
- Parameters:
createPackageImportJobRequest
-- Returns:
- A Java Future containing the result of the CreatePackageImportJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPackageImportJob
default CompletableFuture<CreatePackageImportJobResponse> createPackageImportJob(Consumer<CreatePackageImportJobRequest.Builder> createPackageImportJobRequest) Imports a node package.
This is a convenience which creates an instance of the
CreatePackageImportJobRequest.Builder
avoiding the need to create one manually viaCreatePackageImportJobRequest.builder()
- Parameters:
createPackageImportJobRequest
- AConsumer
that will call methods onCreatePackageImportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePackageImportJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDevice
default CompletableFuture<DeleteDeviceResponse> deleteDevice(DeleteDeviceRequest deleteDeviceRequest) Deletes a device.
- Parameters:
deleteDeviceRequest
-- Returns:
- A Java Future containing the result of the DeleteDevice 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDevice
default CompletableFuture<DeleteDeviceResponse> deleteDevice(Consumer<DeleteDeviceRequest.Builder> deleteDeviceRequest) Deletes a device.
This is a convenience which creates an instance of the
DeleteDeviceRequest.Builder
avoiding the need to create one manually viaDeleteDeviceRequest.builder()
- Parameters:
deleteDeviceRequest
- AConsumer
that will call methods onDeleteDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDevice 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackage
default CompletableFuture<DeletePackageResponse> deletePackage(DeletePackageRequest deletePackageRequest) Deletes a package.
To delete a package, you need permission to call
s3:DeleteObject
in addition to permissions for the AWS Panorama API.- Parameters:
deletePackageRequest
-- Returns:
- A Java Future containing the result of the DeletePackage 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePackage
default CompletableFuture<DeletePackageResponse> deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) Deletes a package.
To delete a package, you need permission to call
s3:DeleteObject
in addition to permissions for the AWS Panorama API.
This is a convenience which creates an instance of the
DeletePackageRequest.Builder
avoiding the need to create one manually viaDeletePackageRequest.builder()
- Parameters:
deletePackageRequest
- AConsumer
that will call methods onDeletePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePackage 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterPackageVersion
default CompletableFuture<DeregisterPackageVersionResponse> deregisterPackageVersion(DeregisterPackageVersionRequest deregisterPackageVersionRequest) Deregisters a package version.
- Parameters:
deregisterPackageVersionRequest
-- Returns:
- A Java Future containing the result of the DeregisterPackageVersion 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterPackageVersion
default CompletableFuture<DeregisterPackageVersionResponse> deregisterPackageVersion(Consumer<DeregisterPackageVersionRequest.Builder> deregisterPackageVersionRequest) Deregisters a package version.
This is a convenience which creates an instance of the
DeregisterPackageVersionRequest.Builder
avoiding the need to create one manually viaDeregisterPackageVersionRequest.builder()
- Parameters:
deregisterPackageVersionRequest
- AConsumer
that will call methods onDeregisterPackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterPackageVersion 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplicationInstance
default CompletableFuture<DescribeApplicationInstanceResponse> describeApplicationInstance(DescribeApplicationInstanceRequest describeApplicationInstanceRequest) Returns information about an application instance on a device.
- Parameters:
describeApplicationInstanceRequest
-- Returns:
- A Java Future containing the result of the DescribeApplicationInstance 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplicationInstance
default CompletableFuture<DescribeApplicationInstanceResponse> describeApplicationInstance(Consumer<DescribeApplicationInstanceRequest.Builder> describeApplicationInstanceRequest) Returns information about an application instance on a device.
This is a convenience which creates an instance of the
DescribeApplicationInstanceRequest.Builder
avoiding the need to create one manually viaDescribeApplicationInstanceRequest.builder()
- Parameters:
describeApplicationInstanceRequest
- AConsumer
that will call methods onDescribeApplicationInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplicationInstance 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplicationInstanceDetails
default CompletableFuture<DescribeApplicationInstanceDetailsResponse> describeApplicationInstanceDetails(DescribeApplicationInstanceDetailsRequest describeApplicationInstanceDetailsRequest) Returns information about an application instance's configuration manifest.
- Parameters:
describeApplicationInstanceDetailsRequest
-- Returns:
- A Java Future containing the result of the DescribeApplicationInstanceDetails 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeApplicationInstanceDetails
default CompletableFuture<DescribeApplicationInstanceDetailsResponse> describeApplicationInstanceDetails(Consumer<DescribeApplicationInstanceDetailsRequest.Builder> describeApplicationInstanceDetailsRequest) Returns information about an application instance's configuration manifest.
This is a convenience which creates an instance of the
DescribeApplicationInstanceDetailsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationInstanceDetailsRequest.builder()
- Parameters:
describeApplicationInstanceDetailsRequest
- AConsumer
that will call methods onDescribeApplicationInstanceDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplicationInstanceDetails 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDevice
default CompletableFuture<DescribeDeviceResponse> describeDevice(DescribeDeviceRequest describeDeviceRequest) Returns information about a device.
- Parameters:
describeDeviceRequest
-- Returns:
- A Java Future containing the result of the DescribeDevice 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.- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDevice
default CompletableFuture<DescribeDeviceResponse> describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest) Returns information about a device.
This is a convenience which creates an instance of the
DescribeDeviceRequest.Builder
avoiding the need to create one manually viaDescribeDeviceRequest.builder()
- Parameters:
describeDeviceRequest
- AConsumer
that will call methods onDescribeDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDevice 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.- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeviceJob
default CompletableFuture<DescribeDeviceJobResponse> describeDeviceJob(DescribeDeviceJobRequest describeDeviceJobRequest) Returns information about a device job.
- Parameters:
describeDeviceJobRequest
-- Returns:
- A Java Future containing the result of the DescribeDeviceJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeviceJob
default CompletableFuture<DescribeDeviceJobResponse> describeDeviceJob(Consumer<DescribeDeviceJobRequest.Builder> describeDeviceJobRequest) Returns information about a device job.
This is a convenience which creates an instance of the
DescribeDeviceJobRequest.Builder
avoiding the need to create one manually viaDescribeDeviceJobRequest.builder()
- Parameters:
describeDeviceJobRequest
- AConsumer
that will call methods onDescribeDeviceJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDeviceJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNode
default CompletableFuture<DescribeNodeResponse> describeNode(DescribeNodeRequest describeNodeRequest) Returns information about a node.
- Parameters:
describeNodeRequest
-- Returns:
- A Java Future containing the result of the DescribeNode 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNode
default CompletableFuture<DescribeNodeResponse> describeNode(Consumer<DescribeNodeRequest.Builder> describeNodeRequest) Returns information about a node.
This is a convenience which creates an instance of the
DescribeNodeRequest.Builder
avoiding the need to create one manually viaDescribeNodeRequest.builder()
- Parameters:
describeNodeRequest
- AConsumer
that will call methods onDescribeNodeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeNode 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNodeFromTemplateJob
default CompletableFuture<DescribeNodeFromTemplateJobResponse> describeNodeFromTemplateJob(DescribeNodeFromTemplateJobRequest describeNodeFromTemplateJobRequest) Returns information about a job to create a camera stream node.
- Parameters:
describeNodeFromTemplateJobRequest
-- Returns:
- A Java Future containing the result of the DescribeNodeFromTemplateJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNodeFromTemplateJob
default CompletableFuture<DescribeNodeFromTemplateJobResponse> describeNodeFromTemplateJob(Consumer<DescribeNodeFromTemplateJobRequest.Builder> describeNodeFromTemplateJobRequest) Returns information about a job to create a camera stream node.
This is a convenience which creates an instance of the
DescribeNodeFromTemplateJobRequest.Builder
avoiding the need to create one manually viaDescribeNodeFromTemplateJobRequest.builder()
- Parameters:
describeNodeFromTemplateJobRequest
- AConsumer
that will call methods onDescribeNodeFromTemplateJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeNodeFromTemplateJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackage
default CompletableFuture<DescribePackageResponse> describePackage(DescribePackageRequest describePackageRequest) Returns information about a package.
- Parameters:
describePackageRequest
-- Returns:
- A Java Future containing the result of the DescribePackage 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackage
default CompletableFuture<DescribePackageResponse> describePackage(Consumer<DescribePackageRequest.Builder> describePackageRequest) Returns information about a package.
This is a convenience which creates an instance of the
DescribePackageRequest.Builder
avoiding the need to create one manually viaDescribePackageRequest.builder()
- Parameters:
describePackageRequest
- AConsumer
that will call methods onDescribePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePackage 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageImportJob
default CompletableFuture<DescribePackageImportJobResponse> describePackageImportJob(DescribePackageImportJobRequest describePackageImportJobRequest) Returns information about a package import job.
- Parameters:
describePackageImportJobRequest
-- Returns:
- A Java Future containing the result of the DescribePackageImportJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageImportJob
default CompletableFuture<DescribePackageImportJobResponse> describePackageImportJob(Consumer<DescribePackageImportJobRequest.Builder> describePackageImportJobRequest) Returns information about a package import job.
This is a convenience which creates an instance of the
DescribePackageImportJobRequest.Builder
avoiding the need to create one manually viaDescribePackageImportJobRequest.builder()
- Parameters:
describePackageImportJobRequest
- AConsumer
that will call methods onDescribePackageImportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePackageImportJob 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageVersion
default CompletableFuture<DescribePackageVersionResponse> describePackageVersion(DescribePackageVersionRequest describePackageVersionRequest) Returns information about a package version.
- Parameters:
describePackageVersionRequest
-- Returns:
- A Java Future containing the result of the DescribePackageVersion 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePackageVersion
default CompletableFuture<DescribePackageVersionResponse> describePackageVersion(Consumer<DescribePackageVersionRequest.Builder> describePackageVersionRequest) Returns information about a package version.
This is a convenience which creates an instance of the
DescribePackageVersionRequest.Builder
avoiding the need to create one manually viaDescribePackageVersionRequest.builder()
- Parameters:
describePackageVersionRequest
- AConsumer
that will call methods onDescribePackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePackageVersion 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceDependencies
default CompletableFuture<ListApplicationInstanceDependenciesResponse> listApplicationInstanceDependencies(ListApplicationInstanceDependenciesRequest listApplicationInstanceDependenciesRequest) Returns a list of application instance dependencies.
- Parameters:
listApplicationInstanceDependenciesRequest
-- Returns:
- A Java Future containing the result of the ListApplicationInstanceDependencies 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceDependencies
default CompletableFuture<ListApplicationInstanceDependenciesResponse> listApplicationInstanceDependencies(Consumer<ListApplicationInstanceDependenciesRequest.Builder> listApplicationInstanceDependenciesRequest) Returns a list of application instance dependencies.
This is a convenience which creates an instance of the
ListApplicationInstanceDependenciesRequest.Builder
avoiding the need to create one manually viaListApplicationInstanceDependenciesRequest.builder()
- Parameters:
listApplicationInstanceDependenciesRequest
- AConsumer
that will call methods onListApplicationInstanceDependenciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationInstanceDependencies 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceDependenciesPaginator
default ListApplicationInstanceDependenciesPublisher listApplicationInstanceDependenciesPaginator(ListApplicationInstanceDependenciesRequest listApplicationInstanceDependenciesRequest) This is a variant of
listApplicationInstanceDependencies(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesRequest)
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.panorama.paginators.ListApplicationInstanceDependenciesPublisher publisher = client.listApplicationInstanceDependenciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListApplicationInstanceDependenciesPublisher publisher = client.listApplicationInstanceDependenciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesResponse 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
listApplicationInstanceDependencies(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesRequest)
operation.- Parameters:
listApplicationInstanceDependenciesRequest
-- 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceDependenciesPaginator
default ListApplicationInstanceDependenciesPublisher listApplicationInstanceDependenciesPaginator(Consumer<ListApplicationInstanceDependenciesRequest.Builder> listApplicationInstanceDependenciesRequest) This is a variant of
listApplicationInstanceDependencies(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesRequest)
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.panorama.paginators.ListApplicationInstanceDependenciesPublisher publisher = client.listApplicationInstanceDependenciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListApplicationInstanceDependenciesPublisher publisher = client.listApplicationInstanceDependenciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesResponse 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
listApplicationInstanceDependencies(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceDependenciesRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationInstanceDependenciesRequest.Builder
avoiding the need to create one manually viaListApplicationInstanceDependenciesRequest.builder()
- Parameters:
listApplicationInstanceDependenciesRequest
- AConsumer
that will call methods onListApplicationInstanceDependenciesRequest.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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceNodeInstances
default CompletableFuture<ListApplicationInstanceNodeInstancesResponse> listApplicationInstanceNodeInstances(ListApplicationInstanceNodeInstancesRequest listApplicationInstanceNodeInstancesRequest) Returns a list of application node instances.
- Parameters:
listApplicationInstanceNodeInstancesRequest
-- Returns:
- A Java Future containing the result of the ListApplicationInstanceNodeInstances 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceNodeInstances
default CompletableFuture<ListApplicationInstanceNodeInstancesResponse> listApplicationInstanceNodeInstances(Consumer<ListApplicationInstanceNodeInstancesRequest.Builder> listApplicationInstanceNodeInstancesRequest) Returns a list of application node instances.
This is a convenience which creates an instance of the
ListApplicationInstanceNodeInstancesRequest.Builder
avoiding the need to create one manually viaListApplicationInstanceNodeInstancesRequest.builder()
- Parameters:
listApplicationInstanceNodeInstancesRequest
- AConsumer
that will call methods onListApplicationInstanceNodeInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationInstanceNodeInstances 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceNodeInstancesPaginator
default ListApplicationInstanceNodeInstancesPublisher listApplicationInstanceNodeInstancesPaginator(ListApplicationInstanceNodeInstancesRequest listApplicationInstanceNodeInstancesRequest) This is a variant of
listApplicationInstanceNodeInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesRequest)
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.panorama.paginators.ListApplicationInstanceNodeInstancesPublisher publisher = client.listApplicationInstanceNodeInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListApplicationInstanceNodeInstancesPublisher publisher = client.listApplicationInstanceNodeInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesResponse 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
listApplicationInstanceNodeInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesRequest)
operation.- Parameters:
listApplicationInstanceNodeInstancesRequest
-- 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstanceNodeInstancesPaginator
default ListApplicationInstanceNodeInstancesPublisher listApplicationInstanceNodeInstancesPaginator(Consumer<ListApplicationInstanceNodeInstancesRequest.Builder> listApplicationInstanceNodeInstancesRequest) This is a variant of
listApplicationInstanceNodeInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesRequest)
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.panorama.paginators.ListApplicationInstanceNodeInstancesPublisher publisher = client.listApplicationInstanceNodeInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListApplicationInstanceNodeInstancesPublisher publisher = client.listApplicationInstanceNodeInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesResponse 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
listApplicationInstanceNodeInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstanceNodeInstancesRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationInstanceNodeInstancesRequest.Builder
avoiding the need to create one manually viaListApplicationInstanceNodeInstancesRequest.builder()
- Parameters:
listApplicationInstanceNodeInstancesRequest
- AConsumer
that will call methods onListApplicationInstanceNodeInstancesRequest.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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstances
default CompletableFuture<ListApplicationInstancesResponse> listApplicationInstances(ListApplicationInstancesRequest listApplicationInstancesRequest) Returns a list of application instances.
- Parameters:
listApplicationInstancesRequest
-- Returns:
- A Java Future containing the result of the ListApplicationInstances 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstances
default CompletableFuture<ListApplicationInstancesResponse> listApplicationInstances(Consumer<ListApplicationInstancesRequest.Builder> listApplicationInstancesRequest) Returns a list of application instances.
This is a convenience which creates an instance of the
ListApplicationInstancesRequest.Builder
avoiding the need to create one manually viaListApplicationInstancesRequest.builder()
- Parameters:
listApplicationInstancesRequest
- AConsumer
that will call methods onListApplicationInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationInstances 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstancesPaginator
default ListApplicationInstancesPublisher listApplicationInstancesPaginator(ListApplicationInstancesRequest listApplicationInstancesRequest) This is a variant of
listApplicationInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesRequest)
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.panorama.paginators.ListApplicationInstancesPublisher publisher = client.listApplicationInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListApplicationInstancesPublisher publisher = client.listApplicationInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListApplicationInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesResponse 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
listApplicationInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesRequest)
operation.- Parameters:
listApplicationInstancesRequest
-- 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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationInstancesPaginator
default ListApplicationInstancesPublisher listApplicationInstancesPaginator(Consumer<ListApplicationInstancesRequest.Builder> listApplicationInstancesRequest) This is a variant of
listApplicationInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesRequest)
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.panorama.paginators.ListApplicationInstancesPublisher publisher = client.listApplicationInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListApplicationInstancesPublisher publisher = client.listApplicationInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListApplicationInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesResponse 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
listApplicationInstances(software.amazon.awssdk.services.panorama.model.ListApplicationInstancesRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationInstancesRequest.Builder
avoiding the need to create one manually viaListApplicationInstancesRequest.builder()
- Parameters:
listApplicationInstancesRequest
- AConsumer
that will call methods onListApplicationInstancesRequest.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.- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevices
Returns a list of devices.
- Parameters:
listDevicesRequest
-- Returns:
- A Java Future containing the result of the ListDevices 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevices
default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest) Returns a list of devices.
This is a convenience which creates an instance of the
ListDevicesRequest.Builder
avoiding the need to create one manually viaListDevicesRequest.builder()
- Parameters:
listDevicesRequest
- AConsumer
that will call methods onListDevicesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDevices 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesJobs
default CompletableFuture<ListDevicesJobsResponse> listDevicesJobs(ListDevicesJobsRequest listDevicesJobsRequest) Returns a list of jobs.
- Parameters:
listDevicesJobsRequest
-- Returns:
- A Java Future containing the result of the ListDevicesJobs 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesJobs
default CompletableFuture<ListDevicesJobsResponse> listDevicesJobs(Consumer<ListDevicesJobsRequest.Builder> listDevicesJobsRequest) Returns a list of jobs.
This is a convenience which creates an instance of the
ListDevicesJobsRequest.Builder
avoiding the need to create one manually viaListDevicesJobsRequest.builder()
- Parameters:
listDevicesJobsRequest
- AConsumer
that will call methods onListDevicesJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDevicesJobs 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesJobsPaginator
default ListDevicesJobsPublisher listDevicesJobsPaginator(ListDevicesJobsRequest listDevicesJobsRequest) This is a variant of
listDevicesJobs(software.amazon.awssdk.services.panorama.model.ListDevicesJobsRequest)
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.panorama.paginators.ListDevicesJobsPublisher publisher = client.listDevicesJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListDevicesJobsPublisher publisher = client.listDevicesJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListDevicesJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListDevicesJobsResponse 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
listDevicesJobs(software.amazon.awssdk.services.panorama.model.ListDevicesJobsRequest)
operation.- Parameters:
listDevicesJobsRequest
-- 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesJobsPaginator
default ListDevicesJobsPublisher listDevicesJobsPaginator(Consumer<ListDevicesJobsRequest.Builder> listDevicesJobsRequest) This is a variant of
listDevicesJobs(software.amazon.awssdk.services.panorama.model.ListDevicesJobsRequest)
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.panorama.paginators.ListDevicesJobsPublisher publisher = client.listDevicesJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListDevicesJobsPublisher publisher = client.listDevicesJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListDevicesJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListDevicesJobsResponse 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
listDevicesJobs(software.amazon.awssdk.services.panorama.model.ListDevicesJobsRequest)
operation.
This is a convenience which creates an instance of the
ListDevicesJobsRequest.Builder
avoiding the need to create one manually viaListDevicesJobsRequest.builder()
- Parameters:
listDevicesJobsRequest
- AConsumer
that will call methods onListDevicesJobsRequest.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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesPaginator
This is a variant of
listDevices(software.amazon.awssdk.services.panorama.model.ListDevicesRequest)
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.panorama.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListDevicesResponse 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
listDevices(software.amazon.awssdk.services.panorama.model.ListDevicesRequest)
operation.- Parameters:
listDevicesRequest
-- 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevicesPaginator
default ListDevicesPublisher listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest) This is a variant of
listDevices(software.amazon.awssdk.services.panorama.model.ListDevicesRequest)
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.panorama.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListDevicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListDevicesResponse 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
listDevices(software.amazon.awssdk.services.panorama.model.ListDevicesRequest)
operation.
This is a convenience which creates an instance of the
ListDevicesRequest.Builder
avoiding the need to create one manually viaListDevicesRequest.builder()
- Parameters:
listDevicesRequest
- AConsumer
that will call methods onListDevicesRequest.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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodeFromTemplateJobs
default CompletableFuture<ListNodeFromTemplateJobsResponse> listNodeFromTemplateJobs(ListNodeFromTemplateJobsRequest listNodeFromTemplateJobsRequest) Returns a list of camera stream node jobs.
- Parameters:
listNodeFromTemplateJobsRequest
-- Returns:
- A Java Future containing the result of the ListNodeFromTemplateJobs 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodeFromTemplateJobs
default CompletableFuture<ListNodeFromTemplateJobsResponse> listNodeFromTemplateJobs(Consumer<ListNodeFromTemplateJobsRequest.Builder> listNodeFromTemplateJobsRequest) Returns a list of camera stream node jobs.
This is a convenience which creates an instance of the
ListNodeFromTemplateJobsRequest.Builder
avoiding the need to create one manually viaListNodeFromTemplateJobsRequest.builder()
- Parameters:
listNodeFromTemplateJobsRequest
- AConsumer
that will call methods onListNodeFromTemplateJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNodeFromTemplateJobs 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodeFromTemplateJobsPaginator
default ListNodeFromTemplateJobsPublisher listNodeFromTemplateJobsPaginator(ListNodeFromTemplateJobsRequest listNodeFromTemplateJobsRequest) This is a variant of
listNodeFromTemplateJobs(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsRequest)
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.panorama.paginators.ListNodeFromTemplateJobsPublisher publisher = client.listNodeFromTemplateJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListNodeFromTemplateJobsPublisher publisher = client.listNodeFromTemplateJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsResponse 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
listNodeFromTemplateJobs(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsRequest)
operation.- Parameters:
listNodeFromTemplateJobsRequest
-- 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodeFromTemplateJobsPaginator
default ListNodeFromTemplateJobsPublisher listNodeFromTemplateJobsPaginator(Consumer<ListNodeFromTemplateJobsRequest.Builder> listNodeFromTemplateJobsRequest) This is a variant of
listNodeFromTemplateJobs(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsRequest)
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.panorama.paginators.ListNodeFromTemplateJobsPublisher publisher = client.listNodeFromTemplateJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListNodeFromTemplateJobsPublisher publisher = client.listNodeFromTemplateJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsResponse 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
listNodeFromTemplateJobs(software.amazon.awssdk.services.panorama.model.ListNodeFromTemplateJobsRequest)
operation.
This is a convenience which creates an instance of the
ListNodeFromTemplateJobsRequest.Builder
avoiding the need to create one manually viaListNodeFromTemplateJobsRequest.builder()
- Parameters:
listNodeFromTemplateJobsRequest
- AConsumer
that will call methods onListNodeFromTemplateJobsRequest.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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodes
Returns a list of nodes.
- Parameters:
listNodesRequest
-- Returns:
- A Java Future containing the result of the ListNodes 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodes
default CompletableFuture<ListNodesResponse> listNodes(Consumer<ListNodesRequest.Builder> listNodesRequest) Returns a list of nodes.
This is a convenience which creates an instance of the
ListNodesRequest.Builder
avoiding the need to create one manually viaListNodesRequest.builder()
- Parameters:
listNodesRequest
- AConsumer
that will call methods onListNodesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNodes 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodesPaginator
This is a variant of
listNodes(software.amazon.awssdk.services.panorama.model.ListNodesRequest)
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.panorama.paginators.ListNodesPublisher publisher = client.listNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListNodesPublisher publisher = client.listNodesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListNodesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListNodesResponse 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
listNodes(software.amazon.awssdk.services.panorama.model.ListNodesRequest)
operation.- Parameters:
listNodesRequest
-- 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNodesPaginator
This is a variant of
listNodes(software.amazon.awssdk.services.panorama.model.ListNodesRequest)
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.panorama.paginators.ListNodesPublisher publisher = client.listNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListNodesPublisher publisher = client.listNodesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListNodesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListNodesResponse 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
listNodes(software.amazon.awssdk.services.panorama.model.ListNodesRequest)
operation.
This is a convenience which creates an instance of the
ListNodesRequest.Builder
avoiding the need to create one manually viaListNodesRequest.builder()
- Parameters:
listNodesRequest
- AConsumer
that will call methods onListNodesRequest.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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageImportJobs
default CompletableFuture<ListPackageImportJobsResponse> listPackageImportJobs(ListPackageImportJobsRequest listPackageImportJobsRequest) Returns a list of package import jobs.
- Parameters:
listPackageImportJobsRequest
-- Returns:
- A Java Future containing the result of the ListPackageImportJobs 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageImportJobs
default CompletableFuture<ListPackageImportJobsResponse> listPackageImportJobs(Consumer<ListPackageImportJobsRequest.Builder> listPackageImportJobsRequest) Returns a list of package import jobs.
This is a convenience which creates an instance of the
ListPackageImportJobsRequest.Builder
avoiding the need to create one manually viaListPackageImportJobsRequest.builder()
- Parameters:
listPackageImportJobsRequest
- AConsumer
that will call methods onListPackageImportJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackageImportJobs 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageImportJobsPaginator
default ListPackageImportJobsPublisher listPackageImportJobsPaginator(ListPackageImportJobsRequest listPackageImportJobsRequest) This is a variant of
listPackageImportJobs(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsRequest)
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.panorama.paginators.ListPackageImportJobsPublisher publisher = client.listPackageImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListPackageImportJobsPublisher publisher = client.listPackageImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListPackageImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsResponse 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
listPackageImportJobs(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsRequest)
operation.- Parameters:
listPackageImportJobsRequest
-- 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackageImportJobsPaginator
default ListPackageImportJobsPublisher listPackageImportJobsPaginator(Consumer<ListPackageImportJobsRequest.Builder> listPackageImportJobsRequest) This is a variant of
listPackageImportJobs(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsRequest)
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.panorama.paginators.ListPackageImportJobsPublisher publisher = client.listPackageImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListPackageImportJobsPublisher publisher = client.listPackageImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListPackageImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsResponse 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
listPackageImportJobs(software.amazon.awssdk.services.panorama.model.ListPackageImportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListPackageImportJobsRequest.Builder
avoiding the need to create one manually viaListPackageImportJobsRequest.builder()
- Parameters:
listPackageImportJobsRequest
- AConsumer
that will call methods onListPackageImportJobsRequest.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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackages
default CompletableFuture<ListPackagesResponse> listPackages(ListPackagesRequest listPackagesRequest) Returns a list of packages.
- Parameters:
listPackagesRequest
-- Returns:
- A Java Future containing the result of the ListPackages 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackages
default CompletableFuture<ListPackagesResponse> listPackages(Consumer<ListPackagesRequest.Builder> listPackagesRequest) Returns a list of packages.
This is a convenience which creates an instance of the
ListPackagesRequest.Builder
avoiding the need to create one manually viaListPackagesRequest.builder()
- Parameters:
listPackagesRequest
- AConsumer
that will call methods onListPackagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackages 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackagesPaginator
This is a variant of
listPackages(software.amazon.awssdk.services.panorama.model.ListPackagesRequest)
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.panorama.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListPackagesResponse 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
listPackages(software.amazon.awssdk.services.panorama.model.ListPackagesRequest)
operation.- Parameters:
listPackagesRequest
-- 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPackagesPaginator
default ListPackagesPublisher listPackagesPaginator(Consumer<ListPackagesRequest.Builder> listPackagesRequest) This is a variant of
listPackages(software.amazon.awssdk.services.panorama.model.ListPackagesRequest)
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.panorama.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.panorama.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.panorama.model.ListPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.panorama.model.ListPackagesResponse 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
listPackages(software.amazon.awssdk.services.panorama.model.ListPackagesRequest)
operation.
This is a convenience which creates an instance of the
ListPackagesRequest.Builder
avoiding the need to create one manually viaListPackagesRequest.builder()
- Parameters:
listPackagesRequest
- AConsumer
that will call methods onListPackagesRequest.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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException 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) Returns a list of tags for a 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.- ValidationException The request contains an invalid parameter value.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException 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) Returns a list of tags for a 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.- ValidationException The request contains an invalid parameter value.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
provisionDevice
default CompletableFuture<ProvisionDeviceResponse> provisionDevice(ProvisionDeviceRequest provisionDeviceRequest) Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive
certificates-omni_device-name.zip
and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.- Parameters:
provisionDeviceRequest
-- Returns:
- A Java Future containing the result of the ProvisionDevice 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ServiceQuotaExceededException The request would cause a limit to be exceeded.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
provisionDevice
default CompletableFuture<ProvisionDeviceResponse> provisionDevice(Consumer<ProvisionDeviceRequest.Builder> provisionDeviceRequest) Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive
certificates-omni_device-name.zip
and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.
This is a convenience which creates an instance of the
ProvisionDeviceRequest.Builder
avoiding the need to create one manually viaProvisionDeviceRequest.builder()
- Parameters:
provisionDeviceRequest
- AConsumer
that will call methods onProvisionDeviceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ProvisionDevice 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ServiceQuotaExceededException The request would cause a limit to be exceeded.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerPackageVersion
default CompletableFuture<RegisterPackageVersionResponse> registerPackageVersion(RegisterPackageVersionRequest registerPackageVersionRequest) Registers a package version.
- Parameters:
registerPackageVersionRequest
-- Returns:
- A Java Future containing the result of the RegisterPackageVersion 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerPackageVersion
default CompletableFuture<RegisterPackageVersionResponse> registerPackageVersion(Consumer<RegisterPackageVersionRequest.Builder> registerPackageVersionRequest) Registers a package version.
This is a convenience which creates an instance of the
RegisterPackageVersionRequest.Builder
avoiding the need to create one manually viaRegisterPackageVersionRequest.builder()
- Parameters:
registerPackageVersionRequest
- AConsumer
that will call methods onRegisterPackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterPackageVersion 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeApplicationInstance
default CompletableFuture<RemoveApplicationInstanceResponse> removeApplicationInstance(RemoveApplicationInstanceRequest removeApplicationInstanceRequest) Removes an application instance.
- Parameters:
removeApplicationInstanceRequest
-- Returns:
- A Java Future containing the result of the RemoveApplicationInstance 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeApplicationInstance
default CompletableFuture<RemoveApplicationInstanceResponse> removeApplicationInstance(Consumer<RemoveApplicationInstanceRequest.Builder> removeApplicationInstanceRequest) Removes an application instance.
This is a convenience which creates an instance of the
RemoveApplicationInstanceRequest.Builder
avoiding the need to create one manually viaRemoveApplicationInstanceRequest.builder()
- Parameters:
removeApplicationInstanceRequest
- AConsumer
that will call methods onRemoveApplicationInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveApplicationInstance 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
signalApplicationInstanceNodeInstances
default CompletableFuture<SignalApplicationInstanceNodeInstancesResponse> signalApplicationInstanceNodeInstances(SignalApplicationInstanceNodeInstancesRequest signalApplicationInstanceNodeInstancesRequest) Signal camera nodes to stop or resume.
- Parameters:
signalApplicationInstanceNodeInstancesRequest
-- Returns:
- A Java Future containing the result of the SignalApplicationInstanceNodeInstances 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.- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ServiceQuotaExceededException The request would cause a limit to be exceeded.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
signalApplicationInstanceNodeInstances
default CompletableFuture<SignalApplicationInstanceNodeInstancesResponse> signalApplicationInstanceNodeInstances(Consumer<SignalApplicationInstanceNodeInstancesRequest.Builder> signalApplicationInstanceNodeInstancesRequest) Signal camera nodes to stop or resume.
This is a convenience which creates an instance of the
SignalApplicationInstanceNodeInstancesRequest.Builder
avoiding the need to create one manually viaSignalApplicationInstanceNodeInstancesRequest.builder()
- Parameters:
signalApplicationInstanceNodeInstancesRequest
- AConsumer
that will call methods onSignalApplicationInstanceNodeInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SignalApplicationInstanceNodeInstances 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.- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ServiceQuotaExceededException The request would cause a limit to be exceeded.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Tags a 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.- ValidationException The request contains an invalid parameter value.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException 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) Tags a 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.- ValidationException The request contains an invalid parameter value.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException 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 a 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.- ValidationException The request contains an invalid parameter value.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException 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 a 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.- ValidationException The request contains an invalid parameter value.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeviceMetadata
default CompletableFuture<UpdateDeviceMetadataResponse> updateDeviceMetadata(UpdateDeviceMetadataRequest updateDeviceMetadataRequest) Updates a device's metadata.
- Parameters:
updateDeviceMetadataRequest
-- Returns:
- A Java Future containing the result of the UpdateDeviceMetadata 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeviceMetadata
default CompletableFuture<UpdateDeviceMetadataResponse> updateDeviceMetadata(Consumer<UpdateDeviceMetadataRequest.Builder> updateDeviceMetadataRequest) Updates a device's metadata.
This is a convenience which creates an instance of the
UpdateDeviceMetadataRequest.Builder
avoiding the need to create one manually viaUpdateDeviceMetadataRequest.builder()
- Parameters:
updateDeviceMetadataRequest
- AConsumer
that will call methods onUpdateDeviceMetadataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDeviceMetadata 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.- ConflictException The target resource is in use.
- ValidationException The request contains an invalid parameter value.
- AccessDeniedException The requestor does not have permission to access the target action or resource.
- ResourceNotFoundException The target resource was not found.
- InternalServerException An internal error occurred.
- 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.
- PanoramaException 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 aPanoramaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPanoramaAsyncClient
.
-