software.amazon.awssdk.services.kinesis.waiters

Interface KinesisAsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated(value="software.amazon.awssdk:codegen")
public interface KinesisAsyncWaiter
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 and Description
static interface	KinesisAsyncWaiter.Builder

Method Summary

Modifier and Type	Method and Description
static KinesisAsyncWaiter.Builder	builder() Create a builder that can be used to configure and create a KinesisAsyncWaiter.
static KinesisAsyncWaiter	create() Create an instance of KinesisAsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamExists(DescribeStreamRequest describeStreamRequest) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamExists(DescribeStreamRequest describeStreamRequest, WaiterOverrideConfiguration overrideConfig) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamNotExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamNotExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamNotExists(DescribeStreamRequest describeStreamRequest) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeStreamResponse>>	waitUntilStreamNotExists(DescribeStreamRequest describeStreamRequest, WaiterOverrideConfiguration overrideConfig) Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists 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

waitUntilStreamExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamExists(DescribeStreamRequest describeStreamRequest)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStreamRequest - the request to be used for polling

Returns:

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.

waitUntilStreamExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists 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 DescribeStreamRequest.builder()

Parameters:

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

Returns:

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

waitUntilStreamExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamExists(DescribeStreamRequest describeStreamRequest,
                                                                                        WaiterOverrideConfiguration overrideConfig)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilStreamExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest,
                                                                                        Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamExists 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:

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

waitUntilStreamNotExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamNotExists(DescribeStreamRequest describeStreamRequest)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeStreamRequest - the request to be used for polling

Returns:

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.

waitUntilStreamNotExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamNotExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists 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 DescribeStreamRequest.builder()

Parameters:

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

Returns:

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

waitUntilStreamNotExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamNotExists(DescribeStreamRequest describeStreamRequest,
                                                                                           WaiterOverrideConfiguration overrideConfig)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilStreamNotExists

default CompletableFuture<WaiterResponse<DescribeStreamResponse>> waitUntilStreamNotExists(Consumer<DescribeStreamRequest.Builder> describeStreamRequest,
                                                                                           Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls KinesisAsyncClient.describeStream(software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest) API until the desired condition StreamNotExists 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:

describeStreamRequest - 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 KinesisAsyncWaiter.Builder builder()

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

Returns:

a builder

create

static KinesisAsyncWaiter create()

Create an instance of KinesisAsyncWaiter with the default configuration.

A default KinesisAsyncClient 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 KinesisAsyncWaiter