/* * 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 logs-2014-03-28.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.CloudWatchLogs.Model { /// /// Container for the parameters to the GetLogEvents operation. /// Lists log events from the specified log stream. You can list all of the log events /// or filter using a time range. /// /// /// /// By default, this operation returns as many log events as can fit in a response size /// of 1MB (up to 10,000 log events). You can get additional log events by specifying /// one of the tokens in a subsequent call. This operation can return empty results while /// there are more log events available through the token. /// /// /// /// If you are using CloudWatch cross-account observability, you can use this operation /// in a monitoring account and view data from the linked source accounts. For more information, /// see CloudWatch /// cross-account observability. /// /// /// /// You can specify the log group to search by using either logGroupIdentifier /// or logGroupName. You must include one of these two parameters, but you /// can't include both. /// /// public partial class GetLogEventsRequest : AmazonCloudWatchLogsRequest { private DateTime? _endTime; private int? _limit; private string _logGroupIdentifier; private string _logGroupName; private string _logStreamName; private string _nextToken; private bool? _startFromHead; private DateTime? _startTime; private bool? _unmask; /// /// Empty constructor used to set properties independently even when a simple constructor is available /// public GetLogEventsRequest() { } /// /// Instantiates GetLogEventsRequest with the parameterized properties /// /// The name of the log group. You must include either logGroupIdentifier or logGroupName, but not both. /// The name of the log stream. public GetLogEventsRequest(string logGroupName, string logStreamName) { _logGroupName = logGroupName; _logStreamName = logStreamName; } /// /// Gets and sets the property EndTime. /// /// The end of the time range, expressed as the number of milliseconds after Jan /// 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time /// are not included. /// /// [AWSProperty(Min=0)] public DateTime EndTime { get { return this._endTime.GetValueOrDefault(); } set { this._endTime = value; } } // Check to see if EndTime property is set internal bool IsSetEndTime() { return this._endTime.HasValue; } /// /// Gets and sets the property Limit. /// /// The maximum number of log events returned. If you don't specify a limit, the default /// is as many log events as can fit in a response size of 1 MB (up to 10,000 log events). /// /// [AWSProperty(Min=1, Max=10000)] public int Limit { get { return this._limit.GetValueOrDefault(); } set { this._limit = value; } } // Check to see if Limit property is set internal bool IsSetLimit() { return this._limit.HasValue; } /// /// Gets and sets the property LogGroupIdentifier. /// /// Specify either the name or ARN of the log group to view events from. If the log group /// is in a source account and you are using a monitoring account, you must use the log /// group ARN. /// /// /// /// You must include either logGroupIdentifier or logGroupName, /// but not both. /// /// /// [AWSProperty(Min=1, Max=2048)] public string LogGroupIdentifier { get { return this._logGroupIdentifier; } set { this._logGroupIdentifier = value; } } // Check to see if LogGroupIdentifier property is set internal bool IsSetLogGroupIdentifier() { return this._logGroupIdentifier != null; } /// /// Gets and sets the property LogGroupName. /// /// The name of the log group. /// /// /// /// You must include either logGroupIdentifier or logGroupName, /// but not both. /// /// /// [AWSProperty(Min=1, Max=512)] public string LogGroupName { get { return this._logGroupName; } set { this._logGroupName = value; } } // Check to see if LogGroupName property is set internal bool IsSetLogGroupName() { return this._logGroupName != null; } /// /// Gets and sets the property LogStreamName. /// /// The name of the log stream. /// /// [AWSProperty(Required=true, Min=1, Max=512)] public string LogStreamName { get { return this._logStreamName; } set { this._logStreamName = value; } } // Check to see if LogStreamName property is set internal bool IsSetLogStreamName() { return this._logStreamName != null; } /// /// Gets and sets the property NextToken. /// /// The token for the next set of items to return. (You received this token from a previous /// call.) /// /// [AWSProperty(Min=1)] public string NextToken { get { return this._nextToken; } set { this._nextToken = value; } } // Check to see if NextToken property is set internal bool IsSetNextToken() { return this._nextToken != null; } /// /// Gets and sets the property StartFromHead. /// /// If the value is true, the earliest log events are returned first. If the value is /// false, the latest log events are returned first. The default value is false. /// /// /// /// If you are using a previous nextForwardToken value as the nextToken /// in this operation, you must specify true for startFromHead. /// /// public bool StartFromHead { get { return this._startFromHead.GetValueOrDefault(); } set { this._startFromHead = value; } } // Check to see if StartFromHead property is set internal bool IsSetStartFromHead() { return this._startFromHead.HasValue; } /// /// Gets and sets the property StartTime. /// /// The start of the time range, expressed as the number of milliseconds after Jan /// 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than /// this time are included. Events with a timestamp earlier than this time are not included. /// /// [AWSProperty(Min=0)] public DateTime StartTime { get { return this._startTime.GetValueOrDefault(); } set { this._startTime = value; } } // Check to see if StartTime property is set internal bool IsSetStartTime() { return this._startTime.HasValue; } /// /// Gets and sets the property Unmask. /// /// Specify true to display the log event fields with all sensitive data /// unmasked and visible. The default is false. /// /// /// /// To use this operation with this parameter, you must be signed into an account with /// the logs:Unmask permission. /// /// public bool Unmask { get { return this._unmask.GetValueOrDefault(); } set { this._unmask = value; } } // Check to see if Unmask property is set internal bool IsSetUnmask() { return this._unmask.HasValue; } } }