Package software.amazon.awssdk.services.ecr.model

Interface DescribeImagesRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>, SdkBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

Enclosing class:

DescribeImagesRequest

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

Method Summary

Modifier and Type	Method	Description
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(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	registryId(String registryId)	The AWS account ID associated with the registry that contains the repository in which to describe images.
DescribeImagesRequest.Builder	repositoryName(String repositoryName)	A list of repositories to describe.

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

copy

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

apply, build

Method Detail

registryId

DescribeImagesRequest.Builder registryId(String registryId)

The AWS 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 AWS 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)

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Parameters:

repositoryName - A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

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.

NOTE: This method appends the values to the existing list (if any). Use #setImageIds(java.util.Collection) or #withImageIds(java.util.Collection) if you want to override the existing values.

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.

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.

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.

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 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable.

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 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable.

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.