@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SnowDeviceManagementAsyncClient extends AwsClient
builder() method.
Amazon Web Services Snow Device Management documentation.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SnowDeviceManagementAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SnowDeviceManagementAsyncClient. |
default CompletableFuture<CancelTaskResponse> |
cancelTask(CancelTaskRequest cancelTaskRequest)
Sends a cancel request for a specified task.
|
default CompletableFuture<CancelTaskResponse> |
cancelTask(Consumer<CancelTaskRequest.Builder> cancelTaskRequest)
Sends a cancel request for a specified task.
|
static SnowDeviceManagementAsyncClient |
create()
Create a
SnowDeviceManagementAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateTaskResponse> |
createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Instructs one or more devices to start a task, such as unlocking or rebooting.
|
default CompletableFuture<CreateTaskResponse> |
createTask(CreateTaskRequest createTaskRequest)
Instructs one or more devices to start a task, such as unlocking or rebooting.
|
default CompletableFuture<DescribeDeviceResponse> |
describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
|
default CompletableFuture<DescribeDeviceResponse> |
describeDevice(DescribeDeviceRequest describeDeviceRequest)
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
|
default CompletableFuture<DescribeDeviceEc2InstancesResponse> |
describeDeviceEc2Instances(Consumer<DescribeDeviceEc2InstancesRequest.Builder> describeDeviceEc2InstancesRequest)
Checks the current state of the Amazon EC2 instances.
|
default CompletableFuture<DescribeDeviceEc2InstancesResponse> |
describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest)
Checks the current state of the Amazon EC2 instances.
|
default CompletableFuture<DescribeExecutionResponse> |
describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
Checks the status of a remote task running on one or more target devices.
|
default CompletableFuture<DescribeExecutionResponse> |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
Checks the status of a remote task running on one or more target devices.
|
default CompletableFuture<DescribeTaskResponse> |
describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Checks the metadata for a given task on a device.
|
default CompletableFuture<DescribeTaskResponse> |
describeTask(DescribeTaskRequest describeTaskRequest)
Checks the metadata for a given task on a device.
|
default CompletableFuture<ListDeviceResourcesResponse> |
listDeviceResources(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default CompletableFuture<ListDeviceResourcesResponse> |
listDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default ListDeviceResourcesPublisher |
listDeviceResourcesPaginator(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default ListDeviceResourcesPublisher |
listDeviceResourcesPaginator(ListDeviceResourcesRequest listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device.
|
default CompletableFuture<ListDevicesResponse> |
listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device
Management enabled in the Amazon Web Services Region where the command is run.
|
default CompletableFuture<ListDevicesResponse> |
listDevices(ListDevicesRequest listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device
Management enabled in the Amazon Web Services Region where the command is run.
|
default ListDevicesPublisher |
listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device
Management enabled in the Amazon Web Services Region where the command is run.
|
default ListDevicesPublisher |
listDevicesPaginator(ListDevicesRequest listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device
Management enabled in the Amazon Web Services Region where the command is run.
|
default CompletableFuture<ListExecutionsResponse> |
listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default CompletableFuture<ListExecutionsResponse> |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default ListExecutionsPublisher |
listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default ListExecutionsPublisher |
listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Returns the status of tasks for one or more target devices.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags for a managed device or task.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a managed device or task.
|
default CompletableFuture<ListTasksResponse> |
listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default CompletableFuture<ListTasksResponse> |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default ListTasksPublisher |
listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default ListTasksPublisher |
listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of tasks that can be filtered by state.
|
default SnowDeviceManagementServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or replaces tags on a device or task.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds or replaces tags on a device or task.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from a device or task.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a device or task.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CancelTaskResponse> cancelTask(CancelTaskRequest cancelTaskRequest)
Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED
state. Tasks that are already running can't be cancelled.
A task might still run if it's processed from the queue before the CancelTask operation changes the
task's state.
cancelTaskRequest - default CompletableFuture<CancelTaskResponse> cancelTask(Consumer<CancelTaskRequest.Builder> cancelTaskRequest)
Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED
state. Tasks that are already running can't be cancelled.
A task might still run if it's processed from the queue before the CancelTask operation changes the
task's state.
This is a convenience which creates an instance of the CancelTaskRequest.Builder avoiding the need to
create one manually via CancelTaskRequest.builder()
cancelTaskRequest - A Consumer that will call methods on CancelTaskInput.Builder to create a request.default CompletableFuture<CreateTaskResponse> createTask(CreateTaskRequest createTaskRequest)
Instructs one or more devices to start a task, such as unlocking or rebooting.
createTaskRequest - default CompletableFuture<CreateTaskResponse> createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Instructs one or more devices to start a task, such as unlocking or rebooting.
This is a convenience which creates an instance of the CreateTaskRequest.Builder avoiding the need to
create one manually via CreateTaskRequest.builder()
createTaskRequest - A Consumer that will call methods on CreateTaskInput.Builder to create a request.default CompletableFuture<DescribeDeviceResponse> describeDevice(DescribeDeviceRequest describeDeviceRequest)
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
describeDeviceRequest - default CompletableFuture<DescribeDeviceResponse> describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
This is a convenience which creates an instance of the DescribeDeviceRequest.Builder avoiding the need to
create one manually via DescribeDeviceRequest.builder()
describeDeviceRequest - A Consumer that will call methods on DescribeDeviceInput.Builder to create a request.default CompletableFuture<DescribeDeviceEc2InstancesResponse> describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest)
Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but
the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the
available fields.
describeDeviceEc2InstancesRequest - default CompletableFuture<DescribeDeviceEc2InstancesResponse> describeDeviceEc2Instances(Consumer<DescribeDeviceEc2InstancesRequest.Builder> describeDeviceEc2InstancesRequest)
Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but
the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the
available fields.
This is a convenience which creates an instance of the DescribeDeviceEc2InstancesRequest.Builder avoiding
the need to create one manually via DescribeDeviceEc2InstancesRequest.builder()
describeDeviceEc2InstancesRequest - A Consumer that will call methods on DescribeDeviceEc2Input.Builder to create a request.default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)
Checks the status of a remote task running on one or more target devices.
describeExecutionRequest - default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
Checks the status of a remote task running on one or more target devices.
This is a convenience which creates an instance of the DescribeExecutionRequest.Builder avoiding the need
to create one manually via DescribeExecutionRequest.builder()
describeExecutionRequest - A Consumer that will call methods on DescribeExecutionInput.Builder to create a request.default CompletableFuture<DescribeTaskResponse> describeTask(DescribeTaskRequest describeTaskRequest)
Checks the metadata for a given task on a device.
describeTaskRequest - default CompletableFuture<DescribeTaskResponse> describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Checks the metadata for a given task on a device.
This is a convenience which creates an instance of the DescribeTaskRequest.Builder avoiding the need to
create one manually via DescribeTaskRequest.builder()
describeTaskRequest - A Consumer that will call methods on DescribeTaskInput.Builder to create a request.default CompletableFuture<ListDeviceResourcesResponse> listDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
listDeviceResourcesRequest - default CompletableFuture<ListDeviceResourcesResponse> listDeviceResources(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
This is a convenience which creates an instance of the ListDeviceResourcesRequest.Builder avoiding the
need to create one manually via ListDeviceResourcesRequest.builder()
listDeviceResourcesRequest - A Consumer that will call methods on ListDeviceResourcesInput.Builder to create a request.default ListDeviceResourcesPublisher listDeviceResourcesPaginator(ListDeviceResourcesRequest listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
This is a variant of
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesPublisher publisher = client.listDeviceResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesPublisher publisher = client.listDeviceResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)
operation.
listDeviceResourcesRequest - default ListDeviceResourcesPublisher listDeviceResourcesPaginator(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)
Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
This is a variant of
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesPublisher publisher = client.listDeviceResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDeviceResourcesPublisher publisher = client.listDeviceResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeviceResources(software.amazon.awssdk.services.snowdevicemanagement.model.ListDeviceResourcesRequest)
operation.
This is a convenience which creates an instance of the ListDeviceResourcesRequest.Builder avoiding the
need to create one manually via ListDeviceResourcesRequest.builder()
listDeviceResourcesRequest - A Consumer that will call methods on ListDeviceResourcesInput.Builder to create a request.default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
listDevicesRequest - default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
This is a convenience which creates an instance of the ListDevicesRequest.Builder avoiding the need to
create one manually via ListDevicesRequest.builder()
listDevicesRequest - A Consumer that will call methods on ListDevicesInput.Builder to create a request.default ListDevicesPublisher listDevicesPaginator(ListDevicesRequest listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
This is a variant of
listDevices(software.amazon.awssdk.services.snowdevicemanagement.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 new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)
operation.
listDevicesRequest - default ListDevicesPublisher listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest)
Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
This is a variant of
listDevices(software.amazon.awssdk.services.snowdevicemanagement.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 new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListDevicesPublisher publisher = client.listDevicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevices(software.amazon.awssdk.services.snowdevicemanagement.model.ListDevicesRequest)
operation.
This is a convenience which creates an instance of the ListDevicesRequest.Builder avoiding the need to
create one manually via ListDevicesRequest.builder()
listDevicesRequest - A Consumer that will call methods on ListDevicesInput.Builder to create a request.default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)
Returns the status of tasks for one or more target devices.
listExecutionsRequest - default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Returns the status of tasks for one or more target devices.
This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Returns the status of tasks for one or more target devices.
This is a variant of
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)
operation.
listExecutionsRequest - default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Returns the status of tasks for one or more target devices.
This is a variant of
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.snowdevicemanagement.model.ListExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a managed device or task.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags for a managed device or task.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.default CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)
Returns a list of tasks that can be filtered by state.
listTasksRequest - default CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks that can be filtered by state.
This is a convenience which creates an instance of the ListTasksRequest.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on ListTasksInput.Builder to create a request.default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of tasks that can be filtered by state.
This is a variant of
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest) operation.
listTasksRequest - default ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks that can be filtered by state.
This is a variant of
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.snowdevicemanagement.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.snowdevicemanagement.model.ListTasksRequest) operation.
This is a convenience which creates an instance of the ListTasksRequest.Builder avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest - A Consumer that will call methods on ListTasksInput.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds or replaces tags on a device or task.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or replaces tags on a device or task.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a device or task.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from a device or task.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.default SnowDeviceManagementServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic SnowDeviceManagementAsyncClient create()
SnowDeviceManagementAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SnowDeviceManagementAsyncClientBuilder builder()
SnowDeviceManagementAsyncClient.Copyright © 2023. All rights reserved.