software.amazon.awssdk.services.ecr.model

Interface DescribeImagesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>, EcrRequest.Builder, SdkBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeImagesRequest

public static interface DescribeImagesRequest.Builder
extends EcrRequest.Builder, SdkPojo, CopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

Method Summary

Modifier and Type	Method and Description
default DescribeImagesRequest.Builder	filter(Consumer<DescribeImagesFilter.Builder> filter) The filter key and value with which to filter your DescribeImages results.
DescribeImagesRequest.Builder	filter(DescribeImagesFilter filter) The filter key and value with which to filter your DescribeImages results.
DescribeImagesRequest.Builder	imageIds(Collection<ImageIdentifier> imageIds) The list of image IDs for the requested repository.
DescribeImagesRequest.Builder	imageIds(Consumer<ImageIdentifier.Builder>... imageIds) The list of image IDs for the requested repository.
DescribeImagesRequest.Builder	imageIds(ImageIdentifier... imageIds) The list of image IDs for the requested repository.
DescribeImagesRequest.Builder	maxResults(Integer maxResults) The maximum number of repository results returned by DescribeImages in paginated output.
DescribeImagesRequest.Builder	nextToken(String nextToken) The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter.
DescribeImagesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeImagesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeImagesRequest.Builder	registryId(String registryId) The Amazon Web Services account ID associated with the registry that contains the repository in which to describe images.
DescribeImagesRequest.Builder	repositoryName(String repositoryName) The repository that contains the images to describe.

Methods inherited from interface software.amazon.awssdk.services.ecr.model.EcrRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

registryId

DescribeImagesRequest.Builder registryId(String registryId)

The Amazon Web Services account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

Parameters:

registryId - The Amazon Web Services account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

Returns:

Returns a reference to this object so that method calls can be chained together.

repositoryName

DescribeImagesRequest.Builder repositoryName(String repositoryName)

The repository that contains the images to describe.

Parameters:

repositoryName - The repository that contains the images to describe.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageIds

DescribeImagesRequest.Builder imageIds(Collection<ImageIdentifier> imageIds)

The list of image IDs for the requested repository.

Parameters:

imageIds - The list of image IDs for the requested repository.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageIds

DescribeImagesRequest.Builder imageIds(ImageIdentifier... imageIds)

The list of image IDs for the requested repository.

Parameters:

imageIds - The list of image IDs for the requested repository.

Returns:

Returns a reference to this object so that method calls can be chained together.

imageIds

DescribeImagesRequest.Builder imageIds(Consumer<ImageIdentifier.Builder>... imageIds)

The list of image IDs for the requested repository.

This is a convenience method that creates an instance of the ImageIdentifier.Builder avoiding the need to create one manually via ImageIdentifier.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #imageIds(List).

Parameters:

imageIds - a consumer that will call methods on ImageIdentifier.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#imageIds(java.util.Collection)

nextToken

DescribeImagesRequest.Builder nextToken(String nextToken)

The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.

Parameters:

nextToken - The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

DescribeImagesRequest.Builder maxResults(Integer maxResults)

The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

Parameters:

maxResults - The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

DescribeImagesRequest.Builder filter(DescribeImagesFilter filter)

The filter key and value with which to filter your DescribeImages results.

Parameters:

filter - The filter key and value with which to filter your DescribeImages results.

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

default DescribeImagesRequest.Builder filter(Consumer<DescribeImagesFilter.Builder> filter)

The filter key and value with which to filter your DescribeImages results.

This is a convenience method that creates an instance of the DescribeImagesFilter.Builder avoiding the need to create one manually via DescribeImagesFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(DescribeImagesFilter).

Parameters:

filter - a consumer that will call methods on DescribeImagesFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filter(DescribeImagesFilter)

overrideConfiguration

DescribeImagesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeImagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder