ExportAutoScalingGroupRecommendationsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.computeoptimizer.model.ComputeOptimizerRequest
    - - software.amazon.awssdk.services.computeoptimizer.model.ExportAutoScalingGroupRecommendationsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ExportAutoScalingGroupRecommendationsRequest.Builder,ExportAutoScalingGroupRecommendationsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExportAutoScalingGroupRecommendationsRequest
extends ComputeOptimizerRequest
implements ToCopyableBuilder<ExportAutoScalingGroupRecommendationsRequest.Builder,ExportAutoScalingGroupRecommendationsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ExportAutoScalingGroupRecommendationsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ExportAutoScalingGroupRecommendationsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`accountIds()` The IDs of the AWS accounts for which to export Auto Scaling group recommendations.
`static ExportAutoScalingGroupRecommendationsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ExportableAutoScalingGroupField>`	`fieldsToExport()` The recommendations data to include in the export file.
`List<String>`	`fieldsToExportAsStrings()` The recommendations data to include in the export file.
`FileFormat`	`fileFormat()` The format of the export file.
`String`	`fileFormatAsString()` The format of the export file.
`List<Filter>`	`filters()` An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccountIds()` Returns true if the AccountIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasFieldsToExport()` Returns true if the FieldsToExport property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasFilters()` Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`Boolean`	`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.
`S3DestinationConfig`	`s3DestinationConfig()` An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ExportAutoScalingGroupRecommendationsRequest.Builder>`	`serializableBuilderClass()`
`ExportAutoScalingGroupRecommendationsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasAccountIds
```
public final boolean hasAccountIds()
```
    Returns true if the AccountIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - accountIds
```
public final List<String> accountIds()
```
    The IDs of the AWS accounts for which to export Auto Scaling group 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAccountIds() to see if a value was sent in this field.
    
    Returns:
    
    The IDs of the AWS accounts for which to export Auto Scaling group 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.
  - hasFilters
```
public final boolean hasFilters()
```
    Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - filters
```
public final List<Filter> filters()
```
    An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFilters() to see if a value was sent in this field.
    
    Returns:
    
    An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
  - fieldsToExport
```
public final List<ExportableAutoScalingGroupField> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFieldsToExport() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - hasFieldsToExport
```
public final boolean hasFieldsToExport()
```
    Returns true if the FieldsToExport property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - fieldsToExportAsStrings
```
public final List<String> fieldsToExportAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFieldsToExport() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - s3DestinationConfig
```
public final 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 permission 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.
    
    Returns:
    
    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 permission 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.
  - fileFormat
```
public final FileFormat fileFormat()
```
    The format of the export file.
    
    The only export file format currently supported is Csv.
    
    If the service returns an enum value that is not available in the current SDK version, fileFormat will return FileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileFormatAsString().
    
    Returns:
    
    The format of the export file.
    
    The only export file format currently supported is Csv.
    
    See Also:
    
    FileFormat
  - fileFormatAsString
```
public final String fileFormatAsString()
```
    The format of the export file.
    
    The only export file format currently supported is Csv.
    
    If the service returns an enum value that is not available in the current SDK version, fileFormat will return FileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileFormatAsString().
    
    Returns:
    
    The format of the export file.
    
    The only export file format currently supported is Csv.
    
    See Also:
    
    FileFormat
  - includeMemberAccounts
```
public final Boolean 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 AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
    
    Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
    
    This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
    
    Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
    
    Returns:
    
    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 AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
    
    Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
    
    This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
    
    Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
  - toBuilder
```
public ExportAutoScalingGroupRecommendationsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ExportAutoScalingGroupRecommendationsRequest.Builder,ExportAutoScalingGroupRecommendationsRequest>
    
    Specified by:
    
    toBuilder in class ComputeOptimizerRequest
  - builder
```
public static ExportAutoScalingGroupRecommendationsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ExportAutoScalingGroupRecommendationsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ExportAutoScalingGroupRecommendationsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAccountIds

accountIds

hasFilters

filters

fieldsToExport

hasFieldsToExport

fieldsToExportAsStrings

s3DestinationConfig

fileFormat

fileFormatAsString

includeMemberAccounts

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields