com.amazonaws.services.redshift.model

## クラス DescribeEventsRequest

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

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

      public class DescribeEventsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DescribeEvents operation`.

  Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.Integer` | `getDuration()` The number of minutes prior to the time of the request for which to retrieve events.
    `java.util.Date` | `getEndTime()` The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    `java.lang.String` | `getMarker()` An optional marker returned from a previous DescribeEvents request.
    `java.lang.Integer` | `getMaxRecords()` The maximum number of records to include in the response.
    `java.lang.String` | `getSourceIdentifier()` The identifier of the event source for which events will be returned.
    `java.lang.String` | `getSourceType()` The event source to retrieve events for.
    `java.util.Date` | `getStartTime()` The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    `int` | `hashCode()`
    `void` | `setDuration(java.lang.Integer duration)` The number of minutes prior to the time of the request for which to retrieve events.
    `void` | `setEndTime(java.util.Date endTime)` The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    `void` | `setMarker(java.lang.String marker)` An optional marker returned from a previous DescribeEvents request.
    `void` | `setMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.
    `void` | `setSourceIdentifier(java.lang.String sourceIdentifier)` The identifier of the event source for which events will be returned.
    `void` | `setSourceType(SourceType sourceType)` The event source to retrieve events for.
    `void` | `setSourceType(java.lang.String sourceType)` The event source to retrieve events for.
    `void` | `setStartTime(java.util.Date startTime)` The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `DescribeEventsRequest` | `withDuration(java.lang.Integer duration)` The number of minutes prior to the time of the request for which to retrieve events.
    `DescribeEventsRequest` | `withEndTime(java.util.Date endTime)` The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    `DescribeEventsRequest` | `withMarker(java.lang.String marker)` An optional marker returned from a previous DescribeEvents request.
    `DescribeEventsRequest` | `withMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.
    `DescribeEventsRequest` | `withSourceIdentifier(java.lang.String sourceIdentifier)` The identifier of the event source for which events will be returned.
    `DescribeEventsRequest` | `withSourceType(SourceType sourceType)` The event source to retrieve events for.
    `DescribeEventsRequest` | `withSourceType(java.lang.String sourceType)` The event source to retrieve events for.
    `DescribeEventsRequest` | `withStartTime(java.util.Date startTime)` The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### DescribeEventsRequest

          public DescribeEventsRequest()

  - ### メソッドの詳細

    - #### getSourceIdentifier

          public java.lang.String getSourceIdentifier()

      The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

      Constraints:

      If SourceIdentifier is supplied, SourceType must also be provided.

      - Specify a cluster identifier when SourceType is `cluster`.
      - Specify a cluster security group name when SourceType is `cluster-security-group`.
      - Specify a cluster parameter group name when SourceType is `cluster-parameter-group`.
      - Specify a cluster snapshot identifier when SourceType is `cluster-snapshot`.
      戻り値:
        The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

        Constraints:

        If SourceIdentifier is supplied, SourceType must also be provided.

        - Specify a cluster identifier when SourceType is `cluster`.
        - Specify a cluster security group name when SourceType is `cluster-security-group`.
        - Specify a cluster parameter group name when SourceType is `cluster-parameter-group`.
        - Specify a cluster snapshot identifier when SourceType is `cluster-snapshot`.

    - #### setSourceIdentifier

          public void setSourceIdentifier(java.lang.String sourceIdentifier)

      The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

      Constraints:

      If SourceIdentifier is supplied, SourceType must also be provided.

      - Specify a cluster identifier when SourceType is `cluster`.
      - Specify a cluster security group name when SourceType is `cluster-security-group`.
      - Specify a cluster parameter group name when SourceType is `cluster-parameter-group`.
      - Specify a cluster snapshot identifier when SourceType is `cluster-snapshot`.
      パラメータ:
        `sourceIdentifier` - The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

        Constraints:

        If SourceIdentifier is supplied, SourceType must also be provided.

        - Specify a cluster identifier when SourceType is `cluster`.
        - Specify a cluster security group name when SourceType is `cluster-security-group`.
        - Specify a cluster parameter group name when SourceType is `cluster-parameter-group`.
        - Specify a cluster snapshot identifier when SourceType is `cluster-snapshot`.

    - #### withSourceIdentifier

          public DescribeEventsRequest withSourceIdentifier(java.lang.String sourceIdentifier)

      The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

      Constraints:

      If SourceIdentifier is supplied, SourceType must also be provided.

      - Specify a cluster identifier when SourceType is `cluster`.
      - Specify a cluster security group name when SourceType is `cluster-security-group`.
      - Specify a cluster parameter group name when SourceType is `cluster-parameter-group`.
      - Specify a cluster snapshot identifier when SourceType is `cluster-snapshot`.

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

      パラメータ:
        `sourceIdentifier` - The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

        Constraints:

        If SourceIdentifier is supplied, SourceType must also be provided.

        - Specify a cluster identifier when SourceType is `cluster`.
        - Specify a cluster security group name when SourceType is `cluster-security-group`.
        - Specify a cluster parameter group name when SourceType is `cluster-parameter-group`.
        - Specify a cluster snapshot identifier when SourceType is `cluster-snapshot`.

    - #### getSourceType

          public java.lang.String getSourceType()

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      - Specify `cluster` when SourceIdentifier is a cluster identifier.
      - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
      - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
      - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.

      Constraints:
      Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot

      戻り値:
        The event source to retrieve events for. If no value is specified, all events are returned.

        Constraints:

        If SourceType is supplied, SourceIdentifier must also be provided.

        - Specify `cluster` when SourceIdentifier is a cluster identifier.
        - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
        - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
        - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.
      関連項目:
        `SourceType`

    - #### setSourceType

          public void setSourceType(java.lang.String sourceType)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      - Specify `cluster` when SourceIdentifier is a cluster identifier.
      - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
      - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
      - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.

      Constraints:
      Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot

      パラメータ:
        `sourceType` - The event source to retrieve events for. If no value is specified, all events are returned.

        Constraints:

        If SourceType is supplied, SourceIdentifier must also be provided.

        - Specify `cluster` when SourceIdentifier is a cluster identifier.
        - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
        - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
        - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.
      関連項目:
        `SourceType`

    - #### withSourceType

          public DescribeEventsRequest withSourceType(java.lang.String sourceType)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      - Specify `cluster` when SourceIdentifier is a cluster identifier.
      - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
      - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
      - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.

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

      Constraints:
      Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot

      パラメータ:
        `sourceType` - The event source to retrieve events for. If no value is specified, all events are returned.

        Constraints:

        If SourceType is supplied, SourceIdentifier must also be provided.

        - Specify `cluster` when SourceIdentifier is a cluster identifier.
        - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
        - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
        - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.
      関連項目:
        `SourceType`

    - #### setSourceType

          public void setSourceType(SourceType sourceType)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      - Specify `cluster` when SourceIdentifier is a cluster identifier.
      - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
      - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
      - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.

      Constraints:
      Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot

      パラメータ:
        `sourceType` - The event source to retrieve events for. If no value is specified, all events are returned.

        Constraints:

        If SourceType is supplied, SourceIdentifier must also be provided.

        - Specify `cluster` when SourceIdentifier is a cluster identifier.
        - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
        - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
        - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.
      関連項目:
        `SourceType`

    - #### withSourceType

          public DescribeEventsRequest withSourceType(SourceType sourceType)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      - Specify `cluster` when SourceIdentifier is a cluster identifier.
      - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
      - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
      - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.

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

      Constraints:
      Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot

      パラメータ:
        `sourceType` - The event source to retrieve events for. If no value is specified, all events are returned.

        Constraints:

        If SourceType is supplied, SourceIdentifier must also be provided.

        - Specify `cluster` when SourceIdentifier is a cluster identifier.
        - Specify `cluster-security-group` when SourceIdentifier is a cluster security group name.
        - Specify `cluster-parameter-group` when SourceIdentifier is a cluster parameter group name.
        - Specify `cluster-snapshot` when SourceIdentifier is a cluster snapshot identifier.
      関連項目:
        `SourceType`

    - #### getStartTime

          public java.util.Date getStartTime()

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: `2009-07-08T18:00Z`

      戻り値:
        The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: `2009-07-08T18:00Z`

    - #### setStartTime

          public void setStartTime(java.util.Date startTime)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: `2009-07-08T18:00Z`

      パラメータ:
        `startTime` - The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: `2009-07-08T18:00Z`

    - #### withStartTime

          public DescribeEventsRequest withStartTime(java.util.Date startTime)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: `2009-07-08T18:00Z`

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

      パラメータ:
        `startTime` - The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: `2009-07-08T18:00Z`

    - #### getEndTime

          public java.util.Date getEndTime()

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: `2009-07-08T18:00Z`

      戻り値:
        The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: `2009-07-08T18:00Z`

    - #### setEndTime

          public void setEndTime(java.util.Date endTime)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: `2009-07-08T18:00Z`

      パラメータ:
        `endTime` - The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: `2009-07-08T18:00Z`

    - #### withEndTime

          public DescribeEventsRequest withEndTime(java.util.Date endTime)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: `2009-07-08T18:00Z`

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

      パラメータ:
        `endTime` - The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

        Example: `2009-07-08T18:00Z`

    - #### getDuration

          public java.lang.Integer getDuration()

      The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

      Default: `60`

      戻り値:
        The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

        Default: `60`

    - #### setDuration

          public void setDuration(java.lang.Integer duration)

      The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

      Default: `60`

      パラメータ:
        `duration` - The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

        Default: `60`

    - #### withDuration

          public DescribeEventsRequest withDuration(java.lang.Integer duration)

      The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

      Default: `60`

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

      パラメータ:
        `duration` - The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

        Default: `60`

    - #### 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, a marker is included in the response so that the remaining results may be retrieved.

      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, a marker is included in the response so that the remaining results may be retrieved.

        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, a marker is included in the response so that the remaining results may be retrieved.

      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, a marker is included in the response so that the remaining results may be retrieved.

        Default: `100`

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

    - #### withMaxRecords

          public DescribeEventsRequest withMaxRecords(java.lang.Integer maxRecords)

      The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results may be retrieved.

      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, a marker is included in the response so that the remaining results may be retrieved.

        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 DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.
      戻り値:
        An optional marker returned from a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.

    - #### setMarker

          public void setMarker(java.lang.String marker)

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

    - #### withMarker

          public DescribeEventsRequest withMarker(java.lang.String marker)

      An optional marker returned from a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the 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 DescribeEvents request. If this parameter is specified, the response includes only records beyond the 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`