software.amazon.awssdk.services.rds.model

Class DescribeExportTasksRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.DescribeExportTasksRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeExportTasksRequest
extends RdsRequest
implements ToCopyableBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeExportTasksRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeExportTasksRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exportTaskIdentifier() The identifier of the snapshot export task to be described.
List<Filter>	filters() Filters specify one or more snapshot exports to describe.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
String	marker() An optional pagination token provided by a previous DescribeExportTasks request.
Integer	maxRecords() The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeExportTasksRequest.Builder>	serializableBuilderClass()
String	sourceArn() The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
ExportSourceType	sourceType() The type of source for the export.
String	sourceTypeAsString() The type of source for the export.
DescribeExportTasksRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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()

The identifier of the snapshot export task to be described.

Returns:

The identifier of the snapshot export task to be described.

sourceArn

public final String sourceArn()

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.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<Filter> filters()

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

• export-task-identifier - An identifier for the snapshot export task.

• s3-bucket - The Amazon S3 bucket the snapshot is exported to.

• source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

• status - The status of the export task. Must be lowercase. Valid statuses are the following:

  • canceled

  • canceling

  • complete

  • failed

  • in_progress

  • starting

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 hasFilters() method.

Returns:

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

• export-task-identifier - An identifier for the snapshot export task.

• s3-bucket - The Amazon S3 bucket the snapshot is exported to.

• source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

• status - The status of the export task. Must be lowercase. Valid statuses are the following:

  • canceled

  • canceling

  • complete

  • failed

  • in_progress

  • starting

marker

public final String marker()

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Returns:

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

maxRecords

public final Integer maxRecords()

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

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 DescribeExportTasksRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeExportTasksRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo