com.amazonaws.services.ecr.model.ListImagesRequest 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 ListImagesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services account ID associated with the registry that contains the repository in which to list
* images. If you do not specify a registry, the default registry is assumed.
*
*/
private String registryId;
/**
*
* The repository with image IDs to be listed.
*
*/
private String repositoryName;
/**
*
* The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*/
private String nextToken;
/**
*
* The maximum number of image results returned by ListImages in paginated output. When this parameter
* is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between
* 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a
* nextToken value, if applicable.
*
*/
private Integer maxResults;
/**
*
* The filter key and value with which to filter your ListImages results.
*
*/
private ListImagesFilter filter;
/**
*
* The Amazon Web Services account ID associated with the registry that contains the repository in which to list
* 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
* list 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 list
* 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
* list 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 list
* 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
* list 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 ListImagesRequest withRegistryId(String registryId) {
setRegistryId(registryId);
return this;
}
/**
*
* The repository with image IDs to be listed.
*
*
* @param repositoryName
* The repository with image IDs to be listed.
*/
public void setRepositoryName(String repositoryName) {
this.repositoryName = repositoryName;
}
/**
*
* The repository with image IDs to be listed.
*
*
* @return The repository with image IDs to be listed.
*/
public String getRepositoryName() {
return this.repositoryName;
}
/**
*
* The repository with image IDs to be listed.
*
*
* @param repositoryName
* The repository with image IDs to be listed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withRepositoryName(String repositoryName) {
setRepositoryName(repositoryName);
return this;
}
/**
*
* The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @return The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and
* not for other programmatic purposes.
*
*
*
* @param nextToken
* The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a
* list and not for other programmatic purposes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of image results returned by ListImages in paginated output. When this parameter
* is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between
* 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a
* nextToken value, if applicable.
*
*
* @param maxResults
* The maximum number of image results returned by ListImages in paginated output. When this
* parameter is used, ListImages 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 ListImages request with the returned nextToken value.
* This value can be between 1 and 1000. If this parameter is not used, then ListImages returns
* up to 100 results and a nextToken value, if applicable.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of image results returned by ListImages in paginated output. When this parameter
* is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between
* 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a
* nextToken value, if applicable.
*
*
* @return The maximum number of image results returned by ListImages in paginated output. When this
* parameter is used, ListImages 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 ListImages request with the returned nextToken value.
* This value can be between 1 and 1000. If this parameter is not used, then ListImages returns
* up to 100 results and a nextToken value, if applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of image results returned by ListImages in paginated output. When this parameter
* is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between
* 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a
* nextToken value, if applicable.
*
*
* @param maxResults
* The maximum number of image results returned by ListImages in paginated output. When this
* parameter is used, ListImages 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 ListImages request with the returned nextToken value.
* This value can be between 1 and 1000. If this parameter is not used, then ListImages returns
* up to 100 results and a nextToken value, if applicable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The filter key and value with which to filter your ListImages results.
*
*
* @param filter
* The filter key and value with which to filter your ListImages results.
*/
public void setFilter(ListImagesFilter filter) {
this.filter = filter;
}
/**
*
* The filter key and value with which to filter your ListImages results.
*
*
* @return The filter key and value with which to filter your ListImages results.
*/
public ListImagesFilter getFilter() {
return this.filter;
}
/**
*
* The filter key and value with which to filter your ListImages results.
*
*
* @param filter
* The filter key and value with which to filter your ListImages results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListImagesRequest withFilter(ListImagesFilter 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 (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 ListImagesRequest == false)
return false;
ListImagesRequest other = (ListImagesRequest) 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.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 + ((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 ListImagesRequest clone() {
return (ListImagesRequest) super.clone();
}
}