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

Class DescribeDbClusterParametersRequest

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

  • Method Details

    • dbClusterParameterGroupName

      public final String dbClusterParameterGroupName()

      The name of a specific DB cluster parameter group to return parameter details for.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

      Returns:
      The name of a specific DB cluster parameter group to return parameter details for.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

    • source

      public final String source()

      A specific source to return parameters for.

      Valid Values:

      • engine-default

      • system

      • user

      Returns:
      A specific source to return parameters for.

      Valid Values:

      • engine-default

      • system

      • user

    • 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 cluster parameters to describe.

      The only supported filter is parameter-name. The results list only includes information about the DB cluster parameters with these names.

      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 cluster parameters to describe.

      The only supported filter is parameter-name. The results list only includes information about the DB cluster parameters with these names.

    • 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 DescribeDBClusterParameters 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 DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • toBuilder

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

    • builder

      public static DescribeDbClusterParametersRequest.Builder builder()

    • serializableBuilderClass

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