Class CapacityManagerDataExportResponse

java.lang.Object
software.amazon.awssdk.services.ec2.model.CapacityManagerDataExportResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CapacityManagerDataExportResponse.Builder,CapacityManagerDataExportResponse>
@Generated("software.amazon.awssdk:codegen") public final class CapacityManagerDataExportResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CapacityManagerDataExportResponse.Builder,CapacityManagerDataExportResponse>

Contains information about a Capacity Manager data export configuration, including export settings, delivery status, and recent export activity.

See Also:

  • Method Details

    • capacityManagerDataExportId

      public final String capacityManagerDataExportId()

      The unique identifier for the data export configuration.

      Returns:
      The unique identifier for the data export configuration.

    • s3BucketName

      public final String s3BucketName()

      The name of the S3 bucket where export files are delivered.

      Returns:
      The name of the S3 bucket where export files are delivered.

    • s3BucketPrefix

      public final String s3BucketPrefix()

      The S3 key prefix used for organizing export files within the bucket.

      Returns:
      The S3 key prefix used for organizing export files within the bucket.

    • 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 of the exported data.

      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 of the exported data.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The file format of the exported data.

      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 of the exported data.
      See Also:

    • createTime

      public final Instant createTime()

      The timestamp when the data export configuration was created.

      Returns:
      The timestamp when the data export configuration was created.

    • latestDeliveryStatus

      public final CapacityManagerDataExportStatus latestDeliveryStatus()

      The status of the most recent export delivery.

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

      Returns:
      The status of the most recent export delivery.
      See Also:

    • latestDeliveryStatusAsString

      public final String latestDeliveryStatusAsString()

      The status of the most recent export delivery.

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

      Returns:
      The status of the most recent export delivery.
      See Also:

    • latestDeliveryStatusMessage

      public final String latestDeliveryStatusMessage()

      A message describing the status of the most recent export delivery, including any error details if the delivery failed.

      Returns:
      A message describing the status of the most recent export delivery, including any error details if the delivery failed.

    • latestDeliveryS3LocationUri

      public final String latestDeliveryS3LocationUri()

      The S3 URI of the most recently delivered export file.

      Returns:
      The S3 URI of the most recently delivered export file.

    • latestDeliveryTime

      public final Instant latestDeliveryTime()

      The timestamp when the most recent export was delivered to S3.

      Returns:
      The timestamp when the most recent export was delivered to S3.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The tags associated with the data export configuration.

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

      Returns:
      The tags associated with the data export configuration.

    • toBuilder

      public CapacityManagerDataExportResponse.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<CapacityManagerDataExportResponse.Builder,CapacityManagerDataExportResponse>
      Returns:
      a builder for type T

    • builder

      public static CapacityManagerDataExportResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CapacityManagerDataExportResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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