ExportTask (AWS Java SDK :: Services :: Amazon RDS 2.17.235 API)

java.lang.Object
- software.amazon.awssdk.services.rds.model.ExportTask

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExportTask.Builder,ExportTask>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ExportTask
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExportTask.Builder,ExportTask>
```
Contains the details of a snapshot export to Amazon S3.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ExportTask.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ExportTask.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exportOnly()` The data exported from the snapshot.
`String`	`exportTaskIdentifier()` A unique identifier for the snapshot export task.
`String`	`failureCause()` The reason the export failed, if it failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExportOnly()` For responses, this returns true if the service returned a value for the ExportOnly property.
`int`	`hashCode()`
`String`	`iamRoleArn()` The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
`String`	`kmsKeyId()` The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3.
`Integer`	`percentProgress()` The progress of the snapshot export task as a percentage.
`String`	`s3Bucket()` The Amazon S3 bucket that the snapshot is exported to.
`String`	`s3Prefix()` The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ExportTask.Builder>`	`serializableBuilderClass()`
`Instant`	`snapshotTime()` The time that the snapshot was created.
`String`	`sourceArn()` The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
`String`	`status()` The progress status of the export task.
`Instant`	`taskEndTime()` The time that the snapshot export task completed.
`Instant`	`taskStartTime()` The time that the snapshot export task started.
`ExportTask.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`totalExtractedDataInGB()` The total amount of data exported, in gigabytes.
`String`	`warningMessage()` A warning about the snapshot export task.

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
  - exportTaskIdentifier
```
public final String exportTaskIdentifier()
```
    A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
    
    Returns:
    
    A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
  - sourceArn
```
public final String sourceArn()
```
    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the snapshot 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. Valid values are the following:
    - database - Export all the data from a specified database.
    - database.table table-name - Export a table of the snapshot. 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. 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. Valid values are the following:
    
    database - Export all the data from a specified database.
    
    database.table table-name - Export a table of the snapshot. 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. 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 that the snapshot was created.
    
    Returns:
    
    The time that the snapshot was created.
  - taskStartTime
```
public final Instant taskStartTime()
```
    The time that the snapshot export task started.
    
    Returns:
    
    The time that the snapshot export task started.
  - taskEndTime
```
public final Instant taskEndTime()
```
    The time that the snapshot export task completed.
    
    Returns:
    
    The time that the snapshot export task completed.
  - s3Bucket
```
public final String s3Bucket()
```
    The Amazon S3 bucket that the snapshot is exported to.
    
    Returns:
    
    The Amazon S3 bucket that the snapshot is exported to.
  - s3Prefix
```
public final String s3Prefix()
```
    The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
    
    Returns:
    
    The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
  - iamRoleArn
```
public final String iamRoleArn()
```
    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
    
    Returns:
    
    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot 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 snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.
  - status
```
public final String status()
```
    The progress status of the export task.
    
    Returns:
    
    The progress status of the export task.
  - percentProgress
```
public final Integer percentProgress()
```
    The progress of the snapshot export task as a percentage.
    
    Returns:
    
    The progress of the snapshot 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 export task.
    
    Returns:
    
    A warning about the snapshot export task.
  - toBuilder
```
public ExportTask.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ExportTask.Builder,ExportTask>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ExportTask

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

exportTaskIdentifier

sourceArn

hasExportOnly

exportOnly

snapshotTime

taskStartTime

taskEndTime

s3Bucket

s3Prefix

iamRoleArn

kmsKeyId

status

percentProgress

totalExtractedDataInGB

failureCause

warningMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields