Class ExportTask

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

Contains the details of a snapshot or cluster export to Amazon S3.

This data type is used as a response element in the DescribeExportTasks operation.

See Also:

  • Method Details

    • exportTaskIdentifier

      public final String exportTaskIdentifier()

      A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.

      Returns:
      A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.

    • sourceArn

      public final String sourceArn()

      The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

      Returns:
      The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    • hasExportOnly

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

    • exportOnly

      public final List<String> exportOnly()

      The data exported from the snapshot or cluster.

      Valid Values:

      • database - Export all the data from a specified database.

      • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

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

      Returns:
      The data exported from the snapshot or cluster.

      Valid Values:

      • database - Export all the data from a specified database.

      • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    • snapshotTime

      public final Instant snapshotTime()

      The time when the snapshot was created.

      Returns:
      The time when the snapshot was created.

    • taskStartTime

      public final Instant taskStartTime()

      The time when the snapshot or cluster export task started.

      Returns:
      The time when the snapshot or cluster export task started.

    • taskEndTime

      public final Instant taskEndTime()

      The time when the snapshot or cluster export task ended.

      Returns:
      The time when the snapshot or cluster export task ended.

    • s3Bucket

      public final String s3Bucket()

      The Amazon S3 bucket where the snapshot or cluster is exported to.

      Returns:
      The Amazon S3 bucket where the snapshot or cluster is exported to.

    • s3Prefix

      public final String s3Prefix()

      The Amazon S3 bucket prefix that is the file name and path of the exported data.

      Returns:
      The Amazon S3 bucket prefix that is the file name and path of the exported data.

    • iamRoleArn

      public final String iamRoleArn()

      The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

      Returns:
      The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

    • kmsKeyId

      public final String kmsKeyId()

      The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

      Returns:
      The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

    • status

      public final String status()

      The progress status of the export task. The status can be one of the following:

      • CANCELED

      • CANCELING

      • COMPLETE

      • FAILED

      • IN_PROGRESS

      • STARTING

      Returns:
      The progress status of the export task. The status can be one of the following:

      • CANCELED

      • CANCELING

      • COMPLETE

      • FAILED

      • IN_PROGRESS

      • STARTING

    • percentProgress

      public final Integer percentProgress()

      The progress of the snapshot or cluster export task as a percentage.

      Returns:
      The progress of the snapshot or cluster export task as a percentage.

    • totalExtractedDataInGB

      public final Integer totalExtractedDataInGB()

      The total amount of data exported, in gigabytes.

      Returns:
      The total amount of data exported, in gigabytes.

    • failureCause

      public final String failureCause()

      The reason the export failed, if it failed.

      Returns:
      The reason the export failed, if it failed.

    • warningMessage

      public final String warningMessage()

      A warning about the snapshot or cluster export task.

      Returns:
      A warning about the snapshot or cluster export task.

    • sourceType

      public final ExportSourceType sourceType()

      The type of source for the export.

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

      Returns:
      The type of source for the export.
      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      The type of source for the export.

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

      Returns:
      The type of source for the export.
      See Also:

    • toBuilder

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

    • builder

      public static ExportTask.Builder builder()

    • serializableBuilderClass

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