Interface ContinuumWaiter
- All Superinterfaces:
AutoCloseable,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
@Immutable
public interface ContinuumWaiter
extends 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
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ContinuumWaiter.Builderbuilder()Create a builder that can be used to configure and create aContinuumWaiter.static ContinuumWaitercreate()Create an instance ofContinuumWaiterwith the default configuration.default WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(Consumer<GetCodeScanRequest.Builder> getCodeScanRequest) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(Consumer<GetCodeScanRequest.Builder> getCodeScanRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(GetCodeScanRequest getCodeScanRequest) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(GetCodeScanRequest getCodeScanRequest, WaiterOverrideConfiguration overrideConfig) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis 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
-
waitUntilCodeScanSucceeded
default WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(GetCodeScanRequest getCodeScanRequest) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis met, or until it is determined that the resource will never enter into the desired state- Parameters:
getCodeScanRequest- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilCodeScanSucceeded
default WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(Consumer<GetCodeScanRequest.Builder> getCodeScanRequest) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis 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
GetCodeScanRequest.builder()- Parameters:
getCodeScanRequest- 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
-
waitUntilCodeScanSucceeded
default WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(GetCodeScanRequest getCodeScanRequest, WaiterOverrideConfiguration overrideConfig) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis met, or until it is determined that the resource will never enter into the desired state- Parameters:
getCodeScanRequest- 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
-
waitUntilCodeScanSucceeded
default WaiterResponse<GetCodeScanResponse> waitUntilCodeScanSucceeded(Consumer<GetCodeScanRequest.Builder> getCodeScanRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsContinuumClient.getCodeScan(software.amazon.awssdk.services.continuum.model.GetCodeScanRequest)API until the desired conditionCodeScanSucceededis 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:
getCodeScanRequest- 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 aContinuumWaiter.- Returns:
- a builder
-
create
Create an instance ofContinuumWaiterwith the default configuration.A default
ContinuumClientwill 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
ContinuumWaiter
-