com.amazonaws.services.redshift.model

## クラス DescribeClusterParametersRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.redshift.model.DescribeClusterParametersRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class DescribeClusterParametersRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DescribeClusterParameters operation`.

  Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

  You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user .

  For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide .

  関連項目:
    `AmazonRedshift.describeClusterParameters(DescribeClusterParametersRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `DescribeClusterParametersRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getMarker()` An optional marker returned from a previous DescribeClusterParameters request.
    `java.lang.Integer` | `getMaxRecords()` The maximum number of records to include in the response.
    `java.lang.String` | `getParameterGroupName()` The name of a cluster parameter group for which to return details.
    `java.lang.String` | `getSource()` The parameter types to return.
    `int` | `hashCode()`
    `void` | `setMarker(java.lang.String marker)` An optional marker returned from a previous DescribeClusterParameters request.
    `void` | `setMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.
    `void` | `setParameterGroupName(java.lang.String parameterGroupName)` The name of a cluster parameter group for which to return details.
    `void` | `setSource(java.lang.String source)` The parameter types to return.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `DescribeClusterParametersRequest` | `withMarker(java.lang.String marker)` An optional marker returned from a previous DescribeClusterParameters request.
    `DescribeClusterParametersRequest` | `withMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.
    `DescribeClusterParametersRequest` | `withParameterGroupName(java.lang.String parameterGroupName)` The name of a cluster parameter group for which to return details.
    `DescribeClusterParametersRequest` | `withSource(java.lang.String source)` The parameter types to return.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### DescribeClusterParametersRequest

          public DescribeClusterParametersRequest()

  - ### メソッドの詳細

    - #### getParameterGroupName

          public java.lang.String getParameterGroupName()

      The name of a cluster parameter group for which to return details.
      戻り値:
        The name of a cluster parameter group for which to return details.

    - #### setParameterGroupName

          public void setParameterGroupName(java.lang.String parameterGroupName)

      The name of a cluster parameter group for which to return details.
      パラメータ:
        `parameterGroupName` - The name of a cluster parameter group for which to return details.

    - #### withParameterGroupName

          public DescribeClusterParametersRequest withParameterGroupName(java.lang.String parameterGroupName)

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

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

      パラメータ:
        `parameterGroupName` - The name of a cluster parameter group for which to return details.

    - #### getSource

          public java.lang.String getSource()

      The parameter types to return. Specify `user` to show parameters that are different form the default. Similarly, specify `engine-default` to show parameters that are the same as the default parameter group.

      Default: All parameter types returned.

      Valid Values: `user` | `engine-default`

      戻り値:
        The parameter types to return. Specify `user` to show parameters that are different form the default. Similarly, specify `engine-default` to show parameters that are the same as the default parameter group.

        Default: All parameter types returned.

        Valid Values: `user` | `engine-default`

    - #### setSource

          public void setSource(java.lang.String source)

      The parameter types to return. Specify `user` to show parameters that are different form the default. Similarly, specify `engine-default` to show parameters that are the same as the default parameter group.

      Default: All parameter types returned.

      Valid Values: `user` | `engine-default`

      パラメータ:
        `source` - The parameter types to return. Specify `user` to show parameters that are different form the default. Similarly, specify `engine-default` to show parameters that are the same as the default parameter group.

        Default: All parameter types returned.

        Valid Values: `user` | `engine-default`

    - #### withSource

          public DescribeClusterParametersRequest withSource(java.lang.String source)

      The parameter types to return. Specify `user` to show parameters that are different form the default. Similarly, specify `engine-default` to show parameters that are the same as the default parameter group.

      Default: All parameter types returned.

      Valid Values: `user` | `engine-default`

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

      パラメータ:
        `source` - The parameter types to return. Specify `user` to show parameters that are different form the default. Similarly, specify `engine-default` to show parameters that are the same as the default parameter group.

        Default: All parameter types returned.

        Valid Values: `user` | `engine-default`

    - #### getMaxRecords

          public java.lang.Integer getMaxRecords()

      The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

      Default: `100`

      Constraints: Value must be at least 20 and no more than 100.

      戻り値:
        The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

        Default: `100`

        Constraints: Value must be at least 20 and no more than 100.

    - #### setMaxRecords

          public void setMaxRecords(java.lang.Integer maxRecords)

      The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

      Default: `100`

      Constraints: Value must be at least 20 and no more than 100.

      パラメータ:
        `maxRecords` - The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

        Default: `100`

        Constraints: Value must be at least 20 and no more than 100.

    - #### withMaxRecords

          public DescribeClusterParametersRequest withMaxRecords(java.lang.Integer maxRecords)

      The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

      Default: `100`

      Constraints: Value must be at least 20 and no more than 100.

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

      パラメータ:
        `maxRecords` - The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, response includes a marker that you can specify in your subsequent request to retrieve remaining result.

        Default: `100`

        Constraints: Value must be at least 20 and no more than 100.

    - #### getMarker

          public java.lang.String getMarker()

      An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by `MaxRecords`.
      戻り値:
        An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by `MaxRecords`.

    - #### setMarker

          public void setMarker(java.lang.String marker)

      An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by `MaxRecords`.
      パラメータ:
        `marker` - An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by `MaxRecords`.

    - #### withMarker

          public DescribeClusterParametersRequest withMarker(java.lang.String marker)

      An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by `MaxRecords`.

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

      パラメータ:
        `marker` - An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by `MaxRecords`.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`