Package software.amazon.awssdk.services.ecr.waiters

Interface EcrWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static EcrWaiter.Builder	builder()	Create a builder that can be used to configure and create a EcrWaiter.
static EcrWaiter	create()	Create an instance of EcrWaiter with the default configuration.
default WaiterResponse<DescribeImageScanFindingsResponse>	waitUntilImageScanComplete(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest)	Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeImageScanFindingsResponse>	waitUntilImageScanComplete(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeImageScanFindingsResponse>	waitUntilImageScanComplete(DescribeImageScanFindingsRequest describeImageScanFindingsRequest)	Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeImageScanFindingsResponse>	waitUntilImageScanComplete(DescribeImageScanFindingsRequest describeImageScanFindingsRequest, WaiterOverrideConfiguration overrideConfig)	Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetLifecyclePolicyPreviewResponse>	waitUntilLifecyclePolicyPreviewComplete(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest)	Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetLifecyclePolicyPreviewResponse>	waitUntilLifecyclePolicyPreviewComplete(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetLifecyclePolicyPreviewResponse>	waitUntilLifecyclePolicyPreviewComplete(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)	Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetLifecyclePolicyPreviewResponse>	waitUntilLifecyclePolicyPreviewComplete(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest, WaiterOverrideConfiguration overrideConfig)	Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete 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

waitUntilImageScanComplete

default WaiterResponse<DescribeImageScanFindingsResponse> waitUntilImageScanComplete(DescribeImageScanFindingsRequest describeImageScanFindingsRequest)

Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeImageScanFindingsRequest - the request to be used for polling

Returns:

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

waitUntilImageScanComplete

default WaiterResponse<DescribeImageScanFindingsResponse> waitUntilImageScanComplete(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest)

Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete 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 DescribeImageScanFindingsRequest.builder()

Parameters:

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

waitUntilImageScanComplete

default WaiterResponse<DescribeImageScanFindingsResponse> waitUntilImageScanComplete(DescribeImageScanFindingsRequest describeImageScanFindingsRequest,
                                                                                     WaiterOverrideConfiguration overrideConfig)

Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilImageScanComplete

default WaiterResponse<DescribeImageScanFindingsResponse> waitUntilImageScanComplete(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest,
                                                                                     Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EcrClient.describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest) API until the desired condition ImageScanComplete 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:

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

waitUntilLifecyclePolicyPreviewComplete

default WaiterResponse<GetLifecyclePolicyPreviewResponse> waitUntilLifecyclePolicyPreviewComplete(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)

Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getLifecyclePolicyPreviewRequest - the request to be used for polling

Returns:

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

waitUntilLifecyclePolicyPreviewComplete

default WaiterResponse<GetLifecyclePolicyPreviewResponse> waitUntilLifecyclePolicyPreviewComplete(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest)

Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete 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 GetLifecyclePolicyPreviewRequest.builder()

Parameters:

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

waitUntilLifecyclePolicyPreviewComplete

default WaiterResponse<GetLifecyclePolicyPreviewResponse> waitUntilLifecyclePolicyPreviewComplete(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest,
                                                                                                  WaiterOverrideConfiguration overrideConfig)

Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilLifecyclePolicyPreviewComplete

default WaiterResponse<GetLifecyclePolicyPreviewResponse> waitUntilLifecyclePolicyPreviewComplete(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest,
                                                                                                  Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EcrClient.getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest) API until the desired condition LifecyclePolicyPreviewComplete 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:

getLifecyclePolicyPreviewRequest - 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 EcrWaiter.Builder builder()

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

Returns:

a builder

create

static EcrWaiter create()

Create an instance of EcrWaiter with the default configuration.

A default EcrClient 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 EcrWaiter