com.amazonaws.services.ecrpublic.model

Class DescribeImagesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecrpublic.model.DescribeImagesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeImagesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeImagesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeImagesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<ImageIdentifier>	getImageIds() The list of image IDs for the requested repository.
Integer	getMaxResults() The maximum number of repository results returned by DescribeImages in paginated output.
String	getNextToken() The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter.
String	getRegistryId() The AWS account ID associated with the public registry that contains the repository in which to describe images.
String	getRepositoryName() The repository that contains the images to describe.
int	hashCode()
void	setImageIds(Collection<ImageIdentifier> imageIds) The list of image IDs for the requested repository.
void	setMaxResults(Integer maxResults) The maximum number of repository results returned by DescribeImages in paginated output.
void	setNextToken(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.
void	setRegistryId(String registryId) The AWS account ID associated with the public registry that contains the repository in which to describe images.
void	setRepositoryName(String repositoryName) The repository that contains the images to describe.
String	toString() Returns a string representation of this object.
DescribeImagesRequest	withImageIds(Collection<ImageIdentifier> imageIds) The list of image IDs for the requested repository.
DescribeImagesRequest	withImageIds(ImageIdentifier... imageIds) The list of image IDs for the requested repository.
DescribeImagesRequest	withMaxResults(Integer maxResults) The maximum number of repository results returned by DescribeImages in paginated output.
DescribeImagesRequest	withNextToken(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	withRegistryId(String registryId) The AWS account ID associated with the public registry that contains the repository in which to describe images.
DescribeImagesRequest	withRepositoryName(String repositoryName) The repository that contains the images to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeImagesRequest

public DescribeImagesRequest()

Method Detail

setRegistryId

public void setRegistryId(String registryId)

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

Parameters:

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

getRegistryId

public String getRegistryId()

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

Returns:

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

withRegistryId

public DescribeImagesRequest withRegistryId(String registryId)

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

Parameters:

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

Returns:

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

setRepositoryName

public void setRepositoryName(String repositoryName)

The repository that contains the images to describe.

Parameters:

repositoryName - The repository that contains the images to describe.

getRepositoryName

public String getRepositoryName()

The repository that contains the images to describe.

Returns:

The repository that contains the images to describe.

withRepositoryName

public DescribeImagesRequest withRepositoryName(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.

getImageIds

public List<ImageIdentifier> getImageIds()

The list of image IDs for the requested repository.

Returns:

The list of image IDs for the requested repository.

setImageIds

public void setImageIds(Collection<ImageIdentifier> imageIds)

The list of image IDs for the requested repository.

Parameters:

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

withImageIds

public DescribeImagesRequest withImageIds(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.

withImageIds

public DescribeImagesRequest withImageIds(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.

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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:

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.

withNextToken

public DescribeImagesRequest withNextToken(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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:

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.

withMaxResults

public DescribeImagesRequest withMaxResults(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeImagesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()