Interface B2BiWaiter
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface B2BiWaiter
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 B2BiWaiter.Builder
builder()
Create a builder that can be used to configure and create aB2BiWaiter
.static B2BiWaiter
create()
Create an instance ofB2BiWaiter
with the default configuration.default WaiterResponse
<GetTransformerJobResponse> waitUntilTransformerJobSucceeded
(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<GetTransformerJobResponse> waitUntilTransformerJobSucceeded
(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<GetTransformerJobResponse> waitUntilTransformerJobSucceeded
(GetTransformerJobRequest getTransformerJobRequest) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<GetTransformerJobResponse> waitUntilTransformerJobSucceeded
(GetTransformerJobRequest getTransformerJobRequest, WaiterOverrideConfiguration overrideConfig) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
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
-
waitUntilTransformerJobSucceeded
default WaiterResponse<GetTransformerJobResponse> waitUntilTransformerJobSucceeded(GetTransformerJobRequest getTransformerJobRequest) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
getTransformerJobRequest
- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilTransformerJobSucceeded
default WaiterResponse<GetTransformerJobResponse> waitUntilTransformerJobSucceeded(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
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
GetTransformerJobRequest.builder()
- Parameters:
getTransformerJobRequest
- 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
-
waitUntilTransformerJobSucceeded
default WaiterResponse<GetTransformerJobResponse> waitUntilTransformerJobSucceeded(GetTransformerJobRequest getTransformerJobRequest, WaiterOverrideConfiguration overrideConfig) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
getTransformerJobRequest
- 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
-
waitUntilTransformerJobSucceeded
default WaiterResponse<GetTransformerJobResponse> waitUntilTransformerJobSucceeded(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsB2BiClient.getTransformerJob(software.amazon.awssdk.services.b2bi.model.GetTransformerJobRequest)
API until the desired conditionTransformerJobSucceeded
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:
getTransformerJobRequest
- 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 aB2BiWaiter
.- Returns:
- a builder
-
create
Create an instance ofB2BiWaiter
with the default configuration.A default
B2BiClient
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
B2BiWaiter
-