Package software.amazon.awssdk.services.rds.model

Class DescribeEventsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.DescribeEventsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeEventsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEventsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeEventsRequest.Builder	builder()
Integer	duration()	The number of minutes to retrieve events for.
Date	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.
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 will be returned.
String	sourceType()	The event source to retrieve events for.
Date	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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

sourceIdentifier

public 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 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.

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 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.

sourceType

public String sourceType()

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

startTime

public 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

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

endTime

public 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

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

duration

public Integer duration()

The number of minutes to retrieve events for.

Default: 60

Returns:

The number of minutes to retrieve events for.

Default: 60

eventCategories

public List<String> eventCategories()

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.

filters

public List<Filter> filters()

This parameter is not currently supported.

Returns:

This parameter is not currently supported.

maxRecords

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.

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.

marker

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.

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.

toBuilder

public DescribeEventsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Returns:

a builder for type T

builder

public static DescribeEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeEventsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object