com.amazonaws.services.ecr.model.DescribeImagesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecr Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ecr.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeImagesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String registryId;
/**
*
* The repository that contains the images to describe.
*
*/
private String repositoryName;
/**
*
* The list of image IDs for the requested repository.
*
*/
private java.util.List imageIds;
/**
*
* 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.
*
*/
private String nextToken;
/**
*
* 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.
*
*/
private Integer maxResults;
/**
*
* The filter key and value with which to filter your DescribeImages results.
*
*/
private DescribeImagesFilter filter;
/**
*
* 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.
*
*
* @param 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.
*/
public void setRegistryId(String registryId) {
this.registryId = 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.
*
*
* @return 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.
*/
public String getRegistryId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withRegistryId(String registryId) {
setRegistryId(registryId);
return this;
}
/**
*
* The repository that contains the images to describe.
*
*
* @param repositoryName
* The repository that contains the images to describe.
*/
public void setRepositoryName(String repositoryName) {
this.repositoryName = repositoryName;
}
/**
*
* The repository that contains the images to describe.
*
*
* @return The repository that contains the images to describe.
*/
public String getRepositoryName() {
return this.repositoryName;
}
/**
*
* The repository that contains the images to describe.
*
*
* @param repositoryName
* The repository that contains the images to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withRepositoryName(String repositoryName) {
setRepositoryName(repositoryName);
return this;
}
/**
*
* The list of image IDs for the requested repository.
*
*
* @return The list of image IDs for the requested repository.
*/
public java.util.List getImageIds() {
return imageIds;
}
/**
*
* The list of image IDs for the requested repository.
*
*
* @param imageIds
* The list of image IDs for the requested repository.
*/
public void setImageIds(java.util.Collection imageIds) {
if (imageIds == null) {
this.imageIds = null;
return;
}
this.imageIds = new java.util.ArrayList(imageIds);
}
/**
*
* The list of image IDs for the requested repository.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setImageIds(java.util.Collection)} or {@link #withImageIds(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param imageIds
* The list of image IDs for the requested repository.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withImageIds(ImageIdentifier... imageIds) {
if (this.imageIds == null) {
setImageIds(new java.util.ArrayList(imageIds.length));
}
for (ImageIdentifier ele : imageIds) {
this.imageIds.add(ele);
}
return this;
}
/**
*
* The list of image IDs for the requested repository.
*
*
* @param imageIds
* The list of image IDs for the requested repository.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withImageIds(java.util.Collection imageIds) {
setImageIds(imageIds);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setNextToken(String nextToken) {
this.nextToken = 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.
*
*
* @return 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.
*/
public String getNextToken() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = 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.
*
*
* @return 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.
*/
public Integer getMaxResults() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The filter key and value with which to filter your DescribeImages results.
*
*
* @param filter
* The filter key and value with which to filter your DescribeImages results.
*/
public void setFilter(DescribeImagesFilter filter) {
this.filter = filter;
}
/**
*
* The filter key and value with which to filter your DescribeImages results.
*
*
* @return The filter key and value with which to filter your DescribeImages results.
*/
public DescribeImagesFilter getFilter() {
return this.filter;
}
/**
*
* The filter key and value with which to filter your DescribeImages results.
*
*
* @param filter
* The filter key and value with which to filter your DescribeImages results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeImagesRequest withFilter(DescribeImagesFilter filter) {
setFilter(filter);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getRegistryId() != null)
sb.append("RegistryId: ").append(getRegistryId()).append(",");
if (getRepositoryName() != null)
sb.append("RepositoryName: ").append(getRepositoryName()).append(",");
if (getImageIds() != null)
sb.append("ImageIds: ").append(getImageIds()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getFilter() != null)
sb.append("Filter: ").append(getFilter());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeImagesRequest == false)
return false;
DescribeImagesRequest other = (DescribeImagesRequest) obj;
if (other.getRegistryId() == null ^ this.getRegistryId() == null)
return false;
if (other.getRegistryId() != null && other.getRegistryId().equals(this.getRegistryId()) == false)
return false;
if (other.getRepositoryName() == null ^ this.getRepositoryName() == null)
return false;
if (other.getRepositoryName() != null && other.getRepositoryName().equals(this.getRepositoryName()) == false)
return false;
if (other.getImageIds() == null ^ this.getImageIds() == null)
return false;
if (other.getImageIds() != null && other.getImageIds().equals(this.getImageIds()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getFilter() == null ^ this.getFilter() == null)
return false;
if (other.getFilter() != null && other.getFilter().equals(this.getFilter()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegistryId() == null) ? 0 : getRegistryId().hashCode());
hashCode = prime * hashCode + ((getRepositoryName() == null) ? 0 : getRepositoryName().hashCode());
hashCode = prime * hashCode + ((getImageIds() == null) ? 0 : getImageIds().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getFilter() == null) ? 0 : getFilter().hashCode());
return hashCode;
}
@Override
public DescribeImagesRequest clone() {
return (DescribeImagesRequest) super.clone();
}
}