Class DescribeEventsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.elasticache.model.DescribeEventsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a DescribeEvents action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeEventsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeEventsRequest
clone()
Creates a shallow clone of this request.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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
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.
-
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.
-
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.
- 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:
- 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.
Valid values are:
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
-
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
- 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
-
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
- 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:
- Returns a reference to this 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
- 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
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SourceType
-
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.
-
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.
-
withStartTime
public DescribeEventsRequest withStartTime(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.- 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.
- Parameters:
endTime
- The end of the time interval for which to retrieve events, specified in ISO 8601 format.
-
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.
-
withEndTime
public DescribeEventsRequest withEndTime(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.- 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' worth of events to retrieve.
- Parameters:
duration
- The number of minutes' worth of events to retrieve.
-
getDuration
public Integer getDuration()
The number of minutes' worth of events to retrieve.
- Returns:
- The number of minutes' worth of events to retrieve.
-
withDuration
public DescribeEventsRequest withDuration(Integer duration)
The number of minutes' worth of events to retrieve.
- Parameters:
duration
- The number of minutes' worth of events to retrieve.- 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 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 specifiedMaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: minimum 20; maximum 100.
-
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.
-
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.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.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 marker returned from a prior request. Use this marker for pagination of results from this action. 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 action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
-
getMarker
public String getMarker()
An optional marker returned from a prior request. Use this marker for pagination of results from this action. 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 action. 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 action. 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 action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-