Class DescribeEventsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a DescribeEvents action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The number of minutes' worth of events to retrieve.The end of the time interval for which to retrieve events, specified in ISO 8601 format.An optional marker returned from a prior request.The maximum number of records to include in the response.The identifier of the event source for which events will be returned.The event source to retrieve events for.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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withDuration
(Integer duration) The number of minutes' worth of events to retrieve.withEndTime
(Date endTime) The end of the time interval for which to retrieve events, specified in ISO 8601 format.withMarker
(String marker) An optional marker returned from a prior request.withMaxRecords
(Integer maxRecords) The maximum number of records to include in the response.withSourceIdentifier
(String sourceIdentifier) The identifier of the event source for which events will be returned.withSourceType
(SourceType sourceType) The event source to retrieve events for.withSourceType
(String sourceType) The event source to retrieve events for.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
-
Constructor Details
-
DescribeEventsRequest
public DescribeEventsRequest()
-
-
Method Details
-
setSourceIdentifier
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
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
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
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:
-
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:
-
withSourceType
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:
-
setSourceType
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:
-
withSourceType
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:
-
setStartTime
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
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
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
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
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
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
The number of minutes' worth of events to retrieve.
- Parameters:
duration
- The number of minutes' worth of events to retrieve.
-
getDuration
The number of minutes' worth of events to retrieve.
- Returns:
- The number of minutes' worth of events to retrieve.
-
withDuration
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-