Package software.amazon.awssdk.services.transfer.waiters

Interface TransferWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface TransferWaiter
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

Modifier and Type	Interface	Description
static interface	TransferWaiter.Builder

Method Summary

Modifier and Type	Method	Description
static TransferWaiter.Builder	builder()	Create a builder that can be used to configure and create a TransferWaiter.
static TransferWaiter	create()	Create an instance of TransferWaiter with the default configuration.
default WaiterResponse<DescribeServerResponse>	waitUntilServerOffline(Consumer<DescribeServerRequest.Builder> describeServerRequest)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeServerResponse>	waitUntilServerOffline(Consumer<DescribeServerRequest.Builder> describeServerRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeServerResponse>	waitUntilServerOffline(DescribeServerRequest describeServerRequest)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeServerResponse>	waitUntilServerOffline(DescribeServerRequest describeServerRequest, WaiterOverrideConfiguration overrideConfig)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeServerResponse>	waitUntilServerOnline(Consumer<DescribeServerRequest.Builder> describeServerRequest)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeServerResponse>	waitUntilServerOnline(Consumer<DescribeServerRequest.Builder> describeServerRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeServerResponse>	waitUntilServerOnline(DescribeServerRequest describeServerRequest)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeServerResponse>	waitUntilServerOnline(DescribeServerRequest describeServerRequest, WaiterOverrideConfiguration overrideConfig)	Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline is met, or until it is determined that the resource will never enter into the desired state

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Method Detail

waitUntilServerOffline

default WaiterResponse<DescribeServerResponse> waitUntilServerOffline(DescribeServerRequest describeServerRequest)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeServerRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilServerOffline

default WaiterResponse<DescribeServerResponse> waitUntilServerOffline(Consumer<DescribeServerRequest.Builder> describeServerRequest)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline 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 DescribeServerRequest.builder()

Parameters:

describeServerRequest - 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

waitUntilServerOffline

default WaiterResponse<DescribeServerResponse> waitUntilServerOffline(DescribeServerRequest describeServerRequest,
                                                                      WaiterOverrideConfiguration overrideConfig)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeServerRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilServerOffline

default WaiterResponse<DescribeServerResponse> waitUntilServerOffline(Consumer<DescribeServerRequest.Builder> describeServerRequest,
                                                                      Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOffline 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:

describeServerRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

waitUntilServerOnline

default WaiterResponse<DescribeServerResponse> waitUntilServerOnline(DescribeServerRequest describeServerRequest)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeServerRequest - the request to be used for polling

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilServerOnline

default WaiterResponse<DescribeServerResponse> waitUntilServerOnline(Consumer<DescribeServerRequest.Builder> describeServerRequest)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline 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 DescribeServerRequest.builder()

Parameters:

describeServerRequest - 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

waitUntilServerOnline

default WaiterResponse<DescribeServerResponse> waitUntilServerOnline(DescribeServerRequest describeServerRequest,
                                                                     WaiterOverrideConfiguration overrideConfig)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeServerRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilServerOnline

default WaiterResponse<DescribeServerResponse> waitUntilServerOnline(Consumer<DescribeServerRequest.Builder> describeServerRequest,
                                                                     Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls TransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest) API until the desired condition ServerOnline 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:

describeServerRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

static TransferWaiter.Builder builder()

Create a builder that can be used to configure and create a TransferWaiter.

Returns:

a builder

create

static TransferWaiter create()

Create an instance of TransferWaiter with the default configuration.

A default TransferClient 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, invoke SdkAutoCloseable.close() to release the resources once the waiter is not needed.

Returns:

an instance of TransferWaiter