com.amazonaws.services.computeoptimizer.model.ExportECSServiceRecommendationsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-computeoptimizer Show documentation
/*
* Copyright 2019-2024 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 ExportECSServiceRecommendationsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
*
* If your account is the management account or the delegated administrator of an organization, use this parameter
* to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts
* aren't included in the export.
*
*
* You can specify multiple account IDs per request.
*
*/
private java.util.List accountIds;
/**
*
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.
*
*/
private java.util.List filters;
/**
*
* 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 fieldsToExport;
private S3DestinationConfig s3DestinationConfig;
/**
*
* The format of the export file.
*
*
* The CSV file is the only export file format currently supported.
*
*/
private String fileFormat;
/**
*
* If your account is the management account or the delegated administrator of an organization, this parameter
* indicates whether to include recommendations for resources in all member accounts of the 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in the
* export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in
* the export.
*
*/
private Boolean includeMemberAccounts;
/**
*
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
*
* If your account is the management account or the delegated administrator of an organization, use this parameter
* to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts
* aren't included in the export.
*
*
* You can specify multiple account IDs per request.
*
*
* @return The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
* If your account is the management account or the delegated administrator of an organization, use this
* parameter to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member
* accounts aren't included in the export.
*
*
* You can specify multiple account IDs per request.
*/
public java.util.List getAccountIds() {
return accountIds;
}
/**
*
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
*
* If your account is the management account or the delegated administrator of an organization, use this parameter
* to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts
* aren't included in the export.
*
*
* You can specify multiple account IDs per request.
*
*
* @param accountIds
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
* If your account is the management account or the delegated administrator of an organization, use this
* parameter to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member
* accounts aren't included in the export.
*
*
* You can specify multiple account IDs per request.
*/
public void setAccountIds(java.util.Collection accountIds) {
if (accountIds == null) {
this.accountIds = null;
return;
}
this.accountIds = new java.util.ArrayList(accountIds);
}
/**
*
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
*
* If your account is the management account or the delegated administrator of an organization, use this parameter
* to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts
* aren't included in the export.
*
*
* 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.
*
*
* @param accountIds
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
* If your account is the management account or the delegated administrator of an organization, use this
* parameter to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member
* accounts aren't included in the export.
*
*
* You can specify multiple account IDs per request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportECSServiceRecommendationsRequest withAccountIds(String... accountIds) {
if (this.accountIds == null) {
setAccountIds(new java.util.ArrayList(accountIds.length));
}
for (String ele : accountIds) {
this.accountIds.add(ele);
}
return this;
}
/**
*
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
*
* If your account is the management account or the delegated administrator of an organization, use this parameter
* to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member accounts
* aren't included in the export.
*
*
* You can specify multiple account IDs per request.
*
*
* @param accountIds
* The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
*
* If your account is the management account or the delegated administrator of an organization, use this
* parameter to specify the member account you want to export recommendations to.
*
*
* This parameter can't be specified together with the include member accounts parameter. The parameters are
* mutually exclusive.
*
*
* If this parameter or the include member accounts parameter is omitted, the recommendations for member
* accounts aren't included in the export.
*
*
* You can specify multiple account IDs per request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportECSServiceRecommendationsRequest withAccountIds(java.util.Collection accountIds) {
setAccountIds(accountIds);
return this;
}
/**
*
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.
*
*
* @return An array of objects to specify a filter that exports a more specific set of Amazon ECS service
* recommendations.
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.
*
*
* @param filters
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service
* recommendations.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service 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.
*
*
* @param filters
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service
* recommendations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportECSServiceRecommendationsRequest withFilters(ECSServiceRecommendationFilter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (ECSServiceRecommendationFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service recommendations.
*
*
* @param filters
* An array of objects to specify a filter that exports a more specific set of Amazon ECS service
* recommendations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportECSServiceRecommendationsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* 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.
*
*
* @return 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.
* @see ExportableECSServiceField
*/
public java.util.List getFieldsToExport() {
return fieldsToExport;
}
/**
*
* 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.
*
*
* @param fieldsToExport
* 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.
* @see ExportableECSServiceField
*/
public void setFieldsToExport(java.util.Collection fieldsToExport) {
if (fieldsToExport == null) {
this.fieldsToExport = null;
return;
}
this.fieldsToExport = new java.util.ArrayList(fieldsToExport);
}
/**
*
* 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.
*
*
* @param fieldsToExport
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExportableECSServiceField
*/
public ExportECSServiceRecommendationsRequest withFieldsToExport(String... fieldsToExport) {
if (this.fieldsToExport == null) {
setFieldsToExport(new java.util.ArrayList(fieldsToExport.length));
}
for (String ele : fieldsToExport) {
this.fieldsToExport.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param fieldsToExport
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExportableECSServiceField
*/
public ExportECSServiceRecommendationsRequest withFieldsToExport(java.util.Collection fieldsToExport) {
setFieldsToExport(fieldsToExport);
return this;
}
/**
*
* 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.
*
*
* @param fieldsToExport
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExportableECSServiceField
*/
public ExportECSServiceRecommendationsRequest withFieldsToExport(ExportableECSServiceField... fieldsToExport) {
java.util.ArrayList fieldsToExportCopy = new java.util.ArrayList(fieldsToExport.length);
for (ExportableECSServiceField value : fieldsToExport) {
fieldsToExportCopy.add(value.toString());
}
if (getFieldsToExport() == null) {
setFieldsToExport(fieldsToExportCopy);
} else {
getFieldsToExport().addAll(fieldsToExportCopy);
}
return this;
}
/**
* @param s3DestinationConfig
*/
public void setS3DestinationConfig(S3DestinationConfig s3DestinationConfig) {
this.s3DestinationConfig = s3DestinationConfig;
}
/**
* @return
*/
public S3DestinationConfig getS3DestinationConfig() {
return this.s3DestinationConfig;
}
/**
* @param s3DestinationConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportECSServiceRecommendationsRequest withS3DestinationConfig(S3DestinationConfig s3DestinationConfig) {
setS3DestinationConfig(s3DestinationConfig);
return this;
}
/**
*
* The format of the export file.
*
*
* The CSV file is the only export file format currently supported.
*
*
* @param fileFormat
* The format of the export file.
*
* The CSV file is the only export file format currently supported.
* @see FileFormat
*/
public void setFileFormat(String fileFormat) {
this.fileFormat = fileFormat;
}
/**
*
* The format of the export file.
*
*
* The CSV file is the only export file format currently supported.
*
*
* @return The format of the export file.
*
* The CSV file is the only export file format currently supported.
* @see FileFormat
*/
public String getFileFormat() {
return this.fileFormat;
}
/**
*
* The format of the export file.
*
*
* The CSV file is the only export file format currently supported.
*
*
* @param fileFormat
* The format of the export file.
*
* The CSV file is the only export file format currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileFormat
*/
public ExportECSServiceRecommendationsRequest withFileFormat(String fileFormat) {
setFileFormat(fileFormat);
return this;
}
/**
*
* The format of the export file.
*
*
* The CSV file is the only export file format currently supported.
*
*
* @param fileFormat
* The format of the export file.
*
* The CSV file is the only export file format currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileFormat
*/
public ExportECSServiceRecommendationsRequest withFileFormat(FileFormat fileFormat) {
this.fileFormat = fileFormat.toString();
return this;
}
/**
*
* If your account is the management account or the delegated administrator of an organization, this parameter
* indicates whether to include recommendations for resources in all member accounts of the 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in the
* export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in
* the export.
*
*
* @param includeMemberAccounts
* If your account is the management account or the delegated administrator of an organization, this
* parameter indicates whether to include recommendations for resources in all member accounts of the
* 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in
* the export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't
* included in the export.
*/
public void setIncludeMemberAccounts(Boolean includeMemberAccounts) {
this.includeMemberAccounts = includeMemberAccounts;
}
/**
*
* If your account is the management account or the delegated administrator of an organization, this parameter
* indicates whether to include recommendations for resources in all member accounts of the 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in the
* export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in
* the export.
*
*
* @return If your account is the management account or the delegated administrator of an organization, this
* parameter indicates whether to include recommendations for resources in all member accounts of the
* 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in
* the export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't
* included in the export.
*/
public Boolean getIncludeMemberAccounts() {
return this.includeMemberAccounts;
}
/**
*
* If your account is the management account or the delegated administrator of an organization, this parameter
* indicates whether to include recommendations for resources in all member accounts of the 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in the
* export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in
* the export.
*
*
* @param includeMemberAccounts
* If your account is the management account or the delegated administrator of an organization, this
* parameter indicates whether to include recommendations for resources in all member accounts of the
* 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in
* the export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't
* included in the export.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExportECSServiceRecommendationsRequest withIncludeMemberAccounts(Boolean includeMemberAccounts) {
setIncludeMemberAccounts(includeMemberAccounts);
return this;
}
/**
*
* If your account is the management account or the delegated administrator of an organization, this parameter
* indicates whether to include recommendations for resources in all member accounts of the 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in the
* export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't included in
* the export.
*
*
* @return If your account is the management account or the delegated administrator of an organization, this
* parameter indicates whether to include recommendations for resources in all member accounts of the
* 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.
*
*
* If this parameter is omitted, recommendations for member accounts of the organization aren't included in
* the export file.
*
*
* If this parameter or the account ID parameter is omitted, recommendations for member accounts aren't
* included in the export.
*/
public Boolean isIncludeMemberAccounts() {
return this.includeMemberAccounts;
}
/**
* 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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ExportECSServiceRecommendationsRequest == false)
return false;
ExportECSServiceRecommendationsRequest other = (ExportECSServiceRecommendationsRequest) 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;
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());
return hashCode;
}
@Override
public ExportECSServiceRecommendationsRequest clone() {
return (ExportECSServiceRecommendationsRequest) super.clone();
}
}