DescribeEventsRequest (AWS SDK for Java

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

All Implemented Interfaces:

Serializable
```
public class DescribeEventsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeEvents operation.
The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

See Also:
AmazonElastiCache.describeEvents(DescribeEventsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeEventsRequest()
Default constructor for a new DescribeEventsRequest object.

Constructors
Constructor and Description
`DescribeEventsRequest()` Default constructor for a new DescribeEventsRequest object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Integer`	`getDuration()` The number of minutes' worth of events to retrieve.
`Date`	`getEndTime()` The end of the time interval for which to retrieve events, specified in ISO 8601 format.
`String`	`getMarker()` An optional marker returned from a prior request.
`Integer`	`getMaxRecords()` The maximum number of records to include in the response.
`String`	`getSourceIdentifier()` The identifier of the event source for which events will be returned.
`String`	`getSourceType()` The event source to retrieve events for.
`Date`	`getStartTime()` The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
`int`	`hashCode()`
`void`	`setDuration(Integer duration)` The number of minutes' worth of events to retrieve.
`void`	`setEndTime(Date endTime)` The end of the time interval for which to retrieve events, specified in ISO 8601 format.
`void`	`setMarker(String marker)` An optional marker returned from a prior request.
`void`	`setMaxRecords(Integer maxRecords)` The maximum number of records to include in the response.
`void`	`setSourceIdentifier(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(String sourceType)` The event source to retrieve events for.
`void`	`setStartTime(Date startTime)` The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeEventsRequest`	`withDuration(Integer duration)` The number of minutes' worth of events to retrieve.
`DescribeEventsRequest`	`withEndTime(Date endTime)` The end of the time interval for which to retrieve events, specified in ISO 8601 format.
`DescribeEventsRequest`	`withMarker(String marker)` An optional marker returned from a prior request.
`DescribeEventsRequest`	`withMaxRecords(Integer maxRecords)` The maximum number of records to include in the response.
`DescribeEventsRequest`	`withSourceIdentifier(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(String sourceType)` The event source to retrieve events for.
`DescribeEventsRequest`	`withStartTime(Date startTime)` The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeEventsRequest
```
public DescribeEventsRequest()
```
    Default constructor for a new DescribeEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
- Method Detail
  - getSourceIdentifier
```
public String getSourceIdentifier()
```
    The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
    
    Returns:
    The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
  - setSourceIdentifier
```
public void setSourceIdentifier(String sourceIdentifier)
```
    The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
    
    Parameters:
    sourceIdentifier - The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
  - withSourceIdentifier
```
public DescribeEventsRequest withSourceIdentifier(String sourceIdentifier)
```
    The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    sourceIdentifier - The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSourceType
```
public String getSourceType()
```
    The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    Constraints:
    Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
    
    Returns:
    The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    See Also:
    SourceType
  - setSourceType
```
public void setSourceType(String sourceType)
```
    The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    Constraints:
    Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
    
    Parameters:
    sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    See Also:
    SourceType
  - withSourceType
```
public DescribeEventsRequest withSourceType(String sourceType)
```
    The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
    
    Parameters:
    sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SourceType
  - setSourceType
```
public void setSourceType(SourceType sourceType)
```
    The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    Constraints:
    Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
    
    Parameters:
    sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    See Also:
    SourceType
  - withSourceType
```
public DescribeEventsRequest withSourceType(SourceType sourceType)
```
    The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
    
    Parameters:
    sourceType - The event source to retrieve events for. If no value is specified, all events are returned.
    Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SourceType
  - getStartTime
```
public Date getStartTime()
```
    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    
    Returns:
    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    
    Parameters:
    startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
  - withStartTime
```
public DescribeEventsRequest withStartTime(Date startTime)
```
    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEndTime
```
public Date getEndTime()
```
    The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    
    Returns:
    The end of the time interval for which to retrieve events, specified in ISO 8601 format.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    
    Parameters:
    endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.
  - withEndTime
```
public DescribeEventsRequest withEndTime(Date endTime)
```
    The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDuration
```
public Integer getDuration()
```
    The number of minutes' worth of events to retrieve.
    
    Returns:
    The number of minutes' worth of events to retrieve.
  - setDuration
```
public void setDuration(Integer duration)
```
    The number of minutes' worth of events to retrieve.
    
    Parameters:
    duration - The number of minutes' worth of events to retrieve.
  - withDuration
```
public DescribeEventsRequest withDuration(Integer duration)
```
    The number of minutes' worth of events to retrieve.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    duration - The number of minutes' worth of events to retrieve.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMaxRecords
```
public 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 can be retrieved.
    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 marker is included in the response so that the remaining results can be retrieved.
    Default: 100
    Constraints: minimum 20; maximum 100.
  - 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 marker is included in the response so that the remaining results can be retrieved.
    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 marker is included in the response so that the remaining results can be retrieved.
    Default: 100
    Constraints: minimum 20; maximum 100.
  - withMaxRecords
```
public DescribeEventsRequest withMaxRecords(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 can be retrieved.
    Default: 100
    Constraints: minimum 20; maximum 100.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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 can be retrieved.
    Default: 100
    Constraints: minimum 20; maximum 100.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMarker
```
public String getMarker()
```
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    
    Returns:
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - setMarker
```
public void setMarker(String marker)
```
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    
    Parameters:
    marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - withMarker
```
public DescribeEventsRequest withMarker(String marker)
```
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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.
    
    Parameters:
    marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 updated 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:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeEventsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeEventsRequest

Method Detail

getSourceIdentifier

setSourceIdentifier

withSourceIdentifier

getSourceType

setSourceType

withSourceType

setSourceType

withSourceType

getStartTime

setStartTime

withStartTime

getEndTime

setEndTime

withEndTime

getDuration

setDuration

withDuration

getMaxRecords

setMaxRecords

withMaxRecords

getMarker

setMarker

withMarker

toString

hashCode

equals