/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the neptune-2014-10-31.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Neptune.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 partial class DescribeEventsRequest : AmazonNeptuneRequest
{
private int? _duration;
private DateTime? _endTimeUtc;
private List _eventCategories = new List();
private List _filters = new List();
private string _marker;
private int? _maxRecords;
private string _sourceIdentifier;
private SourceType _sourceType;
private DateTime? _startTimeUtc;
///
/// Gets and sets the property Duration.
///
/// The number of minutes to retrieve events for.
///
///
///
/// Default: 60
///
///
public int Duration
{
get { return this._duration.GetValueOrDefault(); }
set { this._duration = value; }
}
// Check to see if Duration property is set
internal bool IsSetDuration()
{
return this._duration.HasValue;
}
///
/// Gets and sets the property EndTimeUtc.
///
/// 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 DateTime EndTimeUtc
{
get { return this._endTimeUtc.GetValueOrDefault(); }
set { this._endTime = this._endTimeUtc = value; }
}
// Check to see if EndTimeUtc property is set
internal bool IsSetEndTimeUtc()
{
return this._endTimeUtc.HasValue;
}
///
/// Gets and sets the property EventCategories.
///
/// A list of event categories that trigger notifications for a event notification subscription.
///
///
public List EventCategories
{
get { return this._eventCategories; }
set { this._eventCategories = value; }
}
// Check to see if EventCategories property is set
internal bool IsSetEventCategories()
{
return this._eventCategories != null && this._eventCategories.Count > 0;
}
///
/// Gets and sets the property Filters.
///
/// This parameter is not currently supported.
///
///
public List Filters
{
get { return this._filters; }
set { this._filters = value; }
}
// Check to see if Filters property is set
internal bool IsSetFilters()
{
return this._filters != null && this._filters.Count > 0;
}
///
/// Gets and sets the property 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 string Marker
{
get { return this._marker; }
set { this._marker = value; }
}
// Check to see if Marker property is set
internal bool IsSetMarker()
{
return this._marker != null;
}
///
/// Gets and sets the property 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.
///
///
public int MaxRecords
{
get { return this._maxRecords.GetValueOrDefault(); }
set { this._maxRecords = value; }
}
// Check to see if MaxRecords property is set
internal bool IsSetMaxRecords()
{
return this._maxRecords.HasValue;
}
///
/// Gets and sets the property 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.
///
///
///
public string SourceIdentifier
{
get { return this._sourceIdentifier; }
set { this._sourceIdentifier = value; }
}
// Check to see if SourceIdentifier property is set
internal bool IsSetSourceIdentifier()
{
return this._sourceIdentifier != null;
}
///
/// Gets and sets the property SourceType.
///
/// The event source to retrieve events for. If no value is specified, all events are
/// returned.
///
///
public SourceType SourceType
{
get { return this._sourceType; }
set { this._sourceType = value; }
}
// Check to see if SourceType property is set
internal bool IsSetSourceType()
{
return this._sourceType != null;
}
///
/// Gets and sets the property StartTimeUtc.
///
/// 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 DateTime StartTimeUtc
{
get { return this._startTimeUtc.GetValueOrDefault(); }
set { this._startTime = this._startTimeUtc = value; }
}
// Check to see if StartTimeUtc property is set
internal bool IsSetStartTimeUtc()
{
return this._startTimeUtc.HasValue;
}
#region Backwards compatible properties
private DateTime? _endTime;
private DateTime? _startTime;
///
/// Gets and sets the property EndTimeUtc.
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc
/// results in both EndTime and EndTimeUtc being assigned, the latest assignment to either
/// one of the two property is reflected in the value of both. EndTime is provided for
/// backwards compatibility only and assigning a non-Utc DateTime to it results in the
/// wrong timestamp being passed to the service.
///
///
///
/// 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
///
///
[Obsolete("Setting this property results in non-UTC DateTimes not being marshalled correctly. " +
"Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc results in both EndTime and " +
"EndTimeUtc being assigned, the latest assignment to either one of the two property is " +
"reflected in the value of both. EndTime is provided for backwards compatibility only and " +
"assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.", false)]
public DateTime EndTime
{
get { return this._endTime.GetValueOrDefault(); }
set
{
this._endTime = value;
this._endTimeUtc = new DateTime(value.Ticks, DateTimeKind.Utc);
}
}
///
/// Gets and sets the property StartTimeUtc.
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or
/// StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest
/// assignment to either one of the two property is reflected in the value of both. StartTime
/// is provided for backwards compatibility only and assigning a non-Utc DateTime to it
/// results in the wrong timestamp being passed to the service.
///
///
///
/// 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
///
///
[Obsolete("Setting this property results in non-UTC DateTimes not being marshalled correctly. " +
"Use StartTimeUtc instead. Setting either StartTime or StartTimeUtc results in both StartTime and " +
"StartTimeUtc being assigned, the latest assignment to either one of the two property is " +
"reflected in the value of both. StartTime is provided for backwards compatibility only and " +
"assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.", false)]
public DateTime StartTime
{
get { return this._startTime.GetValueOrDefault(); }
set
{
this._startTime = value;
this._startTimeUtc = new DateTime(value.Ticks, DateTimeKind.Utc);
}
}
#endregion
}
}