com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesRequest 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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeClassicLinkInstancesRequestMarshaller;
/**
 * 
 * Contains the parameters for DescribeClassicLinkInstances.
 * 
 */
public class DescribeClassicLinkInstancesRequest extends
        AmazonWebServiceRequest implements Serializable, Cloneable,
        DryRunSupportedRequest {
    /**
     * 
     * One or more instance IDs. Must be instances linked to a VPC through
     * ClassicLink.
     * 
     */
    private com.amazonaws.internal.SdkInternalList instanceIds;
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * group-id - The ID of a VPC security group that's associated
     * with the instance.
     * 
     *  
     * - 
     * 
     * instance-id - The ID of the instance.
     * 
     *  
     * - 
     * 
     * tag:key=value - The key/value combination of a
     * tag assigned to the resource.
     * 
     *  
     * - 
     * 
     * tag-key - The key of a tag assigned to the resource. This
     * filter is independent of the tag-value filter. For example,
     * if you use both the filter "tag-key=Purpose" and the filter
     * "tag-value=X", you get any resources assigned both the tag key Purpose
     * (regardless of what the tag's value is), and the tag value X (regardless
     * of what the tag's key is). If you want to list only resources where
     * Purpose is X, see the tag:key=value filter.
     * 
     *  
     * - 
     * 
     * tag-value - The value of a tag assigned to the resource.
     * This filter is independent of the tag-key filter.
     * 
     *  
     * - 
     * 
     * vpc-id - The ID of the VPC that the instance is linked to.
     * 
     *  
     * 
     */
    private com.amazonaws.internal.SdkInternalList filters;
    /**
     * 
     * The token to retrieve the next page of results.
     * 
     */
    private String nextToken;
    /**
     * 
     * The maximum number of results to return for the request in a single page.
     * The remaining results of the initial request can be seen by sending
     * another request with the returned NextToken value. This
     * value can be between 5 and 1000; if MaxResults is given a
     * value larger than 1000, only 1000 results are returned. You cannot
     * specify this parameter and the instance IDs parameter in the same
     * request.
     * 
     * 
     * Constraint: If the value is greater than 1000, we return only 1000 items.
     * 
     */
    private Integer maxResults;
    /**
     * 
     * One or more instance IDs. Must be instances linked to a VPC through
     * ClassicLink.
     * 
     * 
     * @return One or more instance IDs. Must be instances linked to a VPC
     *         through ClassicLink.
     */
    public java.util.List getInstanceIds() {
        if (instanceIds == null) {
            instanceIds = new com.amazonaws.internal.SdkInternalList();
        }
        return instanceIds;
    }
    /**
     * 
     * One or more instance IDs. Must be instances linked to a VPC through
     * ClassicLink.
     * 
     * 
     * @param instanceIds
     *        One or more instance IDs. Must be instances linked to a VPC
     *        through ClassicLink.
     */
    public void setInstanceIds(java.util.Collection instanceIds) {
        if (instanceIds == null) {
            this.instanceIds = null;
            return;
        }
        this.instanceIds = new com.amazonaws.internal.SdkInternalList(
                instanceIds);
    }
    /**
     * 
     * One or more instance IDs. Must be instances linked to a VPC through
     * ClassicLink.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setInstanceIds(java.util.Collection)} or
     * {@link #withInstanceIds(java.util.Collection)} if you want to override
     * the existing values.
     * 
     * 
     * @param instanceIds
     *        One or more instance IDs. Must be instances linked to a VPC
     *        through ClassicLink.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeClassicLinkInstancesRequest withInstanceIds(
            String... instanceIds) {
        if (this.instanceIds == null) {
            setInstanceIds(new com.amazonaws.internal.SdkInternalList(
                    instanceIds.length));
        }
        for (String ele : instanceIds) {
            this.instanceIds.add(ele);
        }
        return this;
    }
    /**
     * 
     * One or more instance IDs. Must be instances linked to a VPC through
     * ClassicLink.
     * 
     * 
     * @param instanceIds
     *        One or more instance IDs. Must be instances linked to a VPC
     *        through ClassicLink.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeClassicLinkInstancesRequest withInstanceIds(
            java.util.Collection instanceIds) {
        setInstanceIds(instanceIds);
        return this;
    }
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * group-id - The ID of a VPC security group that's associated
     * with the instance.
     * 
     *  
     * - 
     * 
     * instance-id - The ID of the instance.
     * 
     *  
     * - 
     * 
     * tag:key=value - The key/value combination of a
     * tag assigned to the resource.
     * 
     *  
     * - 
     * 
     * tag-key - The key of a tag assigned to the resource. This
     * filter is independent of the tag-value filter. For example,
     * if you use both the filter "tag-key=Purpose" and the filter
     * "tag-value=X", you get any resources assigned both the tag key Purpose
     * (regardless of what the tag's value is), and the tag value X (regardless
     * of what the tag's key is). If you want to list only resources where
     * Purpose is X, see the tag:key=value filter.
     * 
     *  
     * - 
     * 
     * tag-value - The value of a tag assigned to the resource.
     * This filter is independent of the tag-key filter.
     * 
     *  
     * - 
     * 
     * vpc-id - The ID of the VPC that the instance is linked to.
     * 
     *  
     * 
     * 
     * @return One or more filters.
     *         
     *         - 
     *         
     *         group-id - The ID of a VPC security group that's
     *         associated with the instance.
     *         
     *          
     *         - 
     *         
     *         instance-id - The ID of the instance.
     *         
     *          
     *         - 
     *         
     *         tag:key=value - The key/value
     *         combination of a tag assigned to the resource.
     *         
     *          
     *         - 
     *         
     *         tag-key - The key of a tag assigned to the resource.
     *         This filter is independent of the tag-value filter.
     *         For example, if you use both the filter "tag-key=Purpose" and the
     *         filter "tag-value=X", you get any resources assigned both the tag
     *         key Purpose (regardless of what the tag's value is), and the tag
     *         value X (regardless of what the tag's key is). If you want to
     *         list only resources where Purpose is X, see the tag
     *         :key=value filter.
     *         
     *          
     *         - 
     *         
     *         tag-value - The value of a tag assigned to the
     *         resource. This filter is independent of the tag-key
     *         filter.
     *         
     *          
     *         - 
     *         
     *         vpc-id - The ID of the VPC that the instance is
     *         linked to.
     *         
     *          
     */
    public java.util.List getFilters() {
        if (filters == null) {
            filters = new com.amazonaws.internal.SdkInternalList();
        }
        return filters;
    }
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * group-id - The ID of a VPC security group that's associated
     * with the instance.
     * 
     *  
     * - 
     * 
     * instance-id - The ID of the instance.
     * 
     *  
     * - 
     * 
     * tag:key=value - The key/value combination of a
     * tag assigned to the resource.
     * 
     *  
     * - 
     * 
     * tag-key - The key of a tag assigned to the resource. This
     * filter is independent of the tag-value filter. For example,
     * if you use both the filter "tag-key=Purpose" and the filter
     * "tag-value=X", you get any resources assigned both the tag key Purpose
     * (regardless of what the tag's value is), and the tag value X (regardless
     * of what the tag's key is). If you want to list only resources where
     * Purpose is X, see the tag:key=value filter.
     * 
     *  
     * - 
     * 
     * tag-value - The value of a tag assigned to the resource.
     * This filter is independent of the tag-key filter.
     * 
     *  
     * - 
     * 
     * vpc-id - The ID of the VPC that the instance is linked to.
     * 
     *  
     * 
     * 
     * @param filters
     *        One or more filters.
     *        
     *        - 
     *        
     *        group-id - The ID of a VPC security group that's
     *        associated with the instance.
     *        
     *         
     *        - 
     *        
     *        instance-id - The ID of the instance.
     *        
     *         
     *        - 
     *        
     *        tag:key=value - The key/value
     *        combination of a tag assigned to the resource.
     *        
     *         
     *        - 
     *        
     *        tag-key - The key of a tag assigned to the resource.
     *        This filter is independent of the tag-value filter.
     *        For example, if you use both the filter "tag-key=Purpose" and the
     *        filter "tag-value=X", you get any resources assigned both the tag
     *        key Purpose (regardless of what the tag's value is), and the tag
     *        value X (regardless of what the tag's key is). If you want to list
     *        only resources where Purpose is X, see the tag
     *        :key=value filter.
     *        
     *         
     *        - 
     *        
     *        tag-value - The value of a tag assigned to the
     *        resource. This filter is independent of the tag-key
     *        filter.
     *        
     *         
     *        - 
     *        
     *        vpc-id - The ID of the VPC that the instance is
     *        linked to.
     *        
     *         
     */
    public void setFilters(java.util.Collection filters) {
        if (filters == null) {
            this.filters = null;
            return;
        }
        this.filters = new com.amazonaws.internal.SdkInternalList(
                filters);
    }
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * group-id - The ID of a VPC security group that's associated
     * with the instance.
     * 
     *  
     * - 
     * 
     * instance-id - The ID of the instance.
     * 
     *  
     * - 
     * 
     * tag:key=value - The key/value combination of a
     * tag assigned to the resource.
     * 
     *  
     * - 
     * 
     * tag-key - The key of a tag assigned to the resource. This
     * filter is independent of the tag-value filter. For example,
     * if you use both the filter "tag-key=Purpose" and the filter
     * "tag-value=X", you get any resources assigned both the tag key Purpose
     * (regardless of what the tag's value is), and the tag value X (regardless
     * of what the tag's key is). If you want to list only resources where
     * Purpose is X, see the tag:key=value filter.
     * 
     *  
     * - 
     * 
     * tag-value - The value of a tag assigned to the resource.
     * This filter is independent of the tag-key filter.
     * 
     *  
     * - 
     * 
     * vpc-id - The ID of the VPC that the instance is linked to.
     * 
     *  
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setFilters(java.util.Collection)} or
     * {@link #withFilters(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param filters
     *        One or more filters.
     *        
     *        - 
     *        
     *        group-id - The ID of a VPC security group that's
     *        associated with the instance.
     *        
     *         
     *        - 
     *        
     *        instance-id - The ID of the instance.
     *        
     *         
     *        - 
     *        
     *        tag:key=value - The key/value
     *        combination of a tag assigned to the resource.
     *        
     *         
     *        - 
     *        
     *        tag-key - The key of a tag assigned to the resource.
     *        This filter is independent of the tag-value filter.
     *        For example, if you use both the filter "tag-key=Purpose" and the
     *        filter "tag-value=X", you get any resources assigned both the tag
     *        key Purpose (regardless of what the tag's value is), and the tag
     *        value X (regardless of what the tag's key is). If you want to list
     *        only resources where Purpose is X, see the tag
     *        :key=value filter.
     *        
     *         
     *        - 
     *        
     *        tag-value - The value of a tag assigned to the
     *        resource. This filter is independent of the tag-key
     *        filter.
     *        
     *         
     *        - 
     *        
     *        vpc-id - The ID of the VPC that the instance is
     *        linked to.
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeClassicLinkInstancesRequest withFilters(Filter... filters) {
        if (this.filters == null) {
            setFilters(new com.amazonaws.internal.SdkInternalList(
                    filters.length));
        }
        for (Filter ele : filters) {
            this.filters.add(ele);
        }
        return this;
    }
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * group-id - The ID of a VPC security group that's associated
     * with the instance.
     * 
     *  
     * - 
     * 
     * instance-id - The ID of the instance.
     * 
     *  
     * - 
     * 
     * tag:key=value - The key/value combination of a
     * tag assigned to the resource.
     * 
     *  
     * - 
     * 
     * tag-key - The key of a tag assigned to the resource. This
     * filter is independent of the tag-value filter. For example,
     * if you use both the filter "tag-key=Purpose" and the filter
     * "tag-value=X", you get any resources assigned both the tag key Purpose
     * (regardless of what the tag's value is), and the tag value X (regardless
     * of what the tag's key is). If you want to list only resources where
     * Purpose is X, see the tag:key=value filter.
     * 
     *  
     * - 
     * 
     * tag-value - The value of a tag assigned to the resource.
     * This filter is independent of the tag-key filter.
     * 
     *  
     * - 
     * 
     * vpc-id - The ID of the VPC that the instance is linked to.
     * 
     *  
     * 
     * 
     * @param filters
     *        One or more filters.
     *        
     *        - 
     *        
     *        group-id - The ID of a VPC security group that's
     *        associated with the instance.
     *        
     *         
     *        - 
     *        
     *        instance-id - The ID of the instance.
     *        
     *         
     *        - 
     *        
     *        tag:key=value - The key/value
     *        combination of a tag assigned to the resource.
     *        
     *         
     *        - 
     *        
     *        tag-key - The key of a tag assigned to the resource.
     *        This filter is independent of the tag-value filter.
     *        For example, if you use both the filter "tag-key=Purpose" and the
     *        filter "tag-value=X", you get any resources assigned both the tag
     *        key Purpose (regardless of what the tag's value is), and the tag
     *        value X (regardless of what the tag's key is). If you want to list
     *        only resources where Purpose is X, see the tag
     *        :key=value filter.
     *        
     *         
     *        - 
     *        
     *        tag-value - The value of a tag assigned to the
     *        resource. This filter is independent of the tag-key
     *        filter.
     *        
     *         
     *        - 
     *        
     *        vpc-id - The ID of the VPC that the instance is
     *        linked to.
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeClassicLinkInstancesRequest withFilters(
            java.util.Collection filters) {
        setFilters(filters);
        return this;
    }
    /**
     * 
     * The token to retrieve the next page of results.
     * 
     * 
     * @param nextToken
     *        The token to retrieve the next page of results.
     */
    public void setNextToken(String nextToken) {
        this.nextToken = nextToken;
    }
    /**
     * 
     * The token to retrieve the next page of results.
     * 
     * 
     * @return The token to retrieve the next page of results.
     */
    public String getNextToken() {
        return this.nextToken;
    }
    /**
     * 
     * The token to retrieve the next page of results.
     * 
     * 
     * @param nextToken
     *        The token to retrieve the next page of results.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeClassicLinkInstancesRequest withNextToken(String nextToken) {
        setNextToken(nextToken);
        return this;
    }
    /**
     * 
     * The maximum number of results to return for the request in a single page.
     * The remaining results of the initial request can be seen by sending
     * another request with the returned NextToken value. This
     * value can be between 5 and 1000; if MaxResults is given a
     * value larger than 1000, only 1000 results are returned. You cannot
     * specify this parameter and the instance IDs parameter in the same
     * request.
     * 
     * 
     * Constraint: If the value is greater than 1000, we return only 1000 items.
     * 
     * 
     * @param maxResults
     *        The maximum number of results to return for the request in a
     *        single page. The remaining results of the initial request can be
     *        seen by sending another request with the returned
     *        NextToken value. This value can be between 5 and
     *        1000; if MaxResults is given a value larger than
     *        1000, only 1000 results are returned. You cannot specify this
     *        parameter and the instance IDs parameter in the same request.
     *        
     *        Constraint: If the value is greater than 1000, we return only 1000
     *        items.
     */
    public void setMaxResults(Integer maxResults) {
        this.maxResults = maxResults;
    }
    /**
     * 
     * The maximum number of results to return for the request in a single page.
     * The remaining results of the initial request can be seen by sending
     * another request with the returned NextToken value. This
     * value can be between 5 and 1000; if MaxResults is given a
     * value larger than 1000, only 1000 results are returned. You cannot
     * specify this parameter and the instance IDs parameter in the same
     * request.
     * 
     * 
     * Constraint: If the value is greater than 1000, we return only 1000 items.
     * 
     * 
     * @return The maximum number of results to return for the request in a
     *         single page. The remaining results of the initial request can be
     *         seen by sending another request with the returned
     *         NextToken value. This value can be between 5 and
     *         1000; if MaxResults is given a value larger than
     *         1000, only 1000 results are returned. You cannot specify this
     *         parameter and the instance IDs parameter in the same request.
     *         
     *         Constraint: If the value is greater than 1000, we return only
     *         1000 items.
     */
    public Integer getMaxResults() {
        return this.maxResults;
    }
    /**
     * 
     * The maximum number of results to return for the request in a single page.
     * The remaining results of the initial request can be seen by sending
     * another request with the returned NextToken value. This
     * value can be between 5 and 1000; if MaxResults is given a
     * value larger than 1000, only 1000 results are returned. You cannot
     * specify this parameter and the instance IDs parameter in the same
     * request.
     * 
     * 
     * Constraint: If the value is greater than 1000, we return only 1000 items.
     * 
     * 
     * @param maxResults
     *        The maximum number of results to return for the request in a
     *        single page. The remaining results of the initial request can be
     *        seen by sending another request with the returned
     *        NextToken value. This value can be between 5 and
     *        1000; if MaxResults is given a value larger than
     *        1000, only 1000 results are returned. You cannot specify this
     *        parameter and the instance IDs parameter in the same request.
     *        
     *        Constraint: If the value is greater than 1000, we return only 1000
     *        items.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeClassicLinkInstancesRequest withMaxResults(Integer maxResults) {
        setMaxResults(maxResults);
        return this;
    }
    /**
     * This method is intended for internal use only. Returns the marshaled
     * request configured with additional parameters to enable operation
     * dry-run.
     */
    @Override
    public Request getDryRunRequest() {
        Request request = new DescribeClassicLinkInstancesRequestMarshaller()
                .marshall(this);
        request.addParameter("DryRun", Boolean.toString(true));
        return request;
    }
    /**
     * 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 (getInstanceIds() != null)
            sb.append("InstanceIds: " + getInstanceIds() + ",");
        if (getFilters() != null)
            sb.append("Filters: " + getFilters() + ",");
        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 DescribeClassicLinkInstancesRequest == false)
            return false;
        DescribeClassicLinkInstancesRequest other = (DescribeClassicLinkInstancesRequest) obj;
        if (other.getInstanceIds() == null ^ this.getInstanceIds() == null)
            return false;
        if (other.getInstanceIds() != null
                && other.getInstanceIds().equals(this.getInstanceIds()) == false)
            return false;
        if (other.getFilters() == null ^ this.getFilters() == null)
            return false;
        if (other.getFilters() != null
                && other.getFilters().equals(this.getFilters()) == 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
                + ((getInstanceIds() == null) ? 0 : getInstanceIds().hashCode());
        hashCode = prime * hashCode
                + ((getFilters() == null) ? 0 : getFilters().hashCode());
        hashCode = prime * hashCode
                + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
        hashCode = prime * hashCode
                + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
        return hashCode;
    }
    @Override
    public DescribeClassicLinkInstancesRequest clone() {
        return (DescribeClassicLinkInstancesRequest) super.clone();
    }
}