Interface TransferWaiter
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
builder()
method-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TransferWaiter.Builder
builder()
Create a builder that can be used to configure and create aTransferWaiter
.static TransferWaiter
create()
Create an instance ofTransferWaiter
with the default configuration.default WaiterResponse
<DescribeServerResponse> waitUntilServerOffline
(Consumer<DescribeServerRequest.Builder> describeServerRequest) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<DescribeServerResponse> waitUntilServerOffline
(DescribeServerRequest describeServerRequest) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<DescribeServerResponse> waitUntilServerOffline
(DescribeServerRequest describeServerRequest, WaiterOverrideConfiguration overrideConfig) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<DescribeServerResponse> waitUntilServerOnline
(Consumer<DescribeServerRequest.Builder> describeServerRequest) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<DescribeServerResponse> waitUntilServerOnline
(DescribeServerRequest describeServerRequest) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<DescribeServerResponse> waitUntilServerOnline
(DescribeServerRequest describeServerRequest, WaiterOverrideConfiguration overrideConfig) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
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
-
waitUntilServerOffline
default WaiterResponse<DescribeServerResponse> waitUntilServerOffline(DescribeServerRequest describeServerRequest) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
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 pollingoverrideConfig
- 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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOffline
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 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
-
waitUntilServerOnline
default WaiterResponse<DescribeServerResponse> waitUntilServerOnline(DescribeServerRequest describeServerRequest) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
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 pollingoverrideConfig
- 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) PollsTransferClient.describeServer(software.amazon.awssdk.services.transfer.model.DescribeServerRequest)
API until the desired conditionServerOnline
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 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 aTransferWaiter
.- Returns:
- a builder
-
create
Create an instance ofTransferWaiter
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, invokeSdkAutoCloseable.close()
to release the resources once the waiter is not needed.- Returns:
- an instance of
TransferWaiter
-