com.amazonaws.services.rds.model
Class DescribeEventsRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.rds.model.DescribeEventsRequest

public class DescribeEventsRequest
extends AmazonWebServiceRequest

Container for the parameters to the DescribeEvents operation.

Returns events related to DB instances, DB security groups, DB Snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB Iinstance, DB security group, DB Snapshot, or DB parameter group can be obtained by providing the source identifier as a parameter. By default, the past hour of events are returned.

You can see a list of event categories and source types in the Events topic in the Amazon RDS User Guide.

See Also:

AmazonRDS.describeEvents(DescribeEventsRequest)

Constructor Summary

DescribeEventsRequest()
Default constructor for a new DescribeEventsRequest object.

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeEventsRequest

public DescribeEventsRequest()

Default constructor for a new DescribeEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getSourceIdentifier

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:

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

setSourceIdentifier

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:

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

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

withSourceIdentifier

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:

• 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 a reference to this object so that method calls can be chained together.

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

A reference to this updated object so that method calls can be chained together.

getSourceType

public java.lang.String getSourceType()

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot

Returns:

The event source to retrieve events for. If no value is specified, all events are returned.

See Also:

SourceType

setSourceType

public void setSourceType(java.lang.String sourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot

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(java.lang.String sourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot

Parameters:

sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

Returns:

A reference to this updated 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.

Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot

Parameters:

sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SourceType

getStartTime

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

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

setStartTime

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

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

withStartTime

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

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getEndTime

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

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

setEndTime

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

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

withEndTime

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

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getDuration

public java.lang.Integer getDuration()

The number of minutes to retrieve events for.

Default: 60

Returns:

The number of minutes to retrieve events for.

Default: 60

setDuration

public void setDuration(java.lang.Integer duration)

The number of minutes to retrieve events for.

Default: 60

Parameters:

duration - The number of minutes to retrieve events for.

Default: 60

withDuration

public DescribeEventsRequest withDuration(java.lang.Integer duration)

The number of minutes to retrieve events for.

Default: 60

Returns a reference to this object so that method calls can be chained together.

Parameters:

duration - The number of minutes to retrieve events for.

Default: 60

Returns:

A reference to this updated object so that method calls can be chained together.

getEventCategories

public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.String... eventCategories)

A list of event categories that trigger notifications for a event notification subscription.

Returns a reference to this object so that method calls can be chained together.

Parameters:

eventCategories - A list of event categories that trigger notifications for a event notification subscription.

Returns:

A reference to this updated object so that method calls can be chained together.

withEventCategories

public DescribeEventsRequest withEventCategories(java.util.Collection<java.lang.String> eventCategories)

A list of event categories that trigger notifications for a event notification subscription.

Returns a reference to this object so that method calls can be chained together.

Parameters:

eventCategories - A list of event categories that trigger notifications for a event notification subscription.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

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 may 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 may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

setMaxRecords

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 may 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 specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

withMaxRecords

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 may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

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.

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.

setMarker

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.

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

withMarker

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.

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object