Interface CloudWatchAsyncWaiter
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
builder()
method-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aCloudWatchAsyncWaiter
.static CloudWatchAsyncWaiter
create()
Create an instance ofCloudWatchAsyncWaiter
with the default configuration.waitUntilAlarmExists
(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.waitUntilAlarmExists
(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.waitUntilAlarmExists
(DescribeAlarmsRequest describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired statewaitUntilAlarmExists
(DescribeAlarmsRequest describeAlarmsRequest, WaiterOverrideConfiguration overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired statewaitUntilCompositeAlarmExists
(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.waitUntilCompositeAlarmExists
(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.waitUntilCompositeAlarmExists
(DescribeAlarmsRequest describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired statewaitUntilCompositeAlarmExists
(DescribeAlarmsRequest describeAlarmsRequest, WaiterOverrideConfiguration overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired stateMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Method Details
-
waitUntilAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilAlarmExists(DescribeAlarmsRequest describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAlarmsRequest
- the request to be used for polling- Returns:
- CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.
-
waitUntilAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilAlarmExists(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder without the need to create one manually using
DescribeAlarmsRequest.builder()
- Parameters:
describeAlarmsRequest
- The consumer that will configure the request to be used for polling- Returns:
- CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilAlarmExists(DescribeAlarmsRequest describeAlarmsRequest, WaiterOverrideConfiguration overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAlarmsRequest
- The request to be used for pollingoverrideConfig
- Per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilAlarmExists(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder and instance of the override config builder
- Parameters:
describeAlarmsRequest
- The consumer that will configure the request to be used for pollingoverrideConfig
- The consumer that will configure the per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCompositeAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilCompositeAlarmExists(DescribeAlarmsRequest describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAlarmsRequest
- the request to be used for polling- Returns:
- CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.
-
waitUntilCompositeAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilCompositeAlarmExists(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder without the need to create one manually using
DescribeAlarmsRequest.builder()
- Parameters:
describeAlarmsRequest
- The consumer that will configure the request to be used for polling- Returns:
- CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCompositeAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilCompositeAlarmExists(DescribeAlarmsRequest describeAlarmsRequest, WaiterOverrideConfiguration overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAlarmsRequest
- The request to be used for pollingoverrideConfig
- Per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCompositeAlarmExists
default CompletableFuture<WaiterResponse<DescribeAlarmsResponse>> waitUntilCompositeAlarmExists(Consumer<DescribeAlarmsRequest.Builder> describeAlarmsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsCloudWatchAsyncClient.describeAlarms(software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest)
API until the desired conditionCompositeAlarmExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder and instance of the override config builder
- Parameters:
describeAlarmsRequest
- The consumer that will configure the request to be used for pollingoverrideConfig
- The consumer that will configure the per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
builder
Create a builder that can be used to configure and create aCloudWatchAsyncWaiter
.- Returns:
- a builder
-
create
Create an instance ofCloudWatchAsyncWaiter
with the default configuration.A default
CloudWatchAsyncClient
will be created to poll resources. It is recommended to share a single instance of the waiter created via this method. If it is not desirable to share a waiter instance, invokeSdkAutoCloseable.close()
to release the resources once the waiter is not needed.- Returns:
- an instance of
CloudWatchAsyncWaiter
-