software.amazon.awssdk.services.transfer.waiters.TransferAsyncWaiter Maven / Gradle / Ivy
Show all versions of transfer Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.transfer.waiters;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ScheduledExecutorService;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.Immutable;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.waiters.WaiterOverrideConfiguration;
import software.amazon.awssdk.core.waiters.WaiterResponse;
import software.amazon.awssdk.services.transfer.TransferAsyncClient;
import software.amazon.awssdk.services.transfer.model.DescribeServerRequest;
import software.amazon.awssdk.services.transfer.model.DescribeServerResponse;
import software.amazon.awssdk.utils.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 {@link #builder()} method
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
@Immutable
public interface TransferAsyncWaiter extends SdkAutoCloseable {
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code ServerOffline} is met, or
* until it is determined that the resource will never enter into the desired state
*
* @param describeServerRequest
* the request to be used for polling
* @return CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into
* a desired state or exceptionally when it is determined that the resource will never enter into the
* desired state.
*/
default CompletableFuture> waitUntilServerOffline(
DescribeServerRequest describeServerRequest) {
throw new UnsupportedOperationException();
}
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code 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 {@link DescribeServerRequest#builder()}
*
* @param describeServerRequest
* The consumer that will configure the request to be used for polling
* @return CompletableFuture of the WaiterResponse containing either a response or an exception that has matched
* with the waiter success condition
*/
default CompletableFuture> waitUntilServerOffline(
Consumer describeServerRequest) {
return waitUntilServerOffline(DescribeServerRequest.builder().applyMutation(describeServerRequest).build());
}
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code ServerOffline} is met, or
* until it is determined that the resource will never enter into the desired state
*
* @param describeServerRequest
* The request to be used for polling
* @param overrideConfig
* Per request override configuration for waiters
* @return WaiterResponse containing either a response or an exception that has matched with the waiter success
* condition
*/
default CompletableFuture> waitUntilServerOffline(
DescribeServerRequest describeServerRequest, WaiterOverrideConfiguration overrideConfig) {
throw new UnsupportedOperationException();
}
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code 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
*
* @param describeServerRequest
* The consumer that will configure the request to be used for polling
* @param overrideConfig
* The consumer that will configure the per request override configuration for waiters
* @return WaiterResponse containing either a response or an exception that has matched with the waiter success
* condition
*/
default CompletableFuture> waitUntilServerOffline(
Consumer describeServerRequest,
Consumer overrideConfig) {
return waitUntilServerOffline(DescribeServerRequest.builder().applyMutation(describeServerRequest).build(),
WaiterOverrideConfiguration.builder().applyMutation(overrideConfig).build());
}
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code ServerOnline} is met, or
* until it is determined that the resource will never enter into the desired state
*
* @param describeServerRequest
* the request to be used for polling
* @return CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into
* a desired state or exceptionally when it is determined that the resource will never enter into the
* desired state.
*/
default CompletableFuture> waitUntilServerOnline(
DescribeServerRequest describeServerRequest) {
throw new UnsupportedOperationException();
}
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code 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 {@link DescribeServerRequest#builder()}
*
* @param describeServerRequest
* The consumer that will configure the request to be used for polling
* @return CompletableFuture of the WaiterResponse containing either a response or an exception that has matched
* with the waiter success condition
*/
default CompletableFuture> waitUntilServerOnline(
Consumer describeServerRequest) {
return waitUntilServerOnline(DescribeServerRequest.builder().applyMutation(describeServerRequest).build());
}
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code ServerOnline} is met, or
* until it is determined that the resource will never enter into the desired state
*
* @param describeServerRequest
* The request to be used for polling
* @param overrideConfig
* Per request override configuration for waiters
* @return WaiterResponse containing either a response or an exception that has matched with the waiter success
* condition
*/
default CompletableFuture> waitUntilServerOnline(
DescribeServerRequest describeServerRequest, WaiterOverrideConfiguration overrideConfig) {
throw new UnsupportedOperationException();
}
/**
* Polls {@link TransferAsyncClient#describeServer} API until the desired condition {@code 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
*
* @param describeServerRequest
* The consumer that will configure the request to be used for polling
* @param overrideConfig
* The consumer that will configure the per request override configuration for waiters
* @return WaiterResponse containing either a response or an exception that has matched with the waiter success
* condition
*/
default CompletableFuture> waitUntilServerOnline(
Consumer describeServerRequest,
Consumer overrideConfig) {
return waitUntilServerOnline(DescribeServerRequest.builder().applyMutation(describeServerRequest).build(),
WaiterOverrideConfiguration.builder().applyMutation(overrideConfig).build());
}
/**
* Create a builder that can be used to configure and create a {@link TransferAsyncWaiter}.
*
* @return a builder
*/
static Builder builder() {
return DefaultTransferAsyncWaiter.builder();
}
/**
* Create an instance of {@link TransferAsyncWaiter} with the default configuration.
*
* A default {@link TransferAsyncClient} 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
* {@link #close()} to release the resources once the waiter is not needed.
*
* @return an instance of {@link TransferAsyncWaiter}
*/
static TransferAsyncWaiter create() {
return DefaultTransferAsyncWaiter.builder().build();
}
interface Builder {
/**
* Sets a custom {@link ScheduledExecutorService} that will be used to schedule async polling attempts
*
* This executorService must be closed by the caller when it is ready to be disposed. The SDK will not close the
* executorService when the waiter is closed
*
* @param executorService
* the executorService to set
* @return a reference to this object so that method calls can be chained together.
*/
Builder scheduledExecutorService(ScheduledExecutorService executorService);
/**
* Defines overrides to the default SDK waiter configuration that should be used for waiters created from this
* builder
*
* @param overrideConfiguration
* the override configuration to set
* @return a reference to this object so that method calls can be chained together.
*/
Builder overrideConfiguration(WaiterOverrideConfiguration overrideConfiguration);
/**
* This is a convenient method to pass the override configuration without the need to create an instance
* manually via {@link WaiterOverrideConfiguration#builder()}
*
* @param overrideConfiguration
* The consumer that will configure the overrideConfiguration
* @return a reference to this object so that method calls can be chained together.
* @see #overrideConfiguration(WaiterOverrideConfiguration)
*/
default Builder overrideConfiguration(Consumer overrideConfiguration) {
WaiterOverrideConfiguration.Builder builder = WaiterOverrideConfiguration.builder();
overrideConfiguration.accept(builder);
return overrideConfiguration(builder.build());
}
/**
* Sets a custom {@link TransferAsyncClient} that will be used to poll the resource
*
* This SDK client must be closed by the caller when it is ready to be disposed. The SDK will not close the
* client when the waiter is closed
*
* @param client
* the client to send the request
* @return a reference to this object so that method calls can be chained together.
*/
Builder client(TransferAsyncClient client);
/**
* Builds an instance of {@link TransferAsyncWaiter} based on the configurations supplied to this builder
*
* @return An initialized {@link TransferAsyncWaiter}
*/
TransferAsyncWaiter build();
}
}