Package software.amazon.awssdk.services.rds.model

Class CancelExportTaskResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rds.model.RdsResponse

software.amazon.awssdk.services.rds.model.CancelExportTaskResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CancelExportTaskResponse.Builder,CancelExportTaskResponse>

@Generated("software.amazon.awssdk:codegen")
public final class CancelExportTaskResponse
extends RdsResponse
implements 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

Nested Classes

Modifier and Type	Class	Description
static interface	CancelExportTaskResponse.Builder

Method Summary

Modifier and Type	Method	Description
static CancelExportTaskResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exportOnly()	The data exported from the snapshot or cluster.
String	exportTaskIdentifier()	A unique identifier for the snapshot or cluster 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 or cluster.
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.
Integer	percentProgress()	The progress of the snapshot or cluster export task as a percentage.
String	s3Bucket()	The Amazon S3 bucket where the snapshot or cluster is exported to.
String	s3Prefix()	The Amazon S3 bucket prefix that is the file name and path of the exported data.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CancelExportTaskResponse.Builder>	serializableBuilderClass()
Instant	snapshotTime()	The time when the snapshot was created.
String	sourceArn()	The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
ExportSourceType	sourceType()	The type of source for the export.
String	sourceTypeAsString()	The type of source for the export.
String	status()	The progress status of the export task.
Instant	taskEndTime()	The time when the snapshot or cluster export task ended.
Instant	taskStartTime()	The time when the snapshot or cluster export task started.
CancelExportTaskResponse.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 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 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 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

public final String 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 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 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

public final Instant snapshotTime()

The time when the snapshot was created.

Returns:

The time when the snapshot was created.

taskStartTime

public final Instant taskStartTime()

The time when the snapshot or cluster export task started.

Returns:

The time when the snapshot or cluster export task started.

taskEndTime

public final Instant taskEndTime()

The time when the snapshot or cluster export task ended.

Returns:

The time when the snapshot or cluster export task ended.

s3Bucket

public final String 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

public final String 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

public final String 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

public 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. 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

public final String 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

public final Integer 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

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 or cluster export task.

Returns:

A warning about the snapshot or cluster export task.

sourceType

public final ExportSourceType 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 return ExportSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

The type of source for the export.

See Also:

ExportSourceType

sourceTypeAsString

public final String 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 return ExportSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

The type of source for the export.

See Also:

ExportSourceType

toBuilder

public CancelExportTaskResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CancelExportTaskResponse.Builder,CancelExportTaskResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CancelExportTaskResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CancelExportTaskResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo