/* * Copyright 2018-2023 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 AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ExportEC2InstanceRecommendationsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The IDs of the Amazon Web Services accounts for which to export instance recommendations. *
** If your account is the management account of an organization, use this parameter to specify the member account * for which you want to export recommendations. *
** This parameter cannot be specified together with the include member accounts parameter. The parameters are * mutually exclusive. *
** Recommendations for member accounts are not included in the export if this parameter, or the include member * accounts parameter, is omitted. *
** You can specify multiple account IDs per request. *
*/ private java.util.List* An array of objects to specify a filter that exports a more specific set of instance recommendations. *
*/ private java.util.List* The recommendations data to include in the export file. For more information about the fields that can be * exported, see Exported files in the Compute Optimizer User Guide. *
*/ private java.util.List* An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the * export job. *
** You must create the destination Amazon S3 bucket for your recommendations export before you create the export * job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has * the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify * an object prefix when you create the export job, you must include the object prefix in the policy that you add to * the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide. *
*/ private S3DestinationConfig s3DestinationConfig; /** ** The format of the export file. *
*
* The only export file format currently supported is Csv
.
*
* Indicates whether to include recommendations for resources in all member accounts of the organization if your * account is the management account of an organization. *
** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be * enabled in the organization account. For more information, see Compute * Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this parameter is * omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. *
*/ private Boolean includeMemberAccounts; /** ** An object to specify the preferences for the Amazon EC2 instance recommendations to export. *
*/ private RecommendationPreferences recommendationPreferences; /** ** The IDs of the Amazon Web Services accounts for which to export instance recommendations. *
** If your account is the management account of an organization, use this parameter to specify the member account * for which you want to export recommendations. *
** This parameter cannot be specified together with the include member accounts parameter. The parameters are * mutually exclusive. *
** Recommendations for member accounts are not included in the export if this parameter, or the include member * accounts parameter, is omitted. *
** You can specify multiple account IDs per request. *
* * @return The IDs of the Amazon Web Services accounts for which to export instance recommendations. ** If your account is the management account of an organization, use this parameter to specify the member * account for which you want to export recommendations. *
** This parameter cannot be specified together with the include member accounts parameter. The parameters * are mutually exclusive. *
** Recommendations for member accounts are not included in the export if this parameter, or the include * member accounts parameter, is omitted. *
*
* You can specify multiple account IDs per request.
*/
public java.util.List
* The IDs of the Amazon Web Services accounts for which to export instance recommendations.
*
* If your account is the management account of an organization, use this parameter to specify the member account
* for which you want to export recommendations.
*
* This parameter cannot be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
* Recommendations for member accounts are not included in the export if this parameter, or the include member
* accounts parameter, is omitted.
*
* You can specify multiple account IDs per request.
*
* If your account is the management account of an organization, use this parameter to specify the member * account for which you want to export recommendations. *
** This parameter cannot be specified together with the include member accounts parameter. The parameters are * mutually exclusive. *
** Recommendations for member accounts are not included in the export if this parameter, or the include * member accounts parameter, is omitted. *
*
* You can specify multiple account IDs per request.
*/
public void setAccountIds(java.util.Collection
* The IDs of the Amazon Web Services accounts for which to export instance recommendations.
*
* If your account is the management account of an organization, use this parameter to specify the member account
* for which you want to export recommendations.
*
* This parameter cannot be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
* Recommendations for member accounts are not included in the export if this parameter, or the include member
* accounts parameter, is omitted.
*
* You can specify multiple account IDs per request.
*
* NOTE: 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.
*
* If your account is the management account of an organization, use this parameter to specify the member * account for which you want to export recommendations. *
** This parameter cannot be specified together with the include member accounts parameter. The parameters are * mutually exclusive. *
** Recommendations for member accounts are not included in the export if this parameter, or the include * member accounts parameter, is omitted. *
*
* You can specify multiple account IDs per request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportEC2InstanceRecommendationsRequest withAccountIds(String... accountIds) {
if (this.accountIds == null) {
setAccountIds(new java.util.ArrayList
* The IDs of the Amazon Web Services accounts for which to export instance recommendations.
*
* If your account is the management account of an organization, use this parameter to specify the member account
* for which you want to export recommendations.
*
* This parameter cannot be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
* Recommendations for member accounts are not included in the export if this parameter, or the include member
* accounts parameter, is omitted.
*
* You can specify multiple account IDs per request.
*
* If your account is the management account of an organization, use this parameter to specify the member * account for which you want to export recommendations. *
** This parameter cannot be specified together with the include member accounts parameter. The parameters are * mutually exclusive. *
** Recommendations for member accounts are not included in the export if this parameter, or the include * member accounts parameter, is omitted. *
*
* You can specify multiple account IDs per request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportEC2InstanceRecommendationsRequest withAccountIds(java.util.Collection
* An array of objects to specify a filter that exports a more specific set of instance recommendations.
*
* An array of objects to specify a filter that exports a more specific set of instance recommendations.
*
* An array of objects to specify a filter that exports a more specific set of instance recommendations.
*
* 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.
*
* An array of objects to specify a filter that exports a more specific set of instance recommendations.
*
* The recommendations data to include in the export file. For more information about the fields that can be
* exported, see Exported files in the Compute Optimizer User Guide.
*
* The recommendations data to include in the export file. For more information about the fields that can be
* exported, see Exported files in the Compute Optimizer User Guide.
*
* The recommendations data to include in the export file. For more information about the fields that can be
* exported, see Exported files in the Compute Optimizer User Guide.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFieldsToExport(java.util.Collection)} or {@link #withFieldsToExport(java.util.Collection)} if you want
* to override the existing values.
*
* The recommendations data to include in the export file. For more information about the fields that can be
* exported, see Exported files in the Compute Optimizer User Guide.
*
* The recommendations data to include in the export file. For more information about the fields that can be
* exported, see Exported files in the Compute Optimizer User Guide.
*
* An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the
* export job.
*
* You must create the destination Amazon S3 bucket for your recommendations export before you create the export
* job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has
* the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify
* an object prefix when you create the export job, you must include the object prefix in the policy that you add to
* the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
*
* You must create the destination Amazon S3 bucket for your recommendations export before you create the * export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, * ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to * it. If you plan to specify an object prefix when you create the export job, you must include the object * prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide. */ public void setS3DestinationConfig(S3DestinationConfig s3DestinationConfig) { this.s3DestinationConfig = s3DestinationConfig; } /** *
* An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the * export job. *
** You must create the destination Amazon S3 bucket for your recommendations export before you create the export * job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has * the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify * an object prefix when you create the export job, you must include the object prefix in the policy that you add to * the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide. *
* * @return An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix * for the export job. ** You must create the destination Amazon S3 bucket for your recommendations export before you create the * export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, * ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to * it. If you plan to specify an object prefix when you create the export job, you must include the object * prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide. */ public S3DestinationConfig getS3DestinationConfig() { return this.s3DestinationConfig; } /** *
* An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the * export job. *
** You must create the destination Amazon S3 bucket for your recommendations export before you create the export * job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has * the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify * an object prefix when you create the export job, you must include the object prefix in the policy that you add to * the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide. *
* * @param s3DestinationConfig * An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix * for the export job. ** You must create the destination Amazon S3 bucket for your recommendations export before you create the * export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, * ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to * it. If you plan to specify an object prefix when you create the export job, you must include the object * prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ExportEC2InstanceRecommendationsRequest withS3DestinationConfig(S3DestinationConfig s3DestinationConfig) { setS3DestinationConfig(s3DestinationConfig); return this; } /** *
* The format of the export file. *
*
* The only export file format currently supported is Csv
.
*
* The only export file format currently supported is Csv
.
* @see FileFormat
*/
public void setFileFormat(String fileFormat) {
this.fileFormat = fileFormat;
}
/**
*
* The format of the export file. *
*
* The only export file format currently supported is Csv
.
*
* The only export file format currently supported is Csv
.
* @see FileFormat
*/
public String getFileFormat() {
return this.fileFormat;
}
/**
*
* The format of the export file. *
*
* The only export file format currently supported is Csv
.
*
* The only export file format currently supported is Csv
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileFormat
*/
public ExportEC2InstanceRecommendationsRequest withFileFormat(String fileFormat) {
setFileFormat(fileFormat);
return this;
}
/**
*
* The format of the export file. *
*
* The only export file format currently supported is Csv
.
*
* The only export file format currently supported is Csv
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileFormat
*/
public ExportEC2InstanceRecommendationsRequest withFileFormat(FileFormat fileFormat) {
this.fileFormat = fileFormat.toString();
return this;
}
/**
*
* Indicates whether to include recommendations for resources in all member accounts of the organization if your * account is the management account of an organization. *
** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be * enabled in the organization account. For more information, see Compute * Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this parameter is * omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. *
* * @param includeMemberAccounts * Indicates whether to include recommendations for resources in all member accounts of the organization if * your account is the management account of an organization. ** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer * must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer * User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this * parameter is omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. */ public void setIncludeMemberAccounts(Boolean includeMemberAccounts) { this.includeMemberAccounts = includeMemberAccounts; } /** *
* Indicates whether to include recommendations for resources in all member accounts of the organization if your * account is the management account of an organization. *
** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be * enabled in the organization account. For more information, see Compute * Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this parameter is * omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. *
* * @return Indicates whether to include recommendations for resources in all member accounts of the organization if * your account is the management account of an organization. ** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer * must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer * User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this * parameter is omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. */ public Boolean getIncludeMemberAccounts() { return this.includeMemberAccounts; } /** *
* Indicates whether to include recommendations for resources in all member accounts of the organization if your * account is the management account of an organization. *
** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be * enabled in the organization account. For more information, see Compute * Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this parameter is * omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. *
* * @param includeMemberAccounts * Indicates whether to include recommendations for resources in all member accounts of the organization if * your account is the management account of an organization. ** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer * must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer * User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this * parameter is omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. * @return Returns a reference to this object so that method calls can be chained together. */ public ExportEC2InstanceRecommendationsRequest withIncludeMemberAccounts(Boolean includeMemberAccounts) { setIncludeMemberAccounts(includeMemberAccounts); return this; } /** *
* Indicates whether to include recommendations for resources in all member accounts of the organization if your * account is the management account of an organization. *
** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be * enabled in the organization account. For more information, see Compute * Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this parameter is * omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. *
* * @return Indicates whether to include recommendations for resources in all member accounts of the organization if * your account is the management account of an organization. ** The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer * must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer * User Guide. *
** Recommendations for member accounts of the organization are not included in the export file if this * parameter is omitted. *
** Recommendations for member accounts are not included in the export if this parameter, or the account IDs * parameter, is omitted. */ public Boolean isIncludeMemberAccounts() { return this.includeMemberAccounts; } /** *
* An object to specify the preferences for the Amazon EC2 instance recommendations to export. *
* * @param recommendationPreferences * An object to specify the preferences for the Amazon EC2 instance recommendations to export. */ public void setRecommendationPreferences(RecommendationPreferences recommendationPreferences) { this.recommendationPreferences = recommendationPreferences; } /** ** An object to specify the preferences for the Amazon EC2 instance recommendations to export. *
* * @return An object to specify the preferences for the Amazon EC2 instance recommendations to export. */ public RecommendationPreferences getRecommendationPreferences() { return this.recommendationPreferences; } /** ** An object to specify the preferences for the Amazon EC2 instance recommendations to export. *
* * @param recommendationPreferences * An object to specify the preferences for the Amazon EC2 instance recommendations to export. * @return Returns a reference to this object so that method calls can be chained together. */ public ExportEC2InstanceRecommendationsRequest 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 (getAccountIds() != null) sb.append("AccountIds: ").append(getAccountIds()).append(","); if (getFilters() != null) sb.append("Filters: ").append(getFilters()).append(","); if (getFieldsToExport() != null) sb.append("FieldsToExport: ").append(getFieldsToExport()).append(","); if (getS3DestinationConfig() != null) sb.append("S3DestinationConfig: ").append(getS3DestinationConfig()).append(","); if (getFileFormat() != null) sb.append("FileFormat: ").append(getFileFormat()).append(","); if (getIncludeMemberAccounts() != null) sb.append("IncludeMemberAccounts: ").append(getIncludeMemberAccounts()).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 ExportEC2InstanceRecommendationsRequest == false) return false; ExportEC2InstanceRecommendationsRequest other = (ExportEC2InstanceRecommendationsRequest) obj; if (other.getAccountIds() == null ^ this.getAccountIds() == null) return false; if (other.getAccountIds() != null && other.getAccountIds().equals(this.getAccountIds()) == 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.getFieldsToExport() == null ^ this.getFieldsToExport() == null) return false; if (other.getFieldsToExport() != null && other.getFieldsToExport().equals(this.getFieldsToExport()) == false) return false; if (other.getS3DestinationConfig() == null ^ this.getS3DestinationConfig() == null) return false; if (other.getS3DestinationConfig() != null && other.getS3DestinationConfig().equals(this.getS3DestinationConfig()) == false) return false; if (other.getFileFormat() == null ^ this.getFileFormat() == null) return false; if (other.getFileFormat() != null && other.getFileFormat().equals(this.getFileFormat()) == false) return false; if (other.getIncludeMemberAccounts() == null ^ this.getIncludeMemberAccounts() == null) return false; if (other.getIncludeMemberAccounts() != null && other.getIncludeMemberAccounts().equals(this.getIncludeMemberAccounts()) == 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 + ((getAccountIds() == null) ? 0 : getAccountIds().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getFieldsToExport() == null) ? 0 : getFieldsToExport().hashCode()); hashCode = prime * hashCode + ((getS3DestinationConfig() == null) ? 0 : getS3DestinationConfig().hashCode()); hashCode = prime * hashCode + ((getFileFormat() == null) ? 0 : getFileFormat().hashCode()); hashCode = prime * hashCode + ((getIncludeMemberAccounts() == null) ? 0 : getIncludeMemberAccounts().hashCode()); hashCode = prime * hashCode + ((getRecommendationPreferences() == null) ? 0 : getRecommendationPreferences().hashCode()); return hashCode; } @Override public ExportEC2InstanceRecommendationsRequest clone() { return (ExportEC2InstanceRecommendationsRequest) super.clone(); } }