All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBParametersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  DescribeDBParametersRequest () Default constructor for DescribeDBParametersRequest object.
  DescribeDBParametersRequest (String dBParameterGroupName) Constructs a new DescribeDBParametersRequest object.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  DescribeDBParametersRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getDBParameterGroupName () The name of a specific DB parameter group to return details for.
  List<Filter>	getFilters () This parameter isn't currently supported.
  String	getMarker () An optional pagination token provided by a previous DescribeDBParameters request.
  Integer	getMaxRecords () The maximum number of records to include in the response.
  String	getSource () The parameter types to return.
  int	hashCode ()
  void	setDBParameterGroupName (String dBParameterGroupName) The name of a specific DB parameter group to return details for.
  void	setFilters (Collection<Filter> filters) This parameter isn't currently supported.
  void	setMarker (String marker) An optional pagination token provided by a previous DescribeDBParameters request.
  void	setMaxRecords (Integer maxRecords) The maximum number of records to include in the response.
  void	setSource (String source) The parameter types to return.
  String	toString () Returns a string representation of this object.
  DescribeDBParametersRequest	withDBParameterGroupName (String dBParameterGroupName) The name of a specific DB parameter group to return details for.
  DescribeDBParametersRequest	withFilters (Collection<Filter> filters) This parameter isn't currently supported.
  DescribeDBParametersRequest	withFilters (Filter... filters) This parameter isn't currently supported.
  DescribeDBParametersRequest	withMarker (String marker) An optional pagination token provided by a previous DescribeDBParameters request.
  DescribeDBParametersRequest	withMaxRecords (Integer maxRecords) The maximum number of records to include in the response.
  DescribeDBParametersRequest	withSource (String source) The parameter types to return.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • DescribeDBParametersRequest

    public DescribeDBParametersRequest()

    Default constructor for DescribeDBParametersRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

  • DescribeDBParametersRequest

    public DescribeDBParametersRequest(String dBParameterGroupName)

    Constructs a new DescribeDBParametersRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

    Parameters:

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

    Constraints:

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

• Method Detail

  • setDBParameterGroupName

    public void setDBParameterGroupName(String dBParameterGroupName)

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

    Constraints:

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

    Parameters:

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

    Constraints:

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

  • getDBParameterGroupName

    public String getDBParameterGroupName()

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

    Constraints:

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

    Returns:

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

    Constraints:

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

  • withDBParameterGroupName

    public DescribeDBParametersRequest withDBParameterGroupName(String dBParameterGroupName)

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

    Constraints:

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

    Parameters:

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

    Constraints:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setSource

    public void setSource(String source)

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    Parameters:

    source - The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

  • getSource

    public String getSource()

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    Returns:

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

  • withSource

    public DescribeDBParametersRequest withSource(String source)

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    Parameters:

    source - The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • getFilters

    public List<Filter> getFilters()

    This parameter isn't currently supported.

    Returns:

    This parameter isn't currently supported.

  • setFilters

    public void setFilters(Collection<Filter> filters)

    This parameter isn't currently supported.

    Parameters:

    filters - This parameter isn't currently supported.

  • withFilters

    public DescribeDBParametersRequest withFilters(Filter... filters)

    This parameter isn't currently supported.

    NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

    Parameters:

    filters - This parameter isn't currently supported.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withFilters

    public DescribeDBParametersRequest withFilters(Collection<Filter> filters)

    This parameter isn't currently supported.

    Parameters:

    filters - This parameter isn't currently supported.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setMaxRecords

    public void setMaxRecords(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 that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    Parameters:

    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 that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • getMaxRecords

    public Integer getMaxRecords()

    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 that 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 that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • withMaxRecords

    public DescribeDBParametersRequest withMaxRecords(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 that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    Parameters:

    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 that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setMarker

    public void setMarker(String marker)

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

    Parameters:

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

  • getMarker

    public String getMarker()

    An optional pagination token provided by a previous DescribeDBParameters 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 DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • withMarker

    public DescribeDBParametersRequest withMarker(String marker)

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

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public DescribeDBParametersRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()