com.amazonaws.services.ecr.model.DescribePullThroughCacheRulesRequest 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 DescribePullThroughCacheRulesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If
* you do not specify a registry, the default registry is assumed.
*
*/
private String registryId;
/**
*
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository
* prefix value is specified, all pull through cache rules are returned.
*
*/
private java.util.List ecrRepositoryPrefixes;
/**
*
* The nextToken value returned from a previous paginated
* DescribePullThroughCacheRulesRequest 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.
*
*/
private String nextToken;
/**
*
* The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in
* paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest 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
* DescribePullThroughCacheRulesRequest request with the returned nextToken value. This
* value can be between 1 and 1000. If this parameter is not used, then
* DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value,
* if applicable.
*
*/
private Integer maxResults;
/**
*
* The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If
* you do not specify a registry, the default registry is assumed.
*
*
* @param registryId
* The Amazon Web Services account ID associated with the registry to return the pull through cache rules
* for. 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 to return the pull through cache rules for. If
* you do not specify a registry, the default registry is assumed.
*
*
* @return The Amazon Web Services account ID associated with the registry to return the pull through cache rules
* for. 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 to return the pull through cache rules for. If
* you do not specify a registry, the default registry is assumed.
*
*
* @param registryId
* The Amazon Web Services account ID associated with the registry to return the pull through cache rules
* for. 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 DescribePullThroughCacheRulesRequest withRegistryId(String registryId) {
setRegistryId(registryId);
return this;
}
/**
*
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository
* prefix value is specified, all pull through cache rules are returned.
*
*
* @return The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no
* repository prefix value is specified, all pull through cache rules are returned.
*/
public java.util.List getEcrRepositoryPrefixes() {
return ecrRepositoryPrefixes;
}
/**
*
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository
* prefix value is specified, all pull through cache rules are returned.
*
*
* @param ecrRepositoryPrefixes
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no
* repository prefix value is specified, all pull through cache rules are returned.
*/
public void setEcrRepositoryPrefixes(java.util.Collection ecrRepositoryPrefixes) {
if (ecrRepositoryPrefixes == null) {
this.ecrRepositoryPrefixes = null;
return;
}
this.ecrRepositoryPrefixes = new java.util.ArrayList(ecrRepositoryPrefixes);
}
/**
*
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository
* prefix value is specified, all pull through cache rules are returned.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setEcrRepositoryPrefixes(java.util.Collection)} or
* {@link #withEcrRepositoryPrefixes(java.util.Collection)} if you want to override the existing values.
*
*
* @param ecrRepositoryPrefixes
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no
* repository prefix value is specified, all pull through cache rules are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePullThroughCacheRulesRequest withEcrRepositoryPrefixes(String... ecrRepositoryPrefixes) {
if (this.ecrRepositoryPrefixes == null) {
setEcrRepositoryPrefixes(new java.util.ArrayList(ecrRepositoryPrefixes.length));
}
for (String ele : ecrRepositoryPrefixes) {
this.ecrRepositoryPrefixes.add(ele);
}
return this;
}
/**
*
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository
* prefix value is specified, all pull through cache rules are returned.
*
*
* @param ecrRepositoryPrefixes
* The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no
* repository prefix value is specified, all pull through cache rules are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePullThroughCacheRulesRequest withEcrRepositoryPrefixes(java.util.Collection ecrRepositoryPrefixes) {
setEcrRepositoryPrefixes(ecrRepositoryPrefixes);
return this;
}
/**
*
* The nextToken value returned from a previous paginated
* DescribePullThroughCacheRulesRequest 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.
*
*
* @param nextToken
* The nextToken value returned from a previous paginated
* DescribePullThroughCacheRulesRequest 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.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The nextToken value returned from a previous paginated
* DescribePullThroughCacheRulesRequest 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.
*
*
* @return The nextToken value returned from a previous paginated
* DescribePullThroughCacheRulesRequest 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.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The nextToken value returned from a previous paginated
* DescribePullThroughCacheRulesRequest 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.
*
*
* @param nextToken
* The nextToken value returned from a previous paginated
* DescribePullThroughCacheRulesRequest 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePullThroughCacheRulesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in
* paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest 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
* DescribePullThroughCacheRulesRequest request with the returned nextToken value. This
* value can be between 1 and 1000. If this parameter is not used, then
* DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value,
* if applicable.
*
*
* @param maxResults
* The maximum number of pull through cache rules returned by
* DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used,
* DescribePullThroughCacheRulesRequest 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 DescribePullThroughCacheRulesRequest request with the returned
* nextToken value. This value can be between 1 and 1000. If this parameter is not used, then
* DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken
* value, if applicable.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in
* paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest 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
* DescribePullThroughCacheRulesRequest request with the returned nextToken value. This
* value can be between 1 and 1000. If this parameter is not used, then
* DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value,
* if applicable.
*
*
* @return The maximum number of pull through cache rules returned by
* DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used,
* DescribePullThroughCacheRulesRequest 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 DescribePullThroughCacheRulesRequest request with the
* returned nextToken value. This value can be between 1 and 1000. If this parameter is not
* used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a
* nextToken value, if applicable.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in
* paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest 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
* DescribePullThroughCacheRulesRequest request with the returned nextToken value. This
* value can be between 1 and 1000. If this parameter is not used, then
* DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value,
* if applicable.
*
*
* @param maxResults
* The maximum number of pull through cache rules returned by
* DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used,
* DescribePullThroughCacheRulesRequest 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 DescribePullThroughCacheRulesRequest request with the returned
* nextToken value. This value can be between 1 and 1000. If this parameter is not used, then
* DescribePullThroughCacheRulesRequest 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 DescribePullThroughCacheRulesRequest 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 (getEcrRepositoryPrefixes() != null)
sb.append("EcrRepositoryPrefixes: ").append(getEcrRepositoryPrefixes()).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 DescribePullThroughCacheRulesRequest == false)
return false;
DescribePullThroughCacheRulesRequest other = (DescribePullThroughCacheRulesRequest) obj;
if (other.getRegistryId() == null ^ this.getRegistryId() == null)
return false;
if (other.getRegistryId() != null && other.getRegistryId().equals(this.getRegistryId()) == false)
return false;
if (other.getEcrRepositoryPrefixes() == null ^ this.getEcrRepositoryPrefixes() == null)
return false;
if (other.getEcrRepositoryPrefixes() != null && other.getEcrRepositoryPrefixes().equals(this.getEcrRepositoryPrefixes()) == 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 + ((getEcrRepositoryPrefixes() == null) ? 0 : getEcrRepositoryPrefixes().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribePullThroughCacheRulesRequest clone() {
return (DescribePullThroughCacheRulesRequest) super.clone();
}
}