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

Class DescribeDbClusterBacktracksRequest

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.DescribeDbClusterBacktracksRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDbClusterBacktracksRequest.Builder,DescribeDbClusterBacktracksRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDbClusterBacktracksRequest extends RdsRequest implements ToCopyableBuilder<DescribeDbClusterBacktracksRequest.Builder,DescribeDbClusterBacktracksRequest>

  • Method Details

    • dbClusterIdentifier

      public final String dbClusterIdentifier()

      The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.

      • First character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster1

      Returns:
      The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.

      • First character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster1

    • backtrackIdentifier

      public final String backtrackIdentifier()

      If specified, this value is the backtrack identifier of the backtrack to be described.

      Constraints:

      Example: 123e4567-e89b-12d3-a456-426655440000

      Returns:
      If specified, this value is the backtrack identifier of the backtrack to be described.

      Constraints:

      Example: 123e4567-e89b-12d3-a456-426655440000

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

      A filter that specifies one or more DB clusters to describe. Supported filters include the following:

      • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

      • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

        • applying

        • completed

        • failed

        • pending

        The results list includes information about only the backtracks identified by these values.

      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:
      A filter that specifies one or more DB clusters to describe. Supported filters include the following:

      • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

      • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

        • applying

        • completed

        • failed

        • pending

        The results list includes information about only the backtracks identified by these values.

    • maxRecords

      public final Integer maxRecords()

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can 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 MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • marker

      public final String marker()

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

      Returns:
      An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • toBuilder

      public DescribeDbClusterBacktracksRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeDbClusterBacktracksRequest.Builder,DescribeDbClusterBacktracksRequest>
      Specified by:
      toBuilder in class RdsRequest

    • builder

      public static DescribeDbClusterBacktracksRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDbClusterBacktracksRequest.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo