Class CancelExportTaskResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CancelExportTaskResponse.Builder,
CancelExportTaskResponse>
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.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The data exported from the snapshot or cluster.final String
A unique identifier for the snapshot or cluster export task.final String
The reason the export failed, if it failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ExportOnly property.final int
hashCode()
final String
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.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.final Integer
The progress of the snapshot or cluster export task as a percentage.final String
s3Bucket()
The Amazon S3 bucket where the snapshot or cluster is exported to.final String
s3Prefix()
The Amazon S3 bucket prefix that is the file name and path of the exported data.static Class
<? extends CancelExportTaskResponse.Builder> final Instant
The time when the snapshot was created.final String
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.final ExportSourceType
The type of source for the export.final String
The type of source for the export.final String
status()
The progress status of the export task.final Instant
The time when the snapshot or cluster export task ended.final Instant
The time when the snapshot or cluster export task started.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The total amount of data exported, in gigabytes.final String
A warning about the snapshot or cluster export task.Methods inherited from class software.amazon.awssdk.services.rds.model.RdsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 theisEmpty()
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
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
The time when the snapshot was created.
- Returns:
- The time when the snapshot was created.
-
taskStartTime
The time when the snapshot or cluster export task started.
- Returns:
- The time when the snapshot or cluster export task started.
-
taskEndTime
The time when the snapshot or cluster export task ended.
- Returns:
- The time when the snapshot or cluster export task ended.
-
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
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
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
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
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
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
The total amount of data exported, in gigabytes.
- Returns:
- The total amount of data exported, in gigabytes.
-
failureCause
The reason the export failed, if it failed.
- Returns:
- The reason the export failed, if it failed.
-
warningMessage
A warning about the snapshot or cluster export task.
- Returns:
- A warning about the snapshot or cluster export task.
-
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 returnExportSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceTypeAsString()
.- Returns:
- The type of source for the export.
- See Also:
-
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 returnExportSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceTypeAsString()
.- Returns:
- The type of source for the export.
- See Also:
-
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 interfaceToCopyableBuilder<CancelExportTaskResponse.Builder,
CancelExportTaskResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-