com.amazonaws.services.ecr.model.DescribeRepositoriesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecr Show documentation
/*
* Copyright 2018-2023 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 DescribeRepositoriesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services account ID associated with the registry that contains the repositories to be described.
* If you do not specify a registry, the default registry is assumed.
*
*/
private String registryId;
/**
*
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
*
*/
private java.util.List repositoryNames;
/**
*
* The nextToken value returned from a previous paginated DescribeRepositories 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
* repositories with repositoryNames.
*
*
*
* 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 repository results returned by DescribeRepositories in paginated output. When
* this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken
* value. This value can be between 1 and 1000. If this parameter is not used, then
* DescribeRepositories returns up to 100 results and a nextToken value, if applicable.
* This option cannot be used when you specify repositories with repositoryNames.
*
*/
private Integer maxResults;
/**
*
* The Amazon Web Services account ID associated with the registry that contains the repositories to be described.
* 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 repositories to be
* described. 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 repositories to be described.
* 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 repositories to be
* described. 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 repositories to be described.
* 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 repositories to be
* described. 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 DescribeRepositoriesRequest withRegistryId(String registryId) {
setRegistryId(registryId);
return this;
}
/**
*
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
*
*
* @return A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
*/
public java.util.List getRepositoryNames() {
return repositoryNames;
}
/**
*
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
*
*
* @param repositoryNames
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
*/
public void setRepositoryNames(java.util.Collection repositoryNames) {
if (repositoryNames == null) {
this.repositoryNames = null;
return;
}
this.repositoryNames = new java.util.ArrayList(repositoryNames);
}
/**
*
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRepositoryNames(java.util.Collection)} or {@link #withRepositoryNames(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param repositoryNames
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRepositoriesRequest withRepositoryNames(String... repositoryNames) {
if (this.repositoryNames == null) {
setRepositoryNames(new java.util.ArrayList(repositoryNames.length));
}
for (String ele : repositoryNames) {
this.repositoryNames.add(ele);
}
return this;
}
/**
*
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
*
*
* @param repositoryNames
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are
* described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRepositoriesRequest withRepositoryNames(java.util.Collection repositoryNames) {
setRepositoryNames(repositoryNames);
return this;
}
/**
*
* The nextToken value returned from a previous paginated DescribeRepositories 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
* repositories with repositoryNames.
*
*
*
* 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 DescribeRepositories
* 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 repositories with repositoryNames.
*
* 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 DescribeRepositories 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
* repositories with repositoryNames.
*
*
*
* 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 DescribeRepositories
* 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 repositories with repositoryNames.
*
* 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 DescribeRepositories 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
* repositories with repositoryNames.
*
*
*
* 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 DescribeRepositories
* 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 repositories with repositoryNames.
*
* 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 DescribeRepositoriesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of repository results returned by DescribeRepositories in paginated output. When
* this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken
* value. This value can be between 1 and 1000. If this parameter is not used, then
* DescribeRepositories returns up to 100 results and a nextToken value, if applicable.
* This option cannot be used when you specify repositories with repositoryNames.
*
*
* @param maxResults
* The maximum number of repository results returned by DescribeRepositories in paginated
* output. When this parameter is used, DescribeRepositories 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 DescribeRepositories
* request with the returned nextToken value. This value can be between 1 and 1000. If this
* parameter is not used, then DescribeRepositories returns up to 100 results and a
* nextToken value, if applicable. This option cannot be used when you specify repositories with
* repositoryNames.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of repository results returned by DescribeRepositories in paginated output. When
* this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken
* value. This value can be between 1 and 1000. If this parameter is not used, then
* DescribeRepositories returns up to 100 results and a nextToken value, if applicable.
* This option cannot be used when you specify repositories with repositoryNames.
*
*
* @return The maximum number of repository results returned by DescribeRepositories in paginated
* output. When this parameter is used, DescribeRepositories 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
* DescribeRepositories request with the returned nextToken value. This value can
* be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up
* to 100 results and a nextToken value, if applicable. This option cannot be used when you
* specify repositories with repositoryNames.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of repository results returned by DescribeRepositories in paginated output. When
* this parameter is used, DescribeRepositories 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 DescribeRepositories request with the returned nextToken
* value. This value can be between 1 and 1000. If this parameter is not used, then
* DescribeRepositories returns up to 100 results and a nextToken value, if applicable.
* This option cannot be used when you specify repositories with repositoryNames.
*
*
* @param maxResults
* The maximum number of repository results returned by DescribeRepositories in paginated
* output. When this parameter is used, DescribeRepositories 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 DescribeRepositories
* request with the returned nextToken value. This value can be between 1 and 1000. If this
* parameter is not used, then DescribeRepositories returns up to 100 results and a
* nextToken value, if applicable. This option cannot be used when you specify repositories with
* repositoryNames.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRepositoriesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getRepositoryNames() != null)
sb.append("RepositoryNames: ").append(getRepositoryNames()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeRepositoriesRequest == false)
return false;
DescribeRepositoriesRequest other = (DescribeRepositoriesRequest) obj;
if (other.getRegistryId() == null ^ this.getRegistryId() == null)
return false;
if (other.getRegistryId() != null && other.getRegistryId().equals(this.getRegistryId()) == false)
return false;
if (other.getRepositoryNames() == null ^ this.getRepositoryNames() == null)
return false;
if (other.getRepositoryNames() != null && other.getRepositoryNames().equals(this.getRepositoryNames()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegistryId() == null) ? 0 : getRegistryId().hashCode());
hashCode = prime * hashCode + ((getRepositoryNames() == null) ? 0 : getRepositoryNames().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeRepositoriesRequest clone() {
return (DescribeRepositoriesRequest) super.clone();
}
}