Interface AcmWaiter
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
Waiter utility class that polls a resource until a desired state is reached or until it is determined that the
resource will never enter into the desired state. This can be created using the static
builder()
method-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AcmWaiter.Builder
builder()
Create a builder that can be used to configure and create aAcmWaiter
.static AcmWaiter
create()
Create an instance ofAcmWaiter
with the default configuration.waitUntilCertificateValidated
(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
is met, or until it is determined that the resource will never enter into the desired state.waitUntilCertificateValidated
(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
is met, or until it is determined that the resource will never enter into the desired state.waitUntilCertificateValidated
(DescribeCertificateRequest describeCertificateRequest) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
is met, or until it is determined that the resource will never enter into the desired statewaitUntilCertificateValidated
(DescribeCertificateRequest describeCertificateRequest, WaiterOverrideConfiguration overrideConfig) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
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
-
waitUntilCertificateValidated
default WaiterResponse<DescribeCertificateResponse> waitUntilCertificateValidated(DescribeCertificateRequest describeCertificateRequest) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeCertificateRequest
- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCertificateValidated
default WaiterResponse<DescribeCertificateResponse> waitUntilCertificateValidated(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
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
DescribeCertificateRequest.builder()
- Parameters:
describeCertificateRequest
- The consumer that will configure the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCertificateValidated
default WaiterResponse<DescribeCertificateResponse> waitUntilCertificateValidated(DescribeCertificateRequest describeCertificateRequest, WaiterOverrideConfiguration overrideConfig) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeCertificateRequest
- 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
-
waitUntilCertificateValidated
default WaiterResponse<DescribeCertificateResponse> waitUntilCertificateValidated(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsAcmClient.describeCertificate(software.amazon.awssdk.services.acm.model.DescribeCertificateRequest)
API until the desired conditionCertificateValidated
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:
describeCertificateRequest
- 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 aAcmWaiter
.- Returns:
- a builder
-
create
Create an instance ofAcmWaiter
with the default configuration.A default
AcmClient
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
AcmWaiter
-