Interface GroundStationWaiter
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface GroundStationWaiter
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
-
Method Summary
Modifier and TypeMethodDescriptionstatic GroundStationWaiter.Builder
builder()
Create a builder that can be used to configure and create aGroundStationWaiter
.static GroundStationWaiter
create()
Create an instance ofGroundStationWaiter
with the default configuration.default WaiterResponse
<DescribeContactResponse> waitUntilContactScheduled
(Consumer<DescribeContactRequest.Builder> describeContactRequest) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<DescribeContactResponse> waitUntilContactScheduled
(Consumer<DescribeContactRequest.Builder> describeContactRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<DescribeContactResponse> waitUntilContactScheduled
(DescribeContactRequest describeContactRequest) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<DescribeContactResponse> waitUntilContactScheduled
(DescribeContactRequest describeContactRequest, WaiterOverrideConfiguration overrideConfig) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
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
-
waitUntilContactScheduled
default WaiterResponse<DescribeContactResponse> waitUntilContactScheduled(DescribeContactRequest describeContactRequest) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeContactRequest
- the request to be used for polling- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilContactScheduled
default WaiterResponse<DescribeContactResponse> waitUntilContactScheduled(Consumer<DescribeContactRequest.Builder> describeContactRequest) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
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
DescribeContactRequest.builder()
- Parameters:
describeContactRequest
- 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
-
waitUntilContactScheduled
default WaiterResponse<DescribeContactResponse> waitUntilContactScheduled(DescribeContactRequest describeContactRequest, WaiterOverrideConfiguration overrideConfig) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeContactRequest
- 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
-
waitUntilContactScheduled
default WaiterResponse<DescribeContactResponse> waitUntilContactScheduled(Consumer<DescribeContactRequest.Builder> describeContactRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) PollsGroundStationClient.describeContact(software.amazon.awssdk.services.groundstation.model.DescribeContactRequest)
API until the desired conditionContactScheduled
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:
describeContactRequest
- 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 aGroundStationWaiter
.- Returns:
- a builder
-
create
Create an instance ofGroundStationWaiter
with the default configuration.A default
GroundStationClient
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
GroundStationWaiter
-