Class CreateCapacityManagerDataExportRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.CreateCapacityManagerDataExportRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCapacityManagerDataExportRequest.Builder,CreateCapacityManagerDataExportRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCapacityManagerDataExportRequest extends Ec2Request implements ToCopyableBuilder<CreateCapacityManagerDataExportRequest.Builder,CreateCapacityManagerDataExportRequest>

  • Method Details

    • s3BucketName

      public final String s3BucketName()

      The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it.

      Returns:
      The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it.

    • s3BucketPrefix

      public final String s3BucketPrefix()

      The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root.

      Returns:
      The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root.

    • schedule

      public final Schedule schedule()

      The frequency at which data exports are generated.

      If the service returns an enum value that is not available in the current SDK version, schedule will return Schedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleAsString().

      Returns:
      The frequency at which data exports are generated.
      See Also:

    • scheduleAsString

      public final String scheduleAsString()

      The frequency at which data exports are generated.

      If the service returns an enum value that is not available in the current SDK version, schedule will return Schedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleAsString().

      Returns:
      The frequency at which data exports are generated.
      See Also:

    • outputFormat

      public final OutputFormat outputFormat()

      The file format for the exported data. Parquet format is recommended for large datasets and better compression.

      If the service returns an enum value that is not available in the current SDK version, outputFormat will return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

      Returns:
      The file format for the exported data. Parquet format is recommended for large datasets and better compression.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The file format for the exported data. Parquet format is recommended for large datasets and better compression.

      If the service returns an enum value that is not available in the current SDK version, outputFormat will return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

      Returns:
      The file format for the exported data. Parquet format is recommended for large datasets and better compression.
      See Also:

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications 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.

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.

      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 hasTagSpecifications() method.

      Returns:
      The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.

    • toBuilder

      public CreateCapacityManagerDataExportRequest.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<CreateCapacityManagerDataExportRequest.Builder,CreateCapacityManagerDataExportRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static CreateCapacityManagerDataExportRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCapacityManagerDataExportRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.