Interface EventBridgeV2Waiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static EventBridgeV2Waiter.Builder	builder()	Create a builder that can be used to configure and create a EventBridgeV2Waiter.
static EventBridgeV2Waiter	create()	Create an instance of EventBridgeV2Waiter with the default configuration.
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusActive(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusActive(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusActive(DescribeEventBusRequest describeEventBusRequest)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusActive(DescribeEventBusRequest describeEventBusRequest, WaiterOverrideConfiguration overrideConfig)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusDeleted(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusDeleted(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusDeleted(DescribeEventBusRequest describeEventBusRequest)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEventBusResponse>	waitUntilEventBusDeleted(DescribeEventBusRequest describeEventBusRequest, WaiterOverrideConfiguration overrideConfig)	Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted 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 Details

waitUntilEventBusActive

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusActive(DescribeEventBusRequest describeEventBusRequest)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeEventBusRequest - the request to be used for polling

Returns:

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

waitUntilEventBusActive

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusActive(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive 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 DescribeEventBusRequest.builder()

Parameters:

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

waitUntilEventBusActive

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusActive(DescribeEventBusRequest describeEventBusRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilEventBusActive

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusActive(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusActive 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:

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

waitUntilEventBusDeleted

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusDeleted(DescribeEventBusRequest describeEventBusRequest)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeEventBusRequest - the request to be used for polling

Returns:

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

waitUntilEventBusDeleted

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusDeleted(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted 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 DescribeEventBusRequest.builder()

Parameters:

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

waitUntilEventBusDeleted

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusDeleted(DescribeEventBusRequest describeEventBusRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilEventBusDeleted

default WaiterResponse<DescribeEventBusResponse> waitUntilEventBusDeleted(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EventBridgeV2Client.describeEventBus(software.amazon.awssdk.services.eventbridgev2.model.DescribeEventBusRequest) API until the desired condition EventBusDeleted 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:

describeEventBusRequest - 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 EventBridgeV2Waiter.Builder builder()

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

Returns:

a builder

create

static EventBridgeV2Waiter create()

Create an instance of EventBridgeV2Waiter with the default configuration.

A default EventBridgeV2Client 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 EventBridgeV2Waiter