com.amazonaws.services.ecr.model.ListImagesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 */
public class ListImagesRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * The AWS account ID associated with the registry that contains the
     * repository to list images in. If you do not specify a registry, the
     * default registry is assumed.
     * 
     */
    private String registryId;
    /**
     * 
     * The repository whose image IDs are 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.
     * 
     */
    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 100. If this parameter is not used, then
     * ListImages returns up to 100 results and a
     * nextToken value, if applicable.
     * 
     */
    private Integer maxResults;
    /**
     * 
     * The AWS account ID associated with the registry that contains the
     * repository to list images in. If you do not specify a registry, the
     * default registry is assumed.
     * 
     * 
     * @param registryId
     *        The AWS account ID associated with the registry that contains the
     *        repository to list images in. If you do not specify a registry,
     *        the default registry is assumed.
     */
    public void setRegistryId(String registryId) {
        this.registryId = registryId;
    }
    /**
     * 
     * The AWS account ID associated with the registry that contains the
     * repository to list images in. If you do not specify a registry, the
     * default registry is assumed.
     * 
     * 
     * @return The AWS account ID associated with the registry that contains the
     *         repository to list images in. If you do not specify a registry,
     *         the default registry is assumed.
     */
    public String getRegistryId() {
        return this.registryId;
    }
    /**
     * 
     * The AWS account ID associated with the registry that contains the
     * repository to list images in. If you do not specify a registry, the
     * default registry is assumed.
     * 
     * 
     * @param registryId
     *        The AWS account ID associated with the registry that contains the
     *        repository to list images in. 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 whose image IDs are to be listed.
     * 
     * 
     * @param repositoryName
     *        The repository whose image IDs are to be listed.
     */
    public void setRepositoryName(String repositoryName) {
        this.repositoryName = repositoryName;
    }
    /**
     * 
     * The repository whose image IDs are to be listed.
     * 
     * 
     * @return The repository whose image IDs are to be listed.
     */
    public String getRepositoryName() {
        return this.repositoryName;
    }
    /**
     * 
     * The repository whose image IDs are to be listed.
     * 
     * 
     * @param repositoryName
     *        The repository whose image IDs are 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.
     * 
     * 
     * @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.
     */
    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.
     * 
     * 
     * @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.
     */
    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.
     * 
     * 
     * @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.
     * @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 100. 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 100.
     *        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 100. 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
     *         100. 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 100. 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 100.
     *        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;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @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: " + getRegistryId() + ",");
        if (getRepositoryName() != null)
            sb.append("RepositoryName: " + getRepositoryName() + ",");
        if (getNextToken() != null)
            sb.append("NextToken: " + getNextToken() + ",");
        if (getMaxResults() != null)
            sb.append("MaxResults: " + 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 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;
        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());
        return hashCode;
    }
    @Override
    public ListImagesRequest clone() {
        return (ListImagesRequest) super.clone();
    }
}