public class DescribeEventsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.Integer |
duration
The number of minutes to retrieve events for.
|
private java.util.Date |
endTime
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
private SdkInternalList<java.lang.String> |
eventCategories
A list of event categories that trigger notifications for a event
notification subscription.
|
private SdkInternalList<Filter> |
filters
This parameter is not currently supported.
|
private java.lang.String |
marker
An optional pagination token provided by a previous DescribeEvents
request.
|
private java.lang.Integer |
maxRecords
The maximum number of records to include in the response.
|
private java.lang.String |
sourceIdentifier
The identifier of the event source for which events will be returned.
|
private java.lang.String |
sourceType
The event source to retrieve events for.
|
private java.util.Date |
startTime
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
NOOP
Constructor and Description |
---|
DescribeEventsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeEventsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Integer |
getDuration()
The number of minutes to retrieve events for.
|
java.util.Date |
getEndTime()
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
java.util.List<java.lang.String> |
getEventCategories()
A list of event categories that trigger notifications for a event
notification subscription.
|
java.util.List<Filter> |
getFilters()
This parameter is not currently supported.
|
java.lang.String |
getMarker()
An optional pagination token provided by a previous DescribeEvents
request.
|
java.lang.Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
java.lang.String |
getSourceIdentifier()
The identifier of the event source for which events will be returned.
|
java.lang.String |
getSourceType()
The event source to retrieve events for.
|
java.util.Date |
getStartTime()
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
int |
hashCode() |
void |
setDuration(java.lang.Integer duration)
The number of minutes to retrieve events for.
|
void |
setEndTime(java.util.Date endTime)
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
void |
setEventCategories(java.util.Collection<java.lang.String> eventCategories)
A list of event categories that trigger notifications for a event
notification subscription.
|
void |
setFilters(java.util.Collection<Filter> filters)
This parameter is not currently supported.
|
void |
setMarker(java.lang.String marker)
An optional pagination token provided by a previous DescribeEvents
request.
|
void |
setMaxRecords(java.lang.Integer maxRecords)
The maximum number of records to include in the response.
|
void |
setSourceIdentifier(java.lang.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(java.lang.String sourceType)
The event source to retrieve events for.
|
void |
setStartTime(java.util.Date startTime)
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeEventsRequest |
withDuration(java.lang.Integer duration)
The number of minutes to retrieve events for.
|
DescribeEventsRequest |
withEndTime(java.util.Date endTime)
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
DescribeEventsRequest |
withEventCategories(java.util.Collection<java.lang.String> eventCategories)
A list of event categories that trigger notifications for a event
notification subscription.
|
DescribeEventsRequest |
withEventCategories(java.lang.String... eventCategories)
A list of event categories that trigger notifications for a event
notification subscription.
|
DescribeEventsRequest |
withFilters(java.util.Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeEventsRequest |
withFilters(Filter... filters)
This parameter is not currently supported.
|
DescribeEventsRequest |
withMarker(java.lang.String marker)
An optional pagination token provided by a previous DescribeEvents
request.
|
DescribeEventsRequest |
withMaxRecords(java.lang.Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeEventsRequest |
withSourceIdentifier(java.lang.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(java.lang.String sourceType)
The event source to retrieve events for.
|
DescribeEventsRequest |
withStartTime(java.util.Date startTime)
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
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
private java.lang.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.
Constraints:
DBInstance
, then a
DBInstanceIdentifier
must be supplied.DBSecurityGroup
, a
DBSecurityGroupName
must be supplied.DBParameterGroup
, a
DBParameterGroupName
must be supplied.DBSnapshot
, a
DBSnapshotIdentifier
must be supplied.private java.lang.String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
private java.util.Date 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
private java.util.Date 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
private java.lang.Integer duration
The number of minutes to retrieve events for.
Default: 60
private SdkInternalList<java.lang.String> eventCategories
A list of event categories that trigger notifications for a event notification subscription.
private SdkInternalList<Filter> filters
This parameter is not currently supported.
private java.lang.Integer maxRecords
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.
private java.lang.String 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 by
MaxRecords
.
public void setSourceIdentifier(java.lang.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.
Constraints:
DBInstance
, then a
DBInstanceIdentifier
must be supplied.DBSecurityGroup
, a
DBSecurityGroupName
must be supplied.DBParameterGroup
, a
DBParameterGroupName
must be supplied.DBSnapshot
, a
DBSnapshotIdentifier
must be supplied.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:
DBInstance
, then a
DBInstanceIdentifier
must be supplied.DBSecurityGroup
, a
DBSecurityGroupName
must be supplied.DBParameterGroup
, a
DBParameterGroupName
must be supplied.DBSnapshot
, a
DBSnapshotIdentifier
must be supplied.public java.lang.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.
Constraints:
DBInstance
, then a
DBInstanceIdentifier
must be supplied.DBSecurityGroup
, a
DBSecurityGroupName
must be supplied.DBParameterGroup
, a
DBParameterGroupName
must be supplied.DBSnapshot
, a
DBSnapshotIdentifier
must be supplied.Constraints:
DBInstance
, then a
DBInstanceIdentifier
must be supplied.DBSecurityGroup
, a
DBSecurityGroupName
must be supplied.DBParameterGroup
, a
DBParameterGroupName
must be supplied.DBSnapshot
, a
DBSnapshotIdentifier
must be supplied.public DescribeEventsRequest withSourceIdentifier(java.lang.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.
Constraints:
DBInstance
, then a
DBInstanceIdentifier
must be supplied.DBSecurityGroup
, a
DBSecurityGroupName
must be supplied.DBParameterGroup
, a
DBParameterGroupName
must be supplied.DBSnapshot
, a
DBSnapshotIdentifier
must be supplied.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:
DBInstance
, then a
DBInstanceIdentifier
must be supplied.DBSecurityGroup
, a
DBSecurityGroupName
must be supplied.DBParameterGroup
, a
DBParameterGroupName
must be supplied.DBSnapshot
, a
DBSnapshotIdentifier
must be supplied.public void setSourceType(java.lang.String sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.SourceType
public java.lang.String getSourceType()
The event source to retrieve events for. If no value is specified, all events are returned.
SourceType
public DescribeEventsRequest withSourceType(java.lang.String sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.SourceType
public void setSourceType(SourceType sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.SourceType
public DescribeEventsRequest withSourceType(SourceType sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.SourceType
public void setStartTime(java.util.Date 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
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
public java.util.Date 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
Example: 2009-07-08T18:00Z
public DescribeEventsRequest withStartTime(java.util.Date 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
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
public void setEndTime(java.util.Date 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
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
public java.util.Date 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
Example: 2009-07-08T18:00Z
public DescribeEventsRequest withEndTime(java.util.Date 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
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
public void setDuration(java.lang.Integer duration)
The number of minutes to retrieve events for.
Default: 60
duration
- The number of minutes to retrieve events for.
Default: 60
public java.lang.Integer getDuration()
The number of minutes to retrieve events for.
Default: 60
Default: 60
public DescribeEventsRequest withDuration(java.lang.Integer duration)
The number of minutes to retrieve events for.
Default: 60
duration
- The number of minutes to retrieve events for.
Default: 60
public java.util.List<java.lang.String> getEventCategories()
A list of event categories that trigger notifications for a event notification subscription.
public void setEventCategories(java.util.Collection<java.lang.String> eventCategories)
A list of event categories that trigger notifications for a event notification subscription.
eventCategories
- A list of event categories that trigger notifications for a event
notification subscription.public DescribeEventsRequest withEventCategories(java.lang.String... eventCategories)
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)
or
withEventCategories(java.util.Collection)
if you want to
override the existing values.
eventCategories
- A list of event categories that trigger notifications for a event
notification subscription.public DescribeEventsRequest withEventCategories(java.util.Collection<java.lang.String> eventCategories)
A list of event categories that trigger notifications for a event notification subscription.
eventCategories
- A list of event categories that trigger notifications for a event
notification subscription.public java.util.List<Filter> getFilters()
This parameter is not currently supported.
public void setFilters(java.util.Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.public DescribeEventsRequest withFilters(Filter... filters)
This parameter is not currently supported.
NOTE: This method appends the values to the existing list (if
any). Use setFilters(java.util.Collection)
or
withFilters(java.util.Collection)
if you want to override the
existing values.
filters
- This parameter is not currently supported.public DescribeEventsRequest withFilters(java.util.Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.public void setMaxRecords(java.lang.Integer maxRecords)
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.
maxRecords
- 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.
public java.lang.Integer 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.
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.
public DescribeEventsRequest withMaxRecords(java.lang.Integer maxRecords)
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.
maxRecords
- 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.
public void setMarker(java.lang.String 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 by
MaxRecords
.
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 by
MaxRecords
.public java.lang.String 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
.
MaxRecords
.public DescribeEventsRequest withMarker(java.lang.String 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 by
MaxRecords
.
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 by
MaxRecords
.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeEventsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()