@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartExportTaskResult extends AmazonWebServiceResult<ResponseMetadata> 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.
Constructor and Description |
---|
StartExportTaskResult() |
Modifier and Type | Method and Description |
---|---|
StartExportTaskResult |
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 key identifier of the Amazon Web Services 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 key identifier of the Amazon Web Services 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.
|
StartExportTaskResult |
withExportOnly(Collection<String> exportOnly)
The data exported from the snapshot.
|
StartExportTaskResult |
withExportOnly(String... exportOnly)
The data exported from the snapshot.
|
StartExportTaskResult |
withExportTaskIdentifier(String exportTaskIdentifier)
A unique identifier for the snapshot export task.
|
StartExportTaskResult |
withFailureCause(String failureCause)
The reason the export failed, if it failed.
|
StartExportTaskResult |
withIamRoleArn(String iamRoleArn)
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
|
StartExportTaskResult |
withKmsKeyId(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.
|
StartExportTaskResult |
withPercentProgress(Integer percentProgress)
The progress of the snapshot export task as a percentage.
|
StartExportTaskResult |
withS3Bucket(String s3Bucket)
The Amazon S3 bucket that the snapshot is exported to.
|
StartExportTaskResult |
withS3Prefix(String s3Prefix)
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
|
StartExportTaskResult |
withSnapshotTime(Date snapshotTime)
The time that the snapshot was created.
|
StartExportTaskResult |
withSourceArn(String sourceArn)
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
|
StartExportTaskResult |
withStatus(String status)
The progress status of the export task.
|
StartExportTaskResult |
withTaskEndTime(Date taskEndTime)
The time that the snapshot export task completed.
|
StartExportTaskResult |
withTaskStartTime(Date taskStartTime)
The time that the snapshot export task started.
|
StartExportTaskResult |
withTotalExtractedDataInGB(Integer totalExtractedDataInGB)
The total amount of data exported, in gigabytes.
|
StartExportTaskResult |
withWarningMessage(String warningMessage)
A warning about the snapshot export task.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
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.
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.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.
public StartExportTaskResult 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.
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.public void setSourceArn(String sourceArn)
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
sourceArn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.public String getSourceArn()
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
public StartExportTaskResult withSourceArn(String sourceArn)
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
sourceArn
- The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.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.
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.
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.
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.
public StartExportTaskResult 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.
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.
public StartExportTaskResult 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.
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.
public void setSnapshotTime(Date snapshotTime)
The time that the snapshot was created.
snapshotTime
- The time that the snapshot was created.public Date getSnapshotTime()
The time that the snapshot was created.
public StartExportTaskResult withSnapshotTime(Date snapshotTime)
The time that the snapshot was created.
snapshotTime
- The time that the snapshot was created.public void setTaskStartTime(Date taskStartTime)
The time that the snapshot export task started.
taskStartTime
- The time that the snapshot export task started.public Date getTaskStartTime()
The time that the snapshot export task started.
public StartExportTaskResult withTaskStartTime(Date taskStartTime)
The time that the snapshot export task started.
taskStartTime
- The time that the snapshot export task started.public void setTaskEndTime(Date taskEndTime)
The time that the snapshot export task completed.
taskEndTime
- The time that the snapshot export task completed.public Date getTaskEndTime()
The time that the snapshot export task completed.
public StartExportTaskResult withTaskEndTime(Date taskEndTime)
The time that the snapshot export task completed.
taskEndTime
- The time that the snapshot export task completed.public void setS3Bucket(String s3Bucket)
The Amazon S3 bucket that the snapshot is exported to.
s3Bucket
- The Amazon S3 bucket that the snapshot is exported to.public String getS3Bucket()
The Amazon S3 bucket that the snapshot is exported to.
public StartExportTaskResult withS3Bucket(String s3Bucket)
The Amazon S3 bucket that the snapshot is exported to.
s3Bucket
- The Amazon S3 bucket that the snapshot is exported to.public void setS3Prefix(String s3Prefix)
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.public String getS3Prefix()
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
public StartExportTaskResult withS3Prefix(String s3Prefix)
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
s3Prefix
- The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.public void setIamRoleArn(String iamRoleArn)
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.public String getIamRoleArn()
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
public StartExportTaskResult withIamRoleArn(String iamRoleArn)
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
iamRoleArn
- The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.public void setKmsKeyId(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.
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.public String getKmsKeyId()
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.
public StartExportTaskResult withKmsKeyId(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.
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.public void setStatus(String status)
The progress status of the export task.
status
- The progress status of the export task.public String getStatus()
The progress status of the export task.
public StartExportTaskResult withStatus(String status)
The progress status of the export task.
status
- The progress status of the export task.public void setPercentProgress(Integer percentProgress)
The progress of the snapshot export task as a percentage.
percentProgress
- The progress of the snapshot export task as a percentage.public Integer getPercentProgress()
The progress of the snapshot export task as a percentage.
public StartExportTaskResult withPercentProgress(Integer percentProgress)
The progress of the snapshot export task as a percentage.
percentProgress
- The progress of the snapshot 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 StartExportTaskResult 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 StartExportTaskResult 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 export task.
warningMessage
- A warning about the snapshot export task.public String getWarningMessage()
A warning about the snapshot export task.
public StartExportTaskResult withWarningMessage(String warningMessage)
A warning about the snapshot export task.
warningMessage
- A warning about the snapshot export task.public String toString()
toString
in class Object
Object.toString()
public StartExportTaskResult clone()