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 to retrieve events for.The end of the time interval for which to retrieve events, specified in ISO 8601 format.A list of event categories that trigger notifications for a event notification subscription.This parameter is not currently supported.An optional pagination token provided by a previous DescribeEvents 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 to retrieve events for.void
setEndTime
(Date endTime) The end of the time interval for which to retrieve events, specified in ISO 8601 format.void
setEventCategories
(Collection<String> eventCategories) A list of event categories that trigger notifications for a event notification subscription.void
setFilters
(Collection<Filter> filters) This parameter is not currently supported.void
An optional pagination token provided by a previous DescribeEvents 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 to retrieve events for.withEndTime
(Date endTime) The end of the time interval for which to retrieve events, specified in ISO 8601 format.withEventCategories
(String... eventCategories) A list of event categories that trigger notifications for a event notification subscription.withEventCategories
(Collection<String> eventCategories) A list of event categories that trigger notifications for a event notification subscription.withFilters
(Filter... filters) This parameter is not currently supported.withFilters
(Collection<Filter> filters) This parameter is not currently supported.withMarker
(String marker) An optional pagination token provided by a previous DescribeEvents 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.
Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
- 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.Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
-
getSourceIdentifier
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
- Returns:
- The identifier of the event source for which events will be
returned. If not specified, then all sources are included in the
response.
Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
-
withSourceIdentifier
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
- 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.Constraints:
- If SourceIdentifier is supplied, SourceType must also be provided.
- If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. - If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. - If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. - If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. - Cannot end with a hyphen or contain two consecutive hyphens.
- 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.
- Parameters:
sourceType
- The event source to retrieve events for. If no value is specified, all events are returned.- See Also:
-
getSourceType
The event source to retrieve events for. If no value is specified, all events are returned.
- Returns:
- The event source to retrieve events for. If no value is specified, all events are returned.
- See Also:
-
withSourceType
The event source to retrieve events for. If no value is specified, all events are returned.
- Parameters:
sourceType
- The event source to retrieve events for. If no value is specified, all events are returned.- 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.
- Parameters:
sourceType
- The event source to retrieve events for. If no value is specified, all events are returned.- See Also:
-
withSourceType
The event source to retrieve events for. If no value is specified, all events are returned.
- Parameters:
sourceType
- The event source to retrieve events for. If no value is specified, all events are returned.- 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. 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 to retrieve events for.
Default: 60
- Parameters:
duration
- The number of minutes to retrieve events for.Default: 60
-
getDuration
The number of minutes to retrieve events for.
Default: 60
- Returns:
- The number of minutes to retrieve events for.
Default: 60
-
withDuration
The number of minutes to retrieve events for.
Default: 60
- Parameters:
duration
- The number of minutes to retrieve events for.Default: 60
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getEventCategories
A list of event categories that trigger notifications for a event notification subscription.
- Returns:
- A list of event categories that trigger notifications for a event notification subscription.
-
setEventCategories
A list of event categories that trigger notifications for a event notification subscription.
- Parameters:
eventCategories
- A list of event categories that trigger notifications for a event notification subscription.
-
withEventCategories
A list of event categories that trigger notifications for a event notification subscription.
NOTE: This method appends the values to the existing list (if any). Use
setEventCategories(java.util.Collection)
orwithEventCategories(java.util.Collection)
if you want to override the existing values.- Parameters:
eventCategories
- A list of event categories that trigger notifications for a event notification subscription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEventCategories
A list of event categories that trigger notifications for a event notification subscription.
- Parameters:
eventCategories
- A list of event categories that trigger notifications for a event notification subscription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getFilters
This parameter is not currently supported.
- Returns:
- This parameter is not currently supported.
-
setFilters
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.
-
withFilters
This parameter is not currently supported.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
filters
- This parameter is not currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withFilters
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.- 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 pagination token called 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 pagination token called 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 pagination token called 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 pagination token called 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 pagination token called 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 pagination token called 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 pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.
-
getMarker
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.- Returns:
- An optional pagination token provided by a previous
DescribeEvents request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by
MaxRecords
.
-
withMarker
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- 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:
-