Class DescribeEventsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- 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 prior to the time of the request for which to retrieve events.The end of the time interval for which to retrieve events, specified in ISO 8601 format.An optional parameter that specifies the starting point to return a set of response records.The maximum number of response records to return in each call.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 prior to the time of the request for which to retrieve events.void
setEndTime
(Date endTime) The end of the time interval for which to retrieve events, specified in ISO 8601 format.void
An optional parameter that specifies the starting point to return a set of response records.void
setMaxRecords
(Integer maxRecords) The maximum number of response records to return in each call.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 prior to the time of the request for which to retrieve events.withEndTime
(Date endTime) The end of the time interval for which to retrieve events, specified in ISO 8601 format.withMarker
(String marker) An optional parameter that specifies the starting point to return a set of response records.withMaxRecords
(Integer maxRecords) The maximum number of response records to return in each call.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 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
.
- Specify a cluster identifier when SourceType is
- Specify a cluster identifier when SourceType is
-
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
.
- Specify a cluster identifier when SourceType is
- Specify a cluster identifier when SourceType is
-
withSourceIdentifier
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
.
- Specify a cluster identifier when SourceType is
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- Specify a cluster identifier when SourceType is
-
setSourceType
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.
- Specify
- See Also:
- Specify
-
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.
- Specify
- See Also:
- Specify
-
withSourceType
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.
- Specify
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
- Specify
-
setSourceType
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.
- Specify
- See Also:
- Specify
-
withSourceType
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.
- Specify
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
- Specify
-
setStartTime
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
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
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
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
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
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
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
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
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
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 amarker
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 specifiedMaxRecords
value, a value is returned in amarker
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
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 amarker
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 amarker
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
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 amarker
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 specifiedMaxRecords
value, a value is returned in amarker
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
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.
-
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.
-
withMarker
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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
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 inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.- 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:
-