GetEC2InstanceRecommendationsRequest.java

/*
 * Copyright 2020-2025 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.computeoptimizer.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/compute-optimizer-2019-11-01/GetEC2InstanceRecommendations"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetEC2InstanceRecommendationsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     * </p>
     */
    private java.util.List<String> instanceArns;
    /**
     * <p>
     * The token to advance to the next page of instance recommendations.
     * </p>
     */
    private String nextToken;
    /**
     * <p>
     * The maximum number of instance recommendations to return with a single request.
     * </p>
     * <p>
     * To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.
     * </p>
     */
    private Integer maxResults;
    /**
     * <p>
     * An array of objects to specify a filter that returns a more specific list of instance recommendations.
     * </p>
     */
    private java.util.List<Filter> filters;
    /**
     * <p>
     * The ID of the Amazon Web Services account for which to return instance recommendations.
     * </p>
     * <p>
     * If your account is the management account of an organization, use this parameter to specify the member account
     * for which you want to return instance recommendations.
     * </p>
     * <p>
     * Only one account ID can be specified per request.
     * </p>
     */
    private java.util.List<String> accountIds;
    /**
     * <p>
     * An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
     * </p>
     */
    private RecommendationPreferences recommendationPreferences;

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     * </p>
     * 
     * @return The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     */

    public java.util.List<String> getInstanceArns() {
        return instanceArns;
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     * </p>
     * 
     * @param instanceArns
     *        The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     */

    public void setInstanceArns(java.util.Collection<String> instanceArns) {
        if (instanceArns == null) {
            this.instanceArns = null;
            return;
        }

        this.instanceArns = new java.util.ArrayList<String>(instanceArns);
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setInstanceArns(java.util.Collection)} or {@link #withInstanceArns(java.util.Collection)} if you want to
     * override the existing values.
     * </p>
     * 
     * @param instanceArns
     *        The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withInstanceArns(String... instanceArns) {
        if (this.instanceArns == null) {
            setInstanceArns(new java.util.ArrayList<String>(instanceArns.length));
        }
        for (String ele : instanceArns) {
            this.instanceArns.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     * </p>
     * 
     * @param instanceArns
     *        The Amazon Resource Name (ARN) of the instances for which to return recommendations.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withInstanceArns(java.util.Collection<String> instanceArns) {
        setInstanceArns(instanceArns);
        return this;
    }

    /**
     * <p>
     * The token to advance to the next page of instance recommendations.
     * </p>
     * 
     * @param nextToken
     *        The token to advance to the next page of instance recommendations.
     */

    public void setNextToken(String nextToken) {
        this.nextToken = nextToken;
    }

    /**
     * <p>
     * The token to advance to the next page of instance recommendations.
     * </p>
     * 
     * @return The token to advance to the next page of instance recommendations.
     */

    public String getNextToken() {
        return this.nextToken;
    }

    /**
     * <p>
     * The token to advance to the next page of instance recommendations.
     * </p>
     * 
     * @param nextToken
     *        The token to advance to the next page of instance recommendations.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withNextToken(String nextToken) {
        setNextToken(nextToken);
        return this;
    }

    /**
     * <p>
     * The maximum number of instance recommendations to return with a single request.
     * </p>
     * <p>
     * To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.
     * </p>
     * 
     * @param maxResults
     *        The maximum number of instance recommendations to return with a single request.</p>
     *        <p>
     *        To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.
     */

    public void setMaxResults(Integer maxResults) {
        this.maxResults = maxResults;
    }

    /**
     * <p>
     * The maximum number of instance recommendations to return with a single request.
     * </p>
     * <p>
     * To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.
     * </p>
     * 
     * @return The maximum number of instance recommendations to return with a single request.</p>
     *         <p>
     *         To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.
     */

    public Integer getMaxResults() {
        return this.maxResults;
    }

    /**
     * <p>
     * The maximum number of instance recommendations to return with a single request.
     * </p>
     * <p>
     * To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.
     * </p>
     * 
     * @param maxResults
     *        The maximum number of instance recommendations to return with a single request.</p>
     *        <p>
     *        To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withMaxResults(Integer maxResults) {
        setMaxResults(maxResults);
        return this;
    }

    /**
     * <p>
     * An array of objects to specify a filter that returns a more specific list of instance recommendations.
     * </p>
     * 
     * @return An array of objects to specify a filter that returns a more specific list of instance recommendations.
     */

    public java.util.List<Filter> getFilters() {
        return filters;
    }

    /**
     * <p>
     * An array of objects to specify a filter that returns a more specific list of instance recommendations.
     * </p>
     * 
     * @param filters
     *        An array of objects to specify a filter that returns a more specific list of instance recommendations.
     */

    public void setFilters(java.util.Collection<Filter> filters) {
        if (filters == null) {
            this.filters = null;
            return;
        }

        this.filters = new java.util.ArrayList<Filter>(filters);
    }

    /**
     * <p>
     * An array of objects to specify a filter that returns a more specific list of instance recommendations.
     * </p>
     * <p>
     * <b>NOTE:</b> 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.
     * </p>
     * 
     * @param filters
     *        An array of objects to specify a filter that returns a more specific list of instance recommendations.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withFilters(Filter... filters) {
        if (this.filters == null) {
            setFilters(new java.util.ArrayList<Filter>(filters.length));
        }
        for (Filter ele : filters) {
            this.filters.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * An array of objects to specify a filter that returns a more specific list of instance recommendations.
     * </p>
     * 
     * @param filters
     *        An array of objects to specify a filter that returns a more specific list of instance recommendations.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withFilters(java.util.Collection<Filter> filters) {
        setFilters(filters);
        return this;
    }

    /**
     * <p>
     * The ID of the Amazon Web Services account for which to return instance recommendations.
     * </p>
     * <p>
     * If your account is the management account of an organization, use this parameter to specify the member account
     * for which you want to return instance recommendations.
     * </p>
     * <p>
     * Only one account ID can be specified per request.
     * </p>
     * 
     * @return The ID of the Amazon Web Services account for which to return instance recommendations.</p>
     *         <p>
     *         If your account is the management account of an organization, use this parameter to specify the member
     *         account for which you want to return instance recommendations.
     *         </p>
     *         <p>
     *         Only one account ID can be specified per request.
     */

    public java.util.List<String> getAccountIds() {
        return accountIds;
    }

    /**
     * <p>
     * The ID of the Amazon Web Services account for which to return instance recommendations.
     * </p>
     * <p>
     * If your account is the management account of an organization, use this parameter to specify the member account
     * for which you want to return instance recommendations.
     * </p>
     * <p>
     * Only one account ID can be specified per request.
     * </p>
     * 
     * @param accountIds
     *        The ID of the Amazon Web Services account for which to return instance recommendations.</p>
     *        <p>
     *        If your account is the management account of an organization, use this parameter to specify the member
     *        account for which you want to return instance recommendations.
     *        </p>
     *        <p>
     *        Only one account ID can be specified per request.
     */

    public void setAccountIds(java.util.Collection<String> accountIds) {
        if (accountIds == null) {
            this.accountIds = null;
            return;
        }

        this.accountIds = new java.util.ArrayList<String>(accountIds);
    }

    /**
     * <p>
     * The ID of the Amazon Web Services account for which to return instance recommendations.
     * </p>
     * <p>
     * If your account is the management account of an organization, use this parameter to specify the member account
     * for which you want to return instance recommendations.
     * </p>
     * <p>
     * Only one account ID can be specified per request.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setAccountIds(java.util.Collection)} or {@link #withAccountIds(java.util.Collection)} if you want to
     * override the existing values.
     * </p>
     * 
     * @param accountIds
     *        The ID of the Amazon Web Services account for which to return instance recommendations.</p>
     *        <p>
     *        If your account is the management account of an organization, use this parameter to specify the member
     *        account for which you want to return instance recommendations.
     *        </p>
     *        <p>
     *        Only one account ID can be specified per request.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withAccountIds(String... accountIds) {
        if (this.accountIds == null) {
            setAccountIds(new java.util.ArrayList<String>(accountIds.length));
        }
        for (String ele : accountIds) {
            this.accountIds.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * The ID of the Amazon Web Services account for which to return instance recommendations.
     * </p>
     * <p>
     * If your account is the management account of an organization, use this parameter to specify the member account
     * for which you want to return instance recommendations.
     * </p>
     * <p>
     * Only one account ID can be specified per request.
     * </p>
     * 
     * @param accountIds
     *        The ID of the Amazon Web Services account for which to return instance recommendations.</p>
     *        <p>
     *        If your account is the management account of an organization, use this parameter to specify the member
     *        account for which you want to return instance recommendations.
     *        </p>
     *        <p>
     *        Only one account ID can be specified per request.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withAccountIds(java.util.Collection<String> accountIds) {
        setAccountIds(accountIds);
        return this;
    }

    /**
     * <p>
     * An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
     * </p>
     * 
     * @param recommendationPreferences
     *        An object to specify the preferences for the Amazon EC2 instance recommendations to return in the
     *        response.
     */

    public void setRecommendationPreferences(RecommendationPreferences recommendationPreferences) {
        this.recommendationPreferences = recommendationPreferences;
    }

    /**
     * <p>
     * An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
     * </p>
     * 
     * @return An object to specify the preferences for the Amazon EC2 instance recommendations to return in the
     *         response.
     */

    public RecommendationPreferences getRecommendationPreferences() {
        return this.recommendationPreferences;
    }

    /**
     * <p>
     * An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
     * </p>
     * 
     * @param recommendationPreferences
     *        An object to specify the preferences for the Amazon EC2 instance recommendations to return in the
     *        response.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GetEC2InstanceRecommendationsRequest withRecommendationPreferences(RecommendationPreferences recommendationPreferences) {
        setRecommendationPreferences(recommendationPreferences);
        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 (getInstanceArns() != null)
            sb.append("InstanceArns: ").append(getInstanceArns()).append(",");
        if (getNextToken() != null)
            sb.append("NextToken: ").append(getNextToken()).append(",");
        if (getMaxResults() != null)
            sb.append("MaxResults: ").append(getMaxResults()).append(",");
        if (getFilters() != null)
            sb.append("Filters: ").append(getFilters()).append(",");
        if (getAccountIds() != null)
            sb.append("AccountIds: ").append(getAccountIds()).append(",");
        if (getRecommendationPreferences() != null)
            sb.append("RecommendationPreferences: ").append(getRecommendationPreferences());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof GetEC2InstanceRecommendationsRequest == false)
            return false;
        GetEC2InstanceRecommendationsRequest other = (GetEC2InstanceRecommendationsRequest) obj;
        if (other.getInstanceArns() == null ^ this.getInstanceArns() == null)
            return false;
        if (other.getInstanceArns() != null && other.getInstanceArns().equals(this.getInstanceArns()) == 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;
        if (other.getFilters() == null ^ this.getFilters() == null)
            return false;
        if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
            return false;
        if (other.getAccountIds() == null ^ this.getAccountIds() == null)
            return false;
        if (other.getAccountIds() != null && other.getAccountIds().equals(this.getAccountIds()) == false)
            return false;
        if (other.getRecommendationPreferences() == null ^ this.getRecommendationPreferences() == null)
            return false;
        if (other.getRecommendationPreferences() != null && other.getRecommendationPreferences().equals(this.getRecommendationPreferences()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getInstanceArns() == null) ? 0 : getInstanceArns().hashCode());
        hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
        hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
        hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
        hashCode = prime * hashCode + ((getAccountIds() == null) ? 0 : getAccountIds().hashCode());
        hashCode = prime * hashCode + ((getRecommendationPreferences() == null) ? 0 : getRecommendationPreferences().hashCode());
        return hashCode;
    }

    @Override
    public GetEC2InstanceRecommendationsRequest clone() {
        return (GetEC2InstanceRecommendationsRequest) super.clone();
    }

}