@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ExportTask extends Object implements Serializable, Cloneable
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.
Constructor and Description |
---|
ExportTask() |
Modifier and Type | Method and Description |
---|---|
ExportTask |
clone() |
boolean |
equals(Object obj) |
List<String> |
getExportOnly()
The data exported from the snapshot or cluster.
|
String |
getExportTaskIdentifier()
A unique identifier for the snapshot or cluster 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 or cluster.
|
String |
getKmsKeyId()
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to
Amazon S3.
|
Integer |
getPercentProgress()
The progress of the snapshot or cluster export task as a percentage.
|
String |
getS3Bucket()
The Amazon S3 bucket where the snapshot or cluster is exported to.
|
String |
getS3Prefix()
The Amazon S3 bucket prefix that is the file name and path of the exported data.
|
Date |
getSnapshotTime()
The time when the snapshot was created.
|
String |
getSourceArn()
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
|
String |
getSourceType()
The type of source for the export.
|
String |
getStatus()
The progress status of the export task.
|
Date |
getTaskEndTime()
The time when the snapshot or cluster export task ended.
|
Date |
getTaskStartTime()
The time when the snapshot or cluster export task started.
|
Integer |
getTotalExtractedDataInGB()
The total amount of data exported, in gigabytes.
|
String |
getWarningMessage()
A warning about the snapshot or cluster export task.
|
int |
hashCode() |
void |
setExportOnly(Collection<String> exportOnly)
The data exported from the snapshot or cluster.
|
void |
setExportTaskIdentifier(String exportTaskIdentifier)
A unique identifier for the snapshot or cluster 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 or cluster.
|
void |
setKmsKeyId(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.
|
void |
setPercentProgress(Integer percentProgress)
The progress of the snapshot or cluster export task as a percentage.
|
void |
setS3Bucket(String s3Bucket)
The Amazon S3 bucket where the snapshot or cluster is exported to.
|
void |
setS3Prefix(String s3Prefix)
The Amazon S3 bucket prefix that is the file name and path of the exported data.
|
void |
setSnapshotTime(Date snapshotTime)
The time when the snapshot was created.
|
void |
setSourceArn(String sourceArn)
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
|
void |
setSourceType(String sourceType)
The type of source for the export.
|
void |
setStatus(String status)
The progress status of the export task.
|
void |
setTaskEndTime(Date taskEndTime)
The time when the snapshot or cluster export task ended.
|
void |
setTaskStartTime(Date taskStartTime)
The time when the snapshot or cluster export task started.
|
void |
setTotalExtractedDataInGB(Integer totalExtractedDataInGB)
The total amount of data exported, in gigabytes.
|
void |
setWarningMessage(String warningMessage)
A warning about the snapshot or cluster export task.
|
String |
toString()
Returns a string representation of this object.
|
ExportTask |
withExportOnly(Collection<String> exportOnly)
The data exported from the snapshot or cluster.
|
ExportTask |
withExportOnly(String... exportOnly)
The data exported from the snapshot or cluster.
|
ExportTask |
withExportTaskIdentifier(String exportTaskIdentifier)
A unique identifier for the snapshot or cluster 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 or cluster.
|
ExportTask |
withKmsKeyId(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.
|
ExportTask |
withPercentProgress(Integer percentProgress)
The progress of the snapshot or cluster export task as a percentage.
|
ExportTask |
withS3Bucket(String s3Bucket)
The Amazon S3 bucket where the snapshot or cluster is exported to.
|
ExportTask |
withS3Prefix(String s3Prefix)
The Amazon S3 bucket prefix that is the file name and path of the exported data.
|
ExportTask |
withSnapshotTime(Date snapshotTime)
The time when the snapshot was created.
|
ExportTask |
withSourceArn(String sourceArn)
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
|
ExportTask |
withSourceType(ExportSourceType sourceType)
The type of source for the export.
|
ExportTask |
withSourceType(String sourceType)
The type of source for the export.
|
ExportTask |
withStatus(String status)
The progress status of the export task.
|
ExportTask |
withTaskEndTime(Date taskEndTime)
The time when the snapshot or cluster export task ended.
|
ExportTask |
withTaskStartTime(Date taskStartTime)
The time when the snapshot or cluster export task started.
|
ExportTask |
withTotalExtractedDataInGB(Integer totalExtractedDataInGB)
The total amount of data exported, in gigabytes.
|
ExportTask |
withWarningMessage(String warningMessage)
A warning about the snapshot or cluster export task.
|
public void setExportTaskIdentifier(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.
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.public String getExportTaskIdentifier()
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.
public ExportTask withExportTaskIdentifier(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.
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.public void setSourceArn(String sourceArn)
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
sourceArn
- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.public String getSourceArn()
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
public ExportTask withSourceArn(String sourceArn)
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
sourceArn
- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.public List<String> getExportOnly()
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.
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.
public void setExportOnly(Collection<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.
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.
public ExportTask withExportOnly(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.
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.
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.
public ExportTask withExportOnly(Collection<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.
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.
public void setSnapshotTime(Date snapshotTime)
The time when the snapshot was created.
snapshotTime
- The time when the snapshot was created.public Date getSnapshotTime()
The time when the snapshot was created.
public ExportTask withSnapshotTime(Date snapshotTime)
The time when the snapshot was created.
snapshotTime
- The time when the snapshot was created.public void setTaskStartTime(Date taskStartTime)
The time when the snapshot or cluster export task started.
taskStartTime
- The time when the snapshot or cluster export task started.public Date getTaskStartTime()
The time when the snapshot or cluster export task started.
public ExportTask withTaskStartTime(Date taskStartTime)
The time when the snapshot or cluster export task started.
taskStartTime
- The time when the snapshot or cluster export task started.public void setTaskEndTime(Date taskEndTime)
The time when the snapshot or cluster export task ended.
taskEndTime
- The time when the snapshot or cluster export task ended.public Date getTaskEndTime()
The time when the snapshot or cluster export task ended.
public ExportTask withTaskEndTime(Date taskEndTime)
The time when the snapshot or cluster export task ended.
taskEndTime
- The time when the snapshot or cluster export task ended.public void setS3Bucket(String s3Bucket)
The Amazon S3 bucket where the snapshot or cluster is exported to.
s3Bucket
- The Amazon S3 bucket where the snapshot or cluster is exported to.public String getS3Bucket()
The Amazon S3 bucket where the snapshot or cluster is exported to.
public ExportTask withS3Bucket(String s3Bucket)
The Amazon S3 bucket where the snapshot or cluster is exported to.
s3Bucket
- The Amazon S3 bucket where the snapshot or cluster is exported to.public void setS3Prefix(String s3Prefix)
The Amazon S3 bucket prefix that is the file name and path of the exported data.
s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the exported data.public String getS3Prefix()
The Amazon S3 bucket prefix that is the file name and path of the exported data.
public ExportTask withS3Prefix(String s3Prefix)
The Amazon S3 bucket prefix that is the file name and path of the exported data.
s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the exported data.public void setIamRoleArn(String iamRoleArn)
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.public String getIamRoleArn()
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
public ExportTask withIamRoleArn(String iamRoleArn)
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.public void setKmsKeyId(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.
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.public String getKmsKeyId()
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.
public ExportTask withKmsKeyId(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.
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.public void setStatus(String status)
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
status
- The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
public String getStatus()
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
public ExportTask withStatus(String status)
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
status
- The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
public void setPercentProgress(Integer percentProgress)
The progress of the snapshot or cluster export task as a percentage.
percentProgress
- The progress of the snapshot or cluster export task as a percentage.public Integer getPercentProgress()
The progress of the snapshot or cluster export task as a percentage.
public ExportTask withPercentProgress(Integer percentProgress)
The progress of the snapshot or cluster export task as a percentage.
percentProgress
- The progress of the snapshot or cluster export task as a percentage.public void setTotalExtractedDataInGB(Integer totalExtractedDataInGB)
The total amount of data exported, in gigabytes.
totalExtractedDataInGB
- The total amount of data exported, in gigabytes.public Integer getTotalExtractedDataInGB()
The total amount of data exported, in gigabytes.
public ExportTask withTotalExtractedDataInGB(Integer totalExtractedDataInGB)
The total amount of data exported, in gigabytes.
totalExtractedDataInGB
- The total amount of data exported, in gigabytes.public void setFailureCause(String failureCause)
The reason the export failed, if it failed.
failureCause
- The reason the export failed, if it failed.public String getFailureCause()
The reason the export failed, if it failed.
public ExportTask withFailureCause(String failureCause)
The reason the export failed, if it failed.
failureCause
- The reason the export failed, if it failed.public void setWarningMessage(String warningMessage)
A warning about the snapshot or cluster export task.
warningMessage
- A warning about the snapshot or cluster export task.public String getWarningMessage()
A warning about the snapshot or cluster export task.
public ExportTask withWarningMessage(String warningMessage)
A warning about the snapshot or cluster export task.
warningMessage
- A warning about the snapshot or cluster export task.public void setSourceType(String sourceType)
The type of source for the export.
sourceType
- The type of source for the export.ExportSourceType
public String getSourceType()
The type of source for the export.
ExportSourceType
public ExportTask withSourceType(String sourceType)
The type of source for the export.
sourceType
- The type of source for the export.ExportSourceType
public ExportTask withSourceType(ExportSourceType sourceType)
The type of source for the export.
sourceType
- The type of source for the export.ExportSourceType
public String toString()
toString
in class Object
Object.toString()
public ExportTask clone()