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

Class DescribeImagesRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ecr.model.DescribeImagesRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeImagesRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeImagesRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeImagesRequest.Builder	builder()
boolean	equals(Object obj)
DescribeImagesFilter	filter()	The filter key and value with which to filter your DescribeImages results.
int	hashCode()
List<ImageIdentifier>	imageIds()	The list of image IDs for the requested repository.
Integer	maxResults()	The maximum number of repository results returned by DescribeImages in paginated output.
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.
String	registryId()	The AWS account ID associated with the registry that contains the repository in which to describe images.
String	repositoryName()	A list of repositories to describe.
static Class<? extends DescribeImagesRequest.Builder>	serializableBuilderClass()
DescribeImagesRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

registryId

public 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.

Returns:

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.

repositoryName

public String repositoryName()

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

Returns:

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

imageIds

public List<ImageIdentifier> imageIds()

The list of image IDs for the requested repository.

Returns:

The list of image IDs for the requested repository.

nextToken

public 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.

Returns:

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.

maxResults

public 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.

Returns:

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.

filter

public DescribeImagesFilter filter()

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

Returns:

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

toBuilder

public DescribeImagesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

Returns:

a builder for type T

builder

public static DescribeImagesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeImagesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object