Class DescribeEventsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.redshift.model.DescribeEventsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:
  • Constructor Details

    • DescribeEventsRequest

      public DescribeEventsRequest()
  • Method Details

    • setSourceIdentifier

      public void setSourceIdentifier(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.
      Parameters:
      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.
    • getSourceIdentifier

      public 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.
      Returns:
      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(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setSourceType

      public void setSourceType(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.
      Parameters:
      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.
      See Also:
    • getSourceType

      public 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.
      Returns:
      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.
      See Also:
    • withSourceType

      public DescribeEventsRequest withSourceType(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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
      Parameters:
      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.
      See Also:
    • 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.
      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setStartTime

      public void setStartTime(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

      Parameters:
      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

    • getStartTime

      public 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

      Returns:
      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(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setEndTime

      public void setEndTime(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

      Parameters:
      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

    • getEndTime

      public 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

      Returns:
      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(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setDuration

      public void setDuration(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

      Parameters:
      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

    • getDuration

      public 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

      Returns:
      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(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • setMaxRecords

      public void setMaxRecords(Integer maxRecords)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

      Parameters:
      maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • getMaxRecords

      public Integer getMaxRecords()

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

      Returns:
      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • withMaxRecords

      public DescribeEventsRequest withMaxRecords(Integer maxRecords)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

      Parameters:
      maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      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 parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Parameters:
      marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
    • getMarker

      public String getMarker()

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Returns:
      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
    • withMarker

      public DescribeEventsRequest withMarker(String marker)

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Parameters:
      marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeEventsRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: