ExportTask (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rds.model.ExportTask

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExportTask
extends Object
implements Serializable, Cloneable
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExportTask()

Constructors
Constructor and Description
`ExportTask()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExportTask`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getExportOnly()` The data exported from the snapshot.
`String`	`getExportTaskIdentifier()` A unique identifier for the snapshot export task.
`String`	`getFailureCause()` The reason the export failed, if it failed.
`String`	`getIamRoleArn()` The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
`String`	`getKmsKeyId()` The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3.
`Integer`	`getPercentProgress()` The progress of the snapshot export task as a percentage.
`String`	`getS3Bucket()` The Amazon S3 bucket that the snapshot is exported to.
`String`	`getS3Prefix()` The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
`Date`	`getSnapshotTime()` The time that the snapshot was created.
`String`	`getSourceArn()` The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
`String`	`getStatus()` The progress status of the export task.
`Date`	`getTaskEndTime()` The time that the snapshot export task completed.
`Date`	`getTaskStartTime()` The time that the snapshot export task started.
`Integer`	`getTotalExtractedDataInGB()` The total amount of data exported, in gigabytes.
`String`	`getWarningMessage()` A warning about the snapshot export task.
`int`	`hashCode()`
`void`	`setExportOnly(Collection<String> exportOnly)` The data exported from the snapshot.
`void`	`setExportTaskIdentifier(String exportTaskIdentifier)` A unique identifier for the snapshot export task.
`void`	`setFailureCause(String failureCause)` The reason the export failed, if it failed.
`void`	`setIamRoleArn(String iamRoleArn)` The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
`void`	`setKmsKeyId(String kmsKeyId)` The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3.
`void`	`setPercentProgress(Integer percentProgress)` The progress of the snapshot export task as a percentage.
`void`	`setS3Bucket(String s3Bucket)` The Amazon S3 bucket that the snapshot is exported to.
`void`	`setS3Prefix(String s3Prefix)` The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
`void`	`setSnapshotTime(Date snapshotTime)` The time that the snapshot was created.
`void`	`setSourceArn(String sourceArn)` The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
`void`	`setStatus(String status)` The progress status of the export task.
`void`	`setTaskEndTime(Date taskEndTime)` The time that the snapshot export task completed.
`void`	`setTaskStartTime(Date taskStartTime)` The time that the snapshot export task started.
`void`	`setTotalExtractedDataInGB(Integer totalExtractedDataInGB)` The total amount of data exported, in gigabytes.
`void`	`setWarningMessage(String warningMessage)` A warning about the snapshot export task.
`String`	`toString()` Returns a string representation of this object.
`ExportTask`	`withExportOnly(Collection<String> exportOnly)` The data exported from the snapshot.
`ExportTask`	`withExportOnly(String... exportOnly)` The data exported from the snapshot.
`ExportTask`	`withExportTaskIdentifier(String exportTaskIdentifier)` A unique identifier for the snapshot export task.
`ExportTask`	`withFailureCause(String failureCause)` The reason the export failed, if it failed.
`ExportTask`	`withIamRoleArn(String iamRoleArn)` The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
`ExportTask`	`withKmsKeyId(String kmsKeyId)` The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3.
`ExportTask`	`withPercentProgress(Integer percentProgress)` The progress of the snapshot export task as a percentage.
`ExportTask`	`withS3Bucket(String s3Bucket)` The Amazon S3 bucket that the snapshot is exported to.
`ExportTask`	`withS3Prefix(String s3Prefix)` The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
`ExportTask`	`withSnapshotTime(Date snapshotTime)` The time that the snapshot was created.
`ExportTask`	`withSourceArn(String sourceArn)` The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
`ExportTask`	`withStatus(String status)` The progress status of the export task.
`ExportTask`	`withTaskEndTime(Date taskEndTime)` The time that the snapshot export task completed.
`ExportTask`	`withTaskStartTime(Date taskStartTime)` The time that the snapshot export task started.
`ExportTask`	`withTotalExtractedDataInGB(Integer totalExtractedDataInGB)` The total amount of data exported, in gigabytes.
`ExportTask`	`withWarningMessage(String warningMessage)` A warning about the snapshot export task.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ExportTask
```
public ExportTask()
```
- Method Detail
  - setExportTaskIdentifier
```
public void setExportTaskIdentifier(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.
    
    Parameters:
    
    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.
  - getExportTaskIdentifier
```
public String getExportTaskIdentifier()
```
    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.
  - withExportTaskIdentifier
```
public ExportTask withExportTaskIdentifier(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceArn
```
public void setSourceArn(String sourceArn)
```
    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
    
    Parameters:
    
    sourceArn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
  - getSourceArn
```
public String getSourceArn()
```
    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.
  - withSourceArn
```
public ExportTask withSourceArn(String sourceArn)
```
    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
    
    Parameters:
    
    sourceArn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExportOnly
```
public List<String> getExportOnly()
```
    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.
    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.
  - setExportOnly
```
public void setExportOnly(Collection<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.
    Parameters:
    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.
  - withExportOnly
```
public ExportTask withExportOnly(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.
    NOTE: This method appends the values to the existing list (if any). Use setExportOnly(java.util.Collection) or withExportOnly(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExportOnly
```
public ExportTask withExportOnly(Collection<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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnapshotTime
```
public void setSnapshotTime(Date snapshotTime)
```
    The time that the snapshot was created.
    
    Parameters:
    
    snapshotTime - The time that the snapshot was created.
  - getSnapshotTime
```
public Date getSnapshotTime()
```
    The time that the snapshot was created.
    
    Returns:
    
    The time that the snapshot was created.
  - withSnapshotTime
```
public ExportTask withSnapshotTime(Date snapshotTime)
```
    The time that the snapshot was created.
    
    Parameters:
    
    snapshotTime - The time that the snapshot was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskStartTime
```
public void setTaskStartTime(Date taskStartTime)
```
    The time that the snapshot export task started.
    
    Parameters:
    
    taskStartTime - The time that the snapshot export task started.
  - getTaskStartTime
```
public Date getTaskStartTime()
```
    The time that the snapshot export task started.
    
    Returns:
    
    The time that the snapshot export task started.
  - withTaskStartTime
```
public ExportTask withTaskStartTime(Date taskStartTime)
```
    The time that the snapshot export task started.
    
    Parameters:
    
    taskStartTime - The time that the snapshot export task started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskEndTime
```
public void setTaskEndTime(Date taskEndTime)
```
    The time that the snapshot export task completed.
    
    Parameters:
    
    taskEndTime - The time that the snapshot export task completed.
  - getTaskEndTime
```
public Date getTaskEndTime()
```
    The time that the snapshot export task completed.
    
    Returns:
    
    The time that the snapshot export task completed.
  - withTaskEndTime
```
public ExportTask withTaskEndTime(Date taskEndTime)
```
    The time that the snapshot export task completed.
    
    Parameters:
    
    taskEndTime - The time that the snapshot export task completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Bucket
```
public void setS3Bucket(String s3Bucket)
```
    The Amazon S3 bucket that the snapshot is exported to.
    
    Parameters:
    
    s3Bucket - The Amazon S3 bucket that the snapshot is exported to.
  - getS3Bucket
```
public String getS3Bucket()
```
    The Amazon S3 bucket that the snapshot is exported to.
    
    Returns:
    
    The Amazon S3 bucket that the snapshot is exported to.
  - withS3Bucket
```
public ExportTask withS3Bucket(String s3Bucket)
```
    The Amazon S3 bucket that the snapshot is exported to.
    
    Parameters:
    
    s3Bucket - The Amazon S3 bucket that the snapshot is exported to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Prefix
```
public void setS3Prefix(String s3Prefix)
```
    The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
    
    Parameters:
    
    s3Prefix - The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
  - getS3Prefix
```
public String getS3Prefix()
```
    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.
  - withS3Prefix
```
public ExportTask withS3Prefix(String s3Prefix)
```
    The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
    
    Parameters:
    
    s3Prefix - The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRoleArn
```
public void setIamRoleArn(String iamRoleArn)
```
    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
    
    Parameters:
    
    iamRoleArn - The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    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.
  - withIamRoleArn
```
public ExportTask withIamRoleArn(String iamRoleArn)
```
    The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
    
    Parameters:
    
    iamRoleArn - The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
    
    Parameters:
    
    kmsKeyId - The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
    
    Returns:
    
    The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
  - withKmsKeyId
```
public ExportTask withKmsKeyId(String kmsKeyId)
```
    The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
    
    Parameters:
    
    kmsKeyId - The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The progress status of the export task.
    
    Parameters:
    
    status - The progress status of the export task.
  - getStatus
```
public String getStatus()
```
    The progress status of the export task.
    
    Returns:
    
    The progress status of the export task.
  - withStatus
```
public ExportTask withStatus(String status)
```
    The progress status of the export task.
    
    Parameters:
    
    status - The progress status of the export task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPercentProgress
```
public void setPercentProgress(Integer percentProgress)
```
    The progress of the snapshot export task as a percentage.
    
    Parameters:
    
    percentProgress - The progress of the snapshot export task as a percentage.
  - getPercentProgress
```
public Integer getPercentProgress()
```
    The progress of the snapshot export task as a percentage.
    
    Returns:
    
    The progress of the snapshot export task as a percentage.
  - withPercentProgress
```
public ExportTask withPercentProgress(Integer percentProgress)
```
    The progress of the snapshot export task as a percentage.
    
    Parameters:
    
    percentProgress - The progress of the snapshot export task as a percentage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalExtractedDataInGB
```
public void setTotalExtractedDataInGB(Integer totalExtractedDataInGB)
```
    The total amount of data exported, in gigabytes.
    
    Parameters:
    
    totalExtractedDataInGB - The total amount of data exported, in gigabytes.
  - getTotalExtractedDataInGB
```
public Integer getTotalExtractedDataInGB()
```
    The total amount of data exported, in gigabytes.
    
    Returns:
    
    The total amount of data exported, in gigabytes.
  - withTotalExtractedDataInGB
```
public ExportTask withTotalExtractedDataInGB(Integer totalExtractedDataInGB)
```
    The total amount of data exported, in gigabytes.
    
    Parameters:
    
    totalExtractedDataInGB - The total amount of data exported, in gigabytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureCause
```
public void setFailureCause(String failureCause)
```
    The reason the export failed, if it failed.
    
    Parameters:
    
    failureCause - The reason the export failed, if it failed.
  - getFailureCause
```
public String getFailureCause()
```
    The reason the export failed, if it failed.
    
    Returns:
    
    The reason the export failed, if it failed.
  - withFailureCause
```
public ExportTask withFailureCause(String failureCause)
```
    The reason the export failed, if it failed.
    
    Parameters:
    
    failureCause - The reason the export failed, if it failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWarningMessage
```
public void setWarningMessage(String warningMessage)
```
    A warning about the snapshot export task.
    
    Parameters:
    
    warningMessage - A warning about the snapshot export task.
  - getWarningMessage
```
public String getWarningMessage()
```
    A warning about the snapshot export task.
    
    Returns:
    
    A warning about the snapshot export task.
  - withWarningMessage
```
public ExportTask withWarningMessage(String warningMessage)
```
    A warning about the snapshot export task.
    
    Parameters:
    
    warningMessage - A warning about the snapshot export task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ExportTask clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ExportTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExportTask

Method Detail

setExportTaskIdentifier

getExportTaskIdentifier

withExportTaskIdentifier

setSourceArn

getSourceArn

withSourceArn

getExportOnly

setExportOnly

withExportOnly

withExportOnly

setSnapshotTime

getSnapshotTime

withSnapshotTime

setTaskStartTime

getTaskStartTime

withTaskStartTime

setTaskEndTime

getTaskEndTime

withTaskEndTime

setS3Bucket

getS3Bucket

withS3Bucket

setS3Prefix

getS3Prefix

withS3Prefix

setIamRoleArn

getIamRoleArn

withIamRoleArn

setKmsKeyId

getKmsKeyId

withKmsKeyId

setStatus

getStatus

withStatus

setPercentProgress

getPercentProgress

withPercentProgress

setTotalExtractedDataInGB

getTotalExtractedDataInGB

withTotalExtractedDataInGB

setFailureCause

getFailureCause

withFailureCause

setWarningMessage

getWarningMessage

withWarningMessage

toString

equals

hashCode

clone