com.amazonaws.services.cloudwatch.model

## クラス DescribeAlarmsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest

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

      public class DescribeAlarmsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DescribeAlarms operation`.

  Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

  関連項目:
    `AmazonCloudWatch.describeAlarms(DescribeAlarmsRequest)`, 直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getActionPrefix()` The action name prefix.
    `java.lang.String` | `getAlarmNamePrefix()` The alarm name prefix.
    `java.util.List<java.lang.String>` | `getAlarmNames()` A list of alarm names to retrieve information for.
    `java.lang.Integer` | `getMaxRecords()` The maximum number of alarm descriptions to retrieve.
    `java.lang.String` | `getNextToken()` The token returned by a previous call to indicate that there is more data available.
    `java.lang.String` | `getStateValue()` The state value to be used in matching alarms.
    `int` | `hashCode()`
    `void` | `setActionPrefix(java.lang.String actionPrefix)` The action name prefix.
    `void` | `setAlarmNamePrefix(java.lang.String alarmNamePrefix)` The alarm name prefix.
    `void` | `setAlarmNames(java.util.Collection<java.lang.String> alarmNames)` A list of alarm names to retrieve information for.
    `void` | `setMaxRecords(java.lang.Integer maxRecords)` The maximum number of alarm descriptions to retrieve.
    `void` | `setNextToken(java.lang.String nextToken)` The token returned by a previous call to indicate that there is more data available.
    `void` | `setStateValue(StateValue stateValue)` The state value to be used in matching alarms.
    `void` | `setStateValue(java.lang.String stateValue)` The state value to be used in matching alarms.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `DescribeAlarmsRequest` | `withActionPrefix(java.lang.String actionPrefix)` The action name prefix.
    `DescribeAlarmsRequest` | `withAlarmNamePrefix(java.lang.String alarmNamePrefix)` The alarm name prefix.
    `DescribeAlarmsRequest` | `withAlarmNames(java.util.Collection<java.lang.String> alarmNames)` A list of alarm names to retrieve information for.
    `DescribeAlarmsRequest` | `withAlarmNames(java.lang.String... alarmNames)` A list of alarm names to retrieve information for.
    `DescribeAlarmsRequest` | `withMaxRecords(java.lang.Integer maxRecords)` The maximum number of alarm descriptions to retrieve.
    `DescribeAlarmsRequest` | `withNextToken(java.lang.String nextToken)` The token returned by a previous call to indicate that there is more data available.
    `DescribeAlarmsRequest` | `withStateValue(StateValue stateValue)` The state value to be used in matching alarms.
    `DescribeAlarmsRequest` | `withStateValue(java.lang.String stateValue)` The state value to be used in matching alarms.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### DescribeAlarmsRequest

          public DescribeAlarmsRequest()

  - ### メソッドの詳細

    - #### getAlarmNames

          public java.util.List<java.lang.String> getAlarmNames()

      A list of alarm names to retrieve information for.

      Constraints:
      Length: 0 - 100

      戻り値:
        A list of alarm names to retrieve information for.

    - #### setAlarmNames

          public void setAlarmNames(java.util.Collection<java.lang.String> alarmNames)

      A list of alarm names to retrieve information for.

      Constraints:
      Length: 0 - 100

      パラメータ:
        `alarmNames` - A list of alarm names to retrieve information for.

    - #### withAlarmNames

          public DescribeAlarmsRequest withAlarmNames(java.lang.String... alarmNames)

      A list of alarm names to retrieve information for.

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

      Constraints:
      Length: 0 - 100

      パラメータ:
        `alarmNames` - A list of alarm names to retrieve information for.

    - #### withAlarmNames

          public DescribeAlarmsRequest withAlarmNames(java.util.Collection<java.lang.String> alarmNames)

      A list of alarm names to retrieve information for.

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

      Constraints:
      Length: 0 - 100

      パラメータ:
        `alarmNames` - A list of alarm names to retrieve information for.

    - #### getAlarmNamePrefix

          public java.lang.String getAlarmNamePrefix()

      The alarm name prefix. `AlarmNames` cannot be specified if this parameter is specified.

      Constraints:
      Length: 1 - 255

      戻り値:
        The alarm name prefix. `AlarmNames` cannot be specified if this parameter is specified.

    - #### setAlarmNamePrefix

          public void setAlarmNamePrefix(java.lang.String alarmNamePrefix)

      The alarm name prefix. `AlarmNames` cannot be specified if this parameter is specified.

      Constraints:
      Length: 1 - 255

      パラメータ:
        `alarmNamePrefix` - The alarm name prefix. `AlarmNames` cannot be specified if this parameter is specified.

    - #### withAlarmNamePrefix

          public DescribeAlarmsRequest withAlarmNamePrefix(java.lang.String alarmNamePrefix)

      The alarm name prefix. `AlarmNames` cannot be specified if this parameter is specified.

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

      Constraints:
      Length: 1 - 255

      パラメータ:
        `alarmNamePrefix` - The alarm name prefix. `AlarmNames` cannot be specified if this parameter is specified.

    - #### getStateValue

          public java.lang.String getStateValue()

      The state value to be used in matching alarms.

      Constraints:
      Allowed Values: OK, ALARM, INSUFFICIENT_DATA

      戻り値:
        The state value to be used in matching alarms.
      関連項目:
        `StateValue`

    - #### setStateValue

          public void setStateValue(java.lang.String stateValue)

      The state value to be used in matching alarms.

      Constraints:
      Allowed Values: OK, ALARM, INSUFFICIENT_DATA

      パラメータ:
        `stateValue` - The state value to be used in matching alarms.
      関連項目:
        `StateValue`

    - #### withStateValue

          public DescribeAlarmsRequest withStateValue(java.lang.String stateValue)

      The state value to be used in matching alarms.

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

      Constraints:
      Allowed Values: OK, ALARM, INSUFFICIENT_DATA

      パラメータ:
        `stateValue` - The state value to be used in matching alarms.
      関連項目:
        `StateValue`

    - #### setStateValue

          public void setStateValue(StateValue stateValue)

      The state value to be used in matching alarms.

      Constraints:
      Allowed Values: OK, ALARM, INSUFFICIENT_DATA

      パラメータ:
        `stateValue` - The state value to be used in matching alarms.
      関連項目:
        `StateValue`

    - #### withStateValue

          public DescribeAlarmsRequest withStateValue(StateValue stateValue)

      The state value to be used in matching alarms.

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

      Constraints:
      Allowed Values: OK, ALARM, INSUFFICIENT_DATA

      パラメータ:
        `stateValue` - The state value to be used in matching alarms.
      関連項目:
        `StateValue`

    - #### getActionPrefix

          public java.lang.String getActionPrefix()

      The action name prefix.

      Constraints:
      Length: 1 - 1024

      戻り値:
        The action name prefix.

    - #### setActionPrefix

          public void setActionPrefix(java.lang.String actionPrefix)

      The action name prefix.

      Constraints:
      Length: 1 - 1024

      パラメータ:
        `actionPrefix` - The action name prefix.

    - #### withActionPrefix

          public DescribeAlarmsRequest withActionPrefix(java.lang.String actionPrefix)

      The action name prefix.

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

      Constraints:
      Length: 1 - 1024

      パラメータ:
        `actionPrefix` - The action name prefix.

    - #### getMaxRecords

          public java.lang.Integer getMaxRecords()

      The maximum number of alarm descriptions to retrieve.

      Constraints:
      Range: 1 - 100

      戻り値:
        The maximum number of alarm descriptions to retrieve.

    - #### setMaxRecords

          public void setMaxRecords(java.lang.Integer maxRecords)

      The maximum number of alarm descriptions to retrieve.

      Constraints:
      Range: 1 - 100

      パラメータ:
        `maxRecords` - The maximum number of alarm descriptions to retrieve.

    - #### withMaxRecords

          public DescribeAlarmsRequest withMaxRecords(java.lang.Integer maxRecords)

      The maximum number of alarm descriptions to retrieve.

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

      Constraints:
      Range: 1 - 100

      パラメータ:
        `maxRecords` - The maximum number of alarm descriptions to retrieve.

    - #### getNextToken

          public java.lang.String getNextToken()

      The token returned by a previous call to indicate that there is more data available.
      戻り値:
        The token returned by a previous call to indicate that there is more data available.

    - #### setNextToken

          public void setNextToken(java.lang.String nextToken)

      The token returned by a previous call to indicate that there is more data available.
      パラメータ:
        `nextToken` - The token returned by a previous call to indicate that there is more data available.

    - #### withNextToken

          public DescribeAlarmsRequest withNextToken(java.lang.String nextToken)

      The token returned by a previous call to indicate that there is more data available.

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

      パラメータ:
        `nextToken` - The token returned by a previous call to indicate that there is more data available.

    - #### 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`