com.amazonaws.services.certificatemanager.model.ListCertificatesRequest 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.certificatemanager.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 */
public class ListCertificatesRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * Identifies the statuses of the ACM Certificates for which you want to
     * retrieve the ARNs. This can be one or more of the following values:
     * 
     * - 
     * 
     * PENDING_VALIDATION
     * 
     *  
     * - 
     * 
     * ISSUED
     * 
     *  
     * - 
     * 
     * INACTIVE
     * 
     *  
     * - 
     * 
     * EXPIRED
     * 
     *  
     * - 
     * 
     * VALIDATION_TIMED_OUT
     * 
     *  
     * - 
     * 
     * REVOKED
     * 
     *  
     * - 
     * 
     * FAILED
     * 
     *  
     * 
     * 
     */
    private java.util.List certificateStatuses;
    /**
     * 
     * String that contains an opaque marker of the next ACM Certificate ARN to
     * be displayed. Use this parameter when paginating results, and only in a
     * subsequent request after you've received a response where the results
     * have been truncated. Set it to an empty string the first time you call
     * this action, and set it to the value of the NextToken
     * element you receive in the response object for subsequent calls.
     * 
     */
    private String nextToken;
    /**
     * 
     * Specify this parameter when paginating results to indicate the maximum
     * number of ACM Certificates that you want to display for each response. If
     * there are additional certificates beyond the maximum you specify, use the
     * NextToken value in your next call to the
     * ListCertificates action.
     * 
     */
    private Integer maxItems;
    /**
     * 
     * Identifies the statuses of the ACM Certificates for which you want to
     * retrieve the ARNs. This can be one or more of the following values:
     * 
     * - 
     * 
     * PENDING_VALIDATION
     * 
     *  
     * - 
     * 
     * ISSUED
     * 
     *  
     * - 
     * 
     * INACTIVE
     * 
     *  
     * - 
     * 
     * EXPIRED
     * 
     *  
     * - 
     * 
     * VALIDATION_TIMED_OUT
     * 
     *  
     * - 
     * 
     * REVOKED
     * 
     *  
     * - 
     * 
     * FAILED
     * 
     *  
     * 
     * 
     * 
     * @return Identifies the statuses of the ACM Certificates for which you
     *         want to retrieve the ARNs. This can be one or more of the
     *         following values:
     *         
     *         - 
     *         
     *         PENDING_VALIDATION
     *         
     *          
     *         - 
     *         
     *         ISSUED
     *         
     *          
     *         - 
     *         
     *         INACTIVE
     *         
     *          
     *         - 
     *         
     *         EXPIRED
     *         
     *          
     *         - 
     *         
     *         VALIDATION_TIMED_OUT
     *         
     *          
     *         - 
     *         
     *         REVOKED
     *         
     *          
     *         - 
     *         
     *         FAILED
     *         
     *          
     *         
     * @see CertificateStatus
     */
    public java.util.List getCertificateStatuses() {
        return certificateStatuses;
    }
    /**
     * 
     * Identifies the statuses of the ACM Certificates for which you want to
     * retrieve the ARNs. This can be one or more of the following values:
     * 
     * - 
     * 
     * PENDING_VALIDATION
     * 
     *  
     * - 
     * 
     * ISSUED
     * 
     *  
     * - 
     * 
     * INACTIVE
     * 
     *  
     * - 
     * 
     * EXPIRED
     * 
     *  
     * - 
     * 
     * VALIDATION_TIMED_OUT
     * 
     *  
     * - 
     * 
     * REVOKED
     * 
     *  
     * - 
     * 
     * FAILED
     * 
     *  
     * 
     * 
     * 
     * @param certificateStatuses
     *        Identifies the statuses of the ACM Certificates for which you want
     *        to retrieve the ARNs. This can be one or more of the following
     *        values:
     *        
     *        - 
     *        
     *        PENDING_VALIDATION
     *        
     *         
     *        - 
     *        
     *        ISSUED
     *        
     *         
     *        - 
     *        
     *        INACTIVE
     *        
     *         
     *        - 
     *        
     *        EXPIRED
     *        
     *         
     *        - 
     *        
     *        VALIDATION_TIMED_OUT
     *        
     *         
     *        - 
     *        
     *        REVOKED
     *        
     *         
     *        - 
     *        
     *        FAILED
     *        
     *         
     *        
     * @see CertificateStatus
     */
    public void setCertificateStatuses(
            java.util.Collection certificateStatuses) {
        if (certificateStatuses == null) {
            this.certificateStatuses = null;
            return;
        }
        this.certificateStatuses = new java.util.ArrayList(
                certificateStatuses);
    }
    /**
     * 
     * Identifies the statuses of the ACM Certificates for which you want to
     * retrieve the ARNs. This can be one or more of the following values:
     * 
     * - 
     * 
     * PENDING_VALIDATION
     * 
     *  
     * - 
     * 
     * ISSUED
     * 
     *  
     * - 
     * 
     * INACTIVE
     * 
     *  
     * - 
     * 
     * EXPIRED
     * 
     *  
     * - 
     * 
     * VALIDATION_TIMED_OUT
     * 
     *  
     * - 
     * 
     * REVOKED
     * 
     *  
     * - 
     * 
     * FAILED
     * 
     *  
     * 
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setCertificateStatuses(java.util.Collection)} or
     * {@link #withCertificateStatuses(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param certificateStatuses
     *        Identifies the statuses of the ACM Certificates for which you want
     *        to retrieve the ARNs. This can be one or more of the following
     *        values:
     *        
     *        - 
     *        
     *        PENDING_VALIDATION
     *        
     *         
     *        - 
     *        
     *        ISSUED
     *        
     *         
     *        - 
     *        
     *        INACTIVE
     *        
     *         
     *        - 
     *        
     *        EXPIRED
     *        
     *         
     *        - 
     *        
     *        VALIDATION_TIMED_OUT
     *        
     *         
     *        - 
     *        
     *        REVOKED
     *        
     *         
     *        - 
     *        
     *        FAILED
     *        
     *         
     *        
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see CertificateStatus
     */
    public ListCertificatesRequest withCertificateStatuses(
            String... certificateStatuses) {
        if (this.certificateStatuses == null) {
            setCertificateStatuses(new java.util.ArrayList(
                    certificateStatuses.length));
        }
        for (String ele : certificateStatuses) {
            this.certificateStatuses.add(ele);
        }
        return this;
    }
    /**
     * 
     * Identifies the statuses of the ACM Certificates for which you want to
     * retrieve the ARNs. This can be one or more of the following values:
     * 
     * - 
     * 
     * PENDING_VALIDATION
     * 
     *  
     * - 
     * 
     * ISSUED
     * 
     *  
     * - 
     * 
     * INACTIVE
     * 
     *  
     * - 
     * 
     * EXPIRED
     * 
     *  
     * - 
     * 
     * VALIDATION_TIMED_OUT
     * 
     *  
     * - 
     * 
     * REVOKED
     * 
     *  
     * - 
     * 
     * FAILED
     * 
     *  
     * 
     * 
     * 
     * @param certificateStatuses
     *        Identifies the statuses of the ACM Certificates for which you want
     *        to retrieve the ARNs. This can be one or more of the following
     *        values:
     *        
     *        - 
     *        
     *        PENDING_VALIDATION
     *        
     *         
     *        - 
     *        
     *        ISSUED
     *        
     *         
     *        - 
     *        
     *        INACTIVE
     *        
     *         
     *        - 
     *        
     *        EXPIRED
     *        
     *         
     *        - 
     *        
     *        VALIDATION_TIMED_OUT
     *        
     *         
     *        - 
     *        
     *        REVOKED
     *        
     *         
     *        - 
     *        
     *        FAILED
     *        
     *         
     *        
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see CertificateStatus
     */
    public ListCertificatesRequest withCertificateStatuses(
            java.util.Collection certificateStatuses) {
        setCertificateStatuses(certificateStatuses);
        return this;
    }
    /**
     * 
     * Identifies the statuses of the ACM Certificates for which you want to
     * retrieve the ARNs. This can be one or more of the following values:
     * 
     * - 
     * 
     * PENDING_VALIDATION
     * 
     *  
     * - 
     * 
     * ISSUED
     * 
     *  
     * - 
     * 
     * INACTIVE
     * 
     *  
     * - 
     * 
     * EXPIRED
     * 
     *  
     * - 
     * 
     * VALIDATION_TIMED_OUT
     * 
     *  
     * - 
     * 
     * REVOKED
     * 
     *  
     * - 
     * 
     * FAILED
     * 
     *  
     * 
     * 
     * 
     * @param certificateStatuses
     *        Identifies the statuses of the ACM Certificates for which you want
     *        to retrieve the ARNs. This can be one or more of the following
     *        values:
     *        
     *        - 
     *        
     *        PENDING_VALIDATION
     *        
     *         
     *        - 
     *        
     *        ISSUED
     *        
     *         
     *        - 
     *        
     *        INACTIVE
     *        
     *         
     *        - 
     *        
     *        EXPIRED
     *        
     *         
     *        - 
     *        
     *        VALIDATION_TIMED_OUT
     *        
     *         
     *        - 
     *        
     *        REVOKED
     *        
     *         
     *        - 
     *        
     *        FAILED
     *        
     *         
     *        
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see CertificateStatus
     */
    public ListCertificatesRequest withCertificateStatuses(
            CertificateStatus... certificateStatuses) {
        java.util.ArrayList certificateStatusesCopy = new java.util.ArrayList(
                certificateStatuses.length);
        for (CertificateStatus value : certificateStatuses) {
            certificateStatusesCopy.add(value.toString());
        }
        if (getCertificateStatuses() == null) {
            setCertificateStatuses(certificateStatusesCopy);
        } else {
            getCertificateStatuses().addAll(certificateStatusesCopy);
        }
        return this;
    }
    /**
     * 
     * String that contains an opaque marker of the next ACM Certificate ARN to
     * be displayed. Use this parameter when paginating results, and only in a
     * subsequent request after you've received a response where the results
     * have been truncated. Set it to an empty string the first time you call
     * this action, and set it to the value of the NextToken
     * element you receive in the response object for subsequent calls.
     * 
     * 
     * @param nextToken
     *        String that contains an opaque marker of the next ACM Certificate
     *        ARN to be displayed. Use this parameter when paginating results,
     *        and only in a subsequent request after you've received a response
     *        where the results have been truncated. Set it to an empty string
     *        the first time you call this action, and set it to the value of
     *        the NextToken element you receive in the response
     *        object for subsequent calls.
     */
    public void setNextToken(String nextToken) {
        this.nextToken = nextToken;
    }
    /**
     * 
     * String that contains an opaque marker of the next ACM Certificate ARN to
     * be displayed. Use this parameter when paginating results, and only in a
     * subsequent request after you've received a response where the results
     * have been truncated. Set it to an empty string the first time you call
     * this action, and set it to the value of the NextToken
     * element you receive in the response object for subsequent calls.
     * 
     * 
     * @return String that contains an opaque marker of the next ACM Certificate
     *         ARN to be displayed. Use this parameter when paginating results,
     *         and only in a subsequent request after you've received a response
     *         where the results have been truncated. Set it to an empty string
     *         the first time you call this action, and set it to the value of
     *         the NextToken element you receive in the response
     *         object for subsequent calls.
     */
    public String getNextToken() {
        return this.nextToken;
    }
    /**
     * 
     * String that contains an opaque marker of the next ACM Certificate ARN to
     * be displayed. Use this parameter when paginating results, and only in a
     * subsequent request after you've received a response where the results
     * have been truncated. Set it to an empty string the first time you call
     * this action, and set it to the value of the NextToken
     * element you receive in the response object for subsequent calls.
     * 
     * 
     * @param nextToken
     *        String that contains an opaque marker of the next ACM Certificate
     *        ARN to be displayed. Use this parameter when paginating results,
     *        and only in a subsequent request after you've received a response
     *        where the results have been truncated. Set it to an empty string
     *        the first time you call this action, and set it to the value of
     *        the NextToken element you receive in the response
     *        object for subsequent calls.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListCertificatesRequest withNextToken(String nextToken) {
        setNextToken(nextToken);
        return this;
    }
    /**
     * 
     * Specify this parameter when paginating results to indicate the maximum
     * number of ACM Certificates that you want to display for each response. If
     * there are additional certificates beyond the maximum you specify, use the
     * NextToken value in your next call to the
     * ListCertificates action.
     * 
     * 
     * @param maxItems
     *        Specify this parameter when paginating results to indicate the
     *        maximum number of ACM Certificates that you want to display for
     *        each response. If there are additional certificates beyond the
     *        maximum you specify, use the NextToken value in your
     *        next call to the ListCertificates action.
     */
    public void setMaxItems(Integer maxItems) {
        this.maxItems = maxItems;
    }
    /**
     * 
     * Specify this parameter when paginating results to indicate the maximum
     * number of ACM Certificates that you want to display for each response. If
     * there are additional certificates beyond the maximum you specify, use the
     * NextToken value in your next call to the
     * ListCertificates action.
     * 
     * 
     * @return Specify this parameter when paginating results to indicate the
     *         maximum number of ACM Certificates that you want to display for
     *         each response. If there are additional certificates beyond the
     *         maximum you specify, use the NextToken value in your
     *         next call to the ListCertificates action.
     */
    public Integer getMaxItems() {
        return this.maxItems;
    }
    /**
     * 
     * Specify this parameter when paginating results to indicate the maximum
     * number of ACM Certificates that you want to display for each response. If
     * there are additional certificates beyond the maximum you specify, use the
     * NextToken value in your next call to the
     * ListCertificates action.
     * 
     * 
     * @param maxItems
     *        Specify this parameter when paginating results to indicate the
     *        maximum number of ACM Certificates that you want to display for
     *        each response. If there are additional certificates beyond the
     *        maximum you specify, use the NextToken value in your
     *        next call to the ListCertificates action.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListCertificatesRequest withMaxItems(Integer maxItems) {
        setMaxItems(maxItems);
        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 (getCertificateStatuses() != null)
            sb.append("CertificateStatuses: " + getCertificateStatuses() + ",");
        if (getNextToken() != null)
            sb.append("NextToken: " + getNextToken() + ",");
        if (getMaxItems() != null)
            sb.append("MaxItems: " + getMaxItems());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof ListCertificatesRequest == false)
            return false;
        ListCertificatesRequest other = (ListCertificatesRequest) obj;
        if (other.getCertificateStatuses() == null
                ^ this.getCertificateStatuses() == null)
            return false;
        if (other.getCertificateStatuses() != null
                && other.getCertificateStatuses().equals(
                        this.getCertificateStatuses()) == 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.getMaxItems() == null ^ this.getMaxItems() == null)
            return false;
        if (other.getMaxItems() != null
                && other.getMaxItems().equals(this.getMaxItems()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getCertificateStatuses() == null) ? 0
                        : getCertificateStatuses().hashCode());
        hashCode = prime * hashCode
                + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
        hashCode = prime * hashCode
                + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode());
        return hashCode;
    }
    @Override
    public ListCertificatesRequest clone() {
        return (ListCertificatesRequest) super.clone();
    }
}