@Generated(value="software.amazon.awssdk:codegen") public final class DescribeEventsRequest extends RdsRequest implements ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeEventsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeEventsRequest.Builder |
builder() |
Integer |
duration()
The number of minutes to retrieve events for.
|
Instant |
endTime()
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
|
boolean |
equals(Object obj) |
List<String> |
eventCategories()
A list of event categories that trigger notifications for a event notification subscription.
|
List<Filter> |
filters()
This parameter is not currently supported.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
marker()
An optional pagination token provided by a previous DescribeEvents request.
|
Integer |
maxRecords()
The maximum number of records to include in the response.
|
static Class<? extends DescribeEventsRequest.Builder> |
serializableBuilderClass() |
String |
sourceIdentifier()
The identifier of the event source for which events are returned.
|
SourceType |
sourceType()
The event source to retrieve events for.
|
String |
sourceTypeAsString()
The event source to retrieve events for.
|
Instant |
startTime()
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
|
DescribeEventsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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 supplied, SourceType must also be provided.
If the source type is DBInstance
, then a DBInstanceIdentifier
must be supplied.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be supplied.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be supplied.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be supplied.
Cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is DBInstance
, then a DBInstanceIdentifier
must be supplied.
If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be supplied.
If the source type is DBParameterGroup
, a DBParameterGroupName
must be
supplied.
If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be supplied.
Cannot end with a hyphen or contain two consecutive hyphens.
public SourceType sourceType()
The event source to retrieve events for. If no value is specified, all events are returned.
If the service returns an enum value that is not available in the current SDK version, sourceType
will
return SourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
sourceTypeAsString()
.
SourceType
public String sourceTypeAsString()
The event source to retrieve events for. If no value is specified, all events are returned.
If the service returns an enum value that is not available in the current SDK version, sourceType
will
return SourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
sourceTypeAsString()
.
SourceType
public Instant 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
Example: 2009-07-08T18:00Z
public Instant 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
Example: 2009-07-08T18:00Z
public Integer duration()
The number of minutes to retrieve events for.
Default: 60
Default: 60
public List<String> eventCategories()
A list of event categories that trigger notifications for a event notification subscription.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<Filter> filters()
This parameter is not currently supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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
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 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
.
MaxRecords
.public DescribeEventsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>
toBuilder
in class RdsRequest
public static DescribeEventsRequest.Builder builder()
public static Class<? extends DescribeEventsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.