Package software.amazon.awssdk.services.computeoptimizer.model

Class ExportLicenseRecommendationsRequest

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.ExportLicenseRecommendationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ExportLicenseRecommendationsRequest.Builder,ExportLicenseRecommendationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ExportLicenseRecommendationsRequest extends ComputeOptimizerRequest implements ToCopyableBuilder<ExportLicenseRecommendationsRequest.Builder,ExportLicenseRecommendationsRequest>

  • Method Details

    • hasAccountIds

      public final boolean hasAccountIds()
      For responses, this returns true if the service returned a value for the AccountIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • accountIds

      public final List<String> accountIds()

      The IDs of the Amazon Web Services accounts for which to export license 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 can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

      If this parameter is omitted, recommendations for member accounts aren't included in the export.

      You can specify multiple account IDs per request.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccountIds() method.

      Returns:
      The IDs of the Amazon Web Services accounts for which to export license 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 can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

      If this parameter is omitted, recommendations for member accounts aren't included in the export.

      You can specify multiple account IDs per request.

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filters

      public final List<LicenseRecommendationFilter> filters()

      An array of objects to specify a filter that exports a more specific set of license recommendations.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

      Returns:
      An array of objects to specify a filter that exports a more specific set of license recommendations.

    • fieldsToExport

      public final List<ExportableLicenseField> 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldsToExport() method.

      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()
      For responses, this returns true if the service returned a value for the FieldsToExport property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldsToExport() method.

      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()
      Returns the value of the S3DestinationConfig property for this object.
      Returns:
      The value of the S3DestinationConfig property for this object.

    • fileFormat

      public final FileFormat fileFormat()

      The format of the export file.

      A CSV file is the only export format currently supported.

      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.

      A CSV file is the only export format currently supported.

      See Also:

    • fileFormatAsString

      public final String fileFormatAsString()

      The format of the export file.

      A CSV file is the only export format currently supported.

      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.

      A CSV file is the only export format currently supported.

      See Also:

    • 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 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 .

      This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

      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 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 .

      This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

    • toBuilder

      public ExportLicenseRecommendationsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ExportLicenseRecommendationsRequest.Builder,ExportLicenseRecommendationsRequest>
      Specified by:
      toBuilder in class ComputeOptimizerRequest
      Returns:
      a builder for type T

    • builder

      public static ExportLicenseRecommendationsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExportLicenseRecommendationsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.