Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.rds.model;
 
 
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.

 
 public class DescribeEventsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
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.
 
     private String sourceIdentifier;

    
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

 
     private String sourceType;

    
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

 
     private java.util.Date startTime;

    
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

 
     private java.util.Date endTime;

    
The number of minutes to retrieve events for.

Default: 60

 
     private Integer duration;

    
A list of event categories that trigger notifications for a event notification subscription.
 
This parameter is not currently supported.
 
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

 
    private Integer maxRecords;

    
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.
    private String marker;

    
Default constructor for a new DescribeEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
    public DescribeEventsRequest() {}
    
    
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.
    public String getSourceIdentifier() {
        return ;
    }
    
    
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.
    public void setSourceIdentifier(String sourceIdentifier) {
        this. = 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.
    public DescribeEventsRequest withSourceIdentifier(String sourceIdentifier) {
        this. = sourceIdentifier;
        return this;
    }

    
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
    public String getSourceType() {
        return ;
    }
    
    
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
    public void setSourceType(String sourceType) {
        this. = 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
    public DescribeEventsRequest withSourceType(String sourceType) {
        this. = sourceType;
        return this;
    }

    
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
    public void setSourceType(SourceType sourceType) {
        this. = sourceType.toString();
    }
    
    
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
    public DescribeEventsRequest withSourceType(SourceType sourceType) {
        this. = sourceType.toString();
        return this;
    }

    
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

    public java.util.Date getStartTime() {
        return ;
    }
    
    
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

    public void setStartTime(java.util.Date startTime) {
        this. = 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.
    public DescribeEventsRequest withStartTime(java.util.Date startTime) {
        this. = startTime;
        return this;
    }

    
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

    public java.util.Date getEndTime() {
        return ;
    }
    
    
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

    public void setEndTime(java.util.Date endTime) {
        this. = 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.
    public DescribeEventsRequest withEndTime(java.util.Date endTime) {
        this. = endTime;
        return this;
    }

    
The number of minutes to retrieve events for.

Default: 60

Returns:
The number of minutes to retrieve events for.

Default: 60

    public Integer getDuration() {
        return ;
    }
    
    
The number of minutes to retrieve events for.

Default: 60

Parameters:
duration The number of minutes to retrieve events for.

Default: 60

    public void setDuration(Integer duration) {
        this. = 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.
    public DescribeEventsRequest withDuration(Integer duration) {
        this. = duration;
        return this;
    }

    
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.
    public java.util.List<StringgetEventCategories() {
        if ( == null) {
               = new com.amazonaws.internal.ListWithAutoConstructFlag<String>();
              .setAutoConstruct(true);
        }
        return ;
    }
    
    
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.
    public void setEventCategories(java.util.Collection<StringeventCategories) {
        if (eventCategories == null) {
            this. = null;
            return;
        }
        com.amazonaws.internal.ListWithAutoConstructFlag<StringeventCategoriesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<String>(eventCategories.size());
        eventCategoriesCopy.addAll(eventCategories);
        this. = eventCategoriesCopy;
    }
    
    
A list of event categories that trigger notifications for a 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.

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.
    public DescribeEventsRequest withEventCategories(String... eventCategories) {
        if (getEventCategories() == nullsetEventCategories(new java.util.ArrayList<String>(eventCategories.length));
        for (String value : eventCategories) {
            getEventCategories().add(value);
        }
        return this;
    }
    
    
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.
        if (eventCategories == null) {
            this. = null;
        } else {
            com.amazonaws.internal.ListWithAutoConstructFlag<StringeventCategoriesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag<String>(eventCategories.size());
            eventCategoriesCopy.addAll(eventCategories);
            this. = eventCategoriesCopy;
        }
        return this;
    }

    
This parameter is not currently supported.

Returns:
This parameter is not currently supported.
    public java.util.List<FiltergetFilters() {
        if ( == null) {
               = new com.amazonaws.internal.ListWithAutoConstructFlag<Filter>();
              .setAutoConstruct(true);
        }
        return ;
    }
    
    
This parameter is not currently supported.

Parameters:
filters This parameter is not currently supported.
    public void setFilters(java.util.Collection<Filterfilters) {
        if (filters == null) {
            this. = null;
            return;
        }
        filtersCopy.addAll(filters);
        this. = filtersCopy;
    }
    
    
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.

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

Parameters:
filters This parameter is not currently supported.
Returns:
A reference to this updated object so that method calls can be chained together.
    public DescribeEventsRequest withFilters(Filter... filters) {
        if (getFilters() == nullsetFilters(new java.util.ArrayList<Filter>(filters.length));
        for (Filter value : filters) {
            getFilters().add(value);
        }
        return this;
    }
    
    
This parameter is not currently supported.

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

Parameters:
filters This parameter is not currently supported.
Returns:
A reference to this updated object so that method calls can be chained together.
        if (filters == null) {
            this. = null;
        } else {
            filtersCopy.addAll(filters);
            this. = filtersCopy;
        }
        return this;
    }

    
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

    public Integer getMaxRecords() {
        return ;
    }
    
    
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

    public void setMaxRecords(Integer maxRecords) {
        this. = 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.
    public DescribeEventsRequest withMaxRecords(Integer maxRecords) {
        this. = maxRecords;
        return this;
    }

    
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.
    public String getMarker() {
        return ;
    }
    
    
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.
    public void setMarker(String marker) {
        this. = 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.
    public DescribeEventsRequest withMarker(String marker) {
        this. = marker;
        return this;
    }

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

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getSourceIdentifier() != nullsb.append("SourceIdentifier: " + getSourceIdentifier() + ",");
        if (getSourceType() != nullsb.append("SourceType: " + getSourceType() + ",");
        if (getStartTime() != nullsb.append("StartTime: " + getStartTime() + ",");
        if (getEndTime() != nullsb.append("EndTime: " + getEndTime() + ",");
        if (getDuration() != nullsb.append("Duration: " + getDuration() + ",");
        if (getEventCategories() != nullsb.append("EventCategories: " + getEventCategories() + ",");
        if (getFilters() != nullsb.append("Filters: " + getFilters() + ",");
        if (getMaxRecords() != nullsb.append("MaxRecords: " + getMaxRecords() + ",");
        if (getMarker() != nullsb.append("Marker: " + getMarker() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getSourceIdentifier() == null) ? 0 : getSourceIdentifier().hashCode()); 
        hashCode = prime * hashCode + ((getSourceType() == null) ? 0 : getSourceType().hashCode()); 
        hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode()); 
        hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); 
        hashCode = prime * hashCode + ((getDuration() == null) ? 0 : getDuration().hashCode()); 
        hashCode = prime * hashCode + ((getEventCategories() == null) ? 0 : getEventCategories().hashCode()); 
        hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); 
        hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode()); 
        hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof DescribeEventsRequest == falsereturn false;
        DescribeEventsRequest other = (DescribeEventsRequest)obj;
        
        if (other.getSourceIdentifier() == null ^ this.getSourceIdentifier() == nullreturn false;
        if (other.getSourceIdentifier() != null && other.getSourceIdentifier().equals(this.getSourceIdentifier()) == falsereturn false
        if (other.getSourceType() == null ^ this.getSourceType() == nullreturn false;
        if (other.getSourceType() != null && other.getSourceType().equals(this.getSourceType()) == falsereturn false
        if (other.getStartTime() == null ^ this.getStartTime() == nullreturn false;
        if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == falsereturn false
        if (other.getEndTime() == null ^ this.getEndTime() == nullreturn false;
        if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == falsereturn false
        if (other.getDuration() == null ^ this.getDuration() == nullreturn false;
        if (other.getDuration() != null && other.getDuration().equals(this.getDuration()) == falsereturn false
        if (other.getEventCategories() == null ^ this.getEventCategories() == nullreturn false;
        if (other.getEventCategories() != null && other.getEventCategories().equals(this.getEventCategories()) == falsereturn false
        if (other.getFilters() == null ^ this.getFilters() == nullreturn false;
        if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == falsereturn false
        if (other.getMaxRecords() == null ^ this.getMaxRecords() == nullreturn false;
        if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == falsereturn false
        if (other.getMarker() == null ^ this.getMarker() == nullreturn false;
        if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == falsereturn false
        return true;
    }
    
    @Override
    public DescribeEventsRequest clone() {
        
            return (DescribeEventsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X