Class DescribeEventsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.DescribeEventsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- 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 to retrieve events for.Date
getEndTime()
The end of the time interval for which to retrieve events, specified in ISO 8601 format.List<String>
getEventCategories()
A list of event categories that trigger notifications for a event notification subscription.List<Filter>
getFilters()
This parameter is not currently supported.String
getMarker()
An optional pagination token provided by a previous DescribeEvents 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 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
setMarker(String marker)
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeEventsRequest
withDuration(Integer duration)
The number of minutes to retrieve events for.DescribeEventsRequest
withEndTime(Date endTime)
The end of the time interval for which to retrieve events, specified in ISO 8601 format.DescribeEventsRequest
withEventCategories(String... eventCategories)
A list of event categories that trigger notifications for a event notification subscription.DescribeEventsRequest
withEventCategories(Collection<String> eventCategories)
A list of event categories that trigger notifications for a event notification subscription.DescribeEventsRequest
withFilters(Filter... filters)
This parameter is not currently supported.DescribeEventsRequest
withFilters(Collection<Filter> filters)
This parameter is not currently supported.DescribeEventsRequest
withMarker(String marker)
An optional pagination token provided by a previous DescribeEvents 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.
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
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.
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
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.
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
public void setSourceType(String sourceType)
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:
SourceType
-
getSourceType
public String 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:
SourceType
-
withSourceType
public DescribeEventsRequest withSourceType(String sourceType)
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:
SourceType
-
setSourceType
public void setSourceType(SourceType sourceType)
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:
SourceType
-
withSourceType
public DescribeEventsRequest withSourceType(SourceType sourceType)
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:
SourceType
-
setStartTime
public void setStartTime(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
- 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
public 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
- 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
public DescribeEventsRequest withStartTime(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
- 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
public void setEndTime(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
- 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
public 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
- 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
public DescribeEventsRequest withEndTime(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
- 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
public void setDuration(Integer duration)
The number of minutes to retrieve events for.
Default: 60
- Parameters:
duration
- The number of minutes to retrieve events for.Default: 60
-
getDuration
public Integer getDuration()
The number of minutes to retrieve events for.
Default: 60
- Returns:
- The number of minutes to retrieve events for.
Default: 60
-
withDuration
public DescribeEventsRequest withDuration(Integer duration)
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
public List<String> 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
public void setEventCategories(Collection<String> eventCategories)
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
public DescribeEventsRequest withEventCategories(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)
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
public DescribeEventsRequest withEventCategories(Collection<String> eventCategories)
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
public List<Filter> getFilters()
This parameter is not currently supported.
- Returns:
- This parameter is not currently supported.
-
setFilters
public void setFilters(Collection<Filter> filters)
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.
-
withFilters
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)
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
public DescribeEventsRequest withFilters(Collection<Filter> filters)
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
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 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
public 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.
- 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
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 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
public void setMarker(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
.- 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
public 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
.- 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
public DescribeEventsRequest withMarker(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
.- 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
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()
-
-