Package 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("software.amazon.awssdk:codegen") public final class DescribeExportTasksRequest extends RdsRequest implements ToCopyableBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>

  • Method Details

    • exportTaskIdentifier

      public final String exportTaskIdentifier()

      The identifier of the snapshot or cluster export task to be described.

      Returns:
      The identifier of the snapshot or cluster export task to be described.

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

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

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

      • source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster 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 or cluster 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 or cluster export task.

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

      • source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster 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:

    • 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:

    • toBuilder

      public DescribeExportTasksRequest.Builder 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 interface ToCopyableBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>
      Specified by:
      toBuilder in class RdsRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.