Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.rds.model
Class DescribeEventsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by 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 Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

See Also:
AmazonRDS.describeEvents(DescribeEventsRequest)

Constructor Summary
DescribeEventsRequest()
          Default constructor for a new DescribeEventsRequest object.
 
Method Summary
 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.
 String getMarker()
          An optional marker provided in the 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 setMarker(String marker)
          An optional marker provided in the 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 withMarker(String marker)
          An optional marker provided in the 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
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 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:

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

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

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

getMaxRecords

public Integer getMaxRecords()
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 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(Integer maxRecords)
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 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(Integer maxRecords)
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 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 String getMarker()
An optional marker provided in the 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 marker provided in the 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(String marker)
An optional marker provided in the 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 marker provided in the 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 marker provided in the 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 marker provided in the 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 String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.