@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input to DescribeEvents.
NOOP
Constructor and Description |
---|
DescribeEventsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeEventsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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 an event notification subscription.
|
List<Filter> |
getFilters()
This parameter is not currently supported.
|
String |
getMarker()
An optional pagination token provided by a previous request.
|
Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
String |
getSourceIdentifier()
The identifier of the event source for which events are 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 an 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 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 are returned.
|
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.
|
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(Collection<String> eventCategories)
A list of event categories that trigger notifications for an event notification subscription.
|
DescribeEventsRequest |
withEventCategories(String... eventCategories)
A list of event categories that trigger notifications for an event notification subscription.
|
DescribeEventsRequest |
withFilters(Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeEventsRequest |
withFilters(Filter... filters)
This parameter is not currently supported.
|
DescribeEventsRequest |
withMarker(String marker)
An optional pagination token provided by a previous 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 are 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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setSourceIdentifier(String sourceIdentifier)
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier
is provided, SourceType
must also be provided.
If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
sourceIdentifier
- The identifier of the event source for which events are returned. If not specified, then all sources are
included in the response.
Constraints:
If SourceIdentifier
is provided, SourceType
must also be provided.
If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
public String getSourceIdentifier()
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier
is provided, SourceType
must also be provided.
If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIdentifier
is provided, SourceType
must also be provided.
If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be
provided.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
public DescribeEventsRequest withSourceIdentifier(String sourceIdentifier)
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier
is provided, SourceType
must also be provided.
If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
sourceIdentifier
- The identifier of the event source for which events are returned. If not specified, then all sources are
included in the response.
Constraints:
If SourceIdentifier
is provided, SourceType
must also be provided.
If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.
public void setSourceType(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 String getSourceType()
The event source to retrieve events for. If no value is specified, all events are returned.
SourceType
public DescribeEventsRequest withSourceType(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 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(Date startTime)
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
startTime
- The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
public Date getStartTime()
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
Example: 2009-07-08T18:00Z
public DescribeEventsRequest withStartTime(Date startTime)
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
startTime
- The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
public void setEndTime(Date endTime)
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
endTime
- The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
public Date getEndTime()
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
Example: 2009-07-08T18:00Z
public DescribeEventsRequest withEndTime(Date endTime)
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
endTime
- The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
public void setDuration(Integer duration)
The number of minutes to retrieve events for.
Default: 60
duration
- The number of minutes to retrieve events for.
Default: 60
public Integer getDuration()
The number of minutes to retrieve events for.
Default: 60
Default: 60
public DescribeEventsRequest withDuration(Integer duration)
The number of minutes to retrieve events for.
Default: 60
duration
- The number of minutes to retrieve events for.
Default: 60
public List<String> getEventCategories()
A list of event categories that trigger notifications for an event notification subscription.
public void setEventCategories(Collection<String> eventCategories)
A list of event categories that trigger notifications for an event notification subscription.
eventCategories
- A list of event categories that trigger notifications for an event notification subscription.public DescribeEventsRequest withEventCategories(String... eventCategories)
A list of event categories that trigger notifications for an 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 an event notification subscription.public DescribeEventsRequest withEventCategories(Collection<String> eventCategories)
A list of event categories that trigger notifications for an event notification subscription.
eventCategories
- A list of event categories that trigger notifications for an event notification subscription.public List<Filter> getFilters()
This parameter is not currently supported.
public void setFilters(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(Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.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 (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 (marker) is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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 (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 (marker) is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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 (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 (marker) is included in the response so that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
public void setMarker(String marker)
An optional pagination token provided by a previous 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 request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords
.public String getMarker()
An optional pagination token provided by a previous 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(String marker)
An optional pagination token provided by a previous 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 request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords
.public String toString()
toString
in class Object
Object.toString()
public DescribeEventsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()