/*
* 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 DescribeLogStreams operation.
/// Lists the log streams for the specified log group. You can list all the log streams
/// or filter the results by prefix. You can also control how the results are ordered.
///
///
///
/// 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.
///
///
///
/// This operation has a limit of five transactions per second, after which transactions
/// are throttled.
///
///
///
/// 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.
///
///
public partial class DescribeLogStreamsRequest : AmazonCloudWatchLogsRequest
{
private bool? _descending;
private int? _limit;
private string _logGroupIdentifier;
private string _logGroupName;
private string _logStreamNamePrefix;
private string _nextToken;
private OrderBy _orderBy;
///
/// Empty constructor used to set properties independently even when a simple constructor is available
///
public DescribeLogStreamsRequest() { }
///
/// Instantiates DescribeLogStreamsRequest with the parameterized properties
///
/// The name of the log group. You must include either logGroupIdentifier
or logGroupName
, but not both.
public DescribeLogStreamsRequest(string logGroupName)
{
_logGroupName = logGroupName;
}
///
/// Gets and sets the property Descending.
///
/// If the value is true, results are returned in descending order. If the value is to
/// false, results are returned in ascending order. The default value is false.
///
///
public bool Descending
{
get { return this._descending.GetValueOrDefault(); }
set { this._descending = value; }
}
// Check to see if Descending property is set
internal bool IsSetDescending()
{
return this._descending.HasValue;
}
///
/// Gets and sets the property Limit.
///
/// The maximum number of items returned. If you don't specify a value, the default is
/// up to 50 items.
///
///
[AWSProperty(Min=1, Max=50)]
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. 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 LogStreamNamePrefix.
///
/// The prefix to match.
///
///
///
/// If orderBy
is LastEventTime
, you cannot specify this parameter.
///
///
[AWSProperty(Min=1, Max=512)]
public string LogStreamNamePrefix
{
get { return this._logStreamNamePrefix; }
set { this._logStreamNamePrefix = value; }
}
// Check to see if LogStreamNamePrefix property is set
internal bool IsSetLogStreamNamePrefix()
{
return this._logStreamNamePrefix != 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 OrderBy.
///
/// If the value is LogStreamName
, the results are ordered by log stream
/// name. If the value is LastEventTime
, the results are ordered by the event
/// time. The default value is LogStreamName
.
///
///
///
/// If you order the results by event time, you cannot specify the logStreamNamePrefix
/// parameter.
///
///
///
/// lastEventTimestamp
represents the time of the most recent log event
/// in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds
/// after Jan 1, 1970 00:00:00 UTC
. lastEventTimestamp
updates
/// on an eventual consistency basis. It typically updates in less than an hour from ingestion,
/// but in rare situations might take longer.
///
///
public OrderBy OrderBy
{
get { return this._orderBy; }
set { this._orderBy = value; }
}
// Check to see if OrderBy property is set
internal bool IsSetOrderBy()
{
return this._orderBy != null;
}
}
}