/*
* 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 elasticbeanstalk-2010-12-01.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.ElasticBeanstalk.Model
{
///
/// Container for the parameters to the DescribeEnvironments operation.
/// Returns descriptions for existing environments.
///
public partial class DescribeEnvironmentsRequest : AmazonElasticBeanstalkRequest
{
private string _applicationName;
private List _environmentIds = new List();
private List _environmentNames = new List();
private DateTime? _includedDeletedBackToUtc;
private bool? _includeDeleted;
private int? _maxRecords;
private string _nextToken;
private string _versionLabel;
///
/// Empty constructor used to set properties independently even when a simple constructor is available
///
public DescribeEnvironmentsRequest() { }
///
/// Gets and sets the property ApplicationName.
///
/// If specified, AWS Elastic Beanstalk restricts the returned descriptions to include
/// only those that are associated with this application.
///
///
[AWSProperty(Min=1, Max=100)]
public string ApplicationName
{
get { return this._applicationName; }
set { this._applicationName = value; }
}
// Check to see if ApplicationName property is set
internal bool IsSetApplicationName()
{
return this._applicationName != null;
}
///
/// Gets and sets the property EnvironmentIds.
///
/// If specified, AWS Elastic Beanstalk restricts the returned descriptions to include
/// only those that have the specified IDs.
///
///
public List EnvironmentIds
{
get { return this._environmentIds; }
set { this._environmentIds = value; }
}
// Check to see if EnvironmentIds property is set
internal bool IsSetEnvironmentIds()
{
return this._environmentIds != null && this._environmentIds.Count > 0;
}
///
/// Gets and sets the property EnvironmentNames.
///
/// If specified, AWS Elastic Beanstalk restricts the returned descriptions to include
/// only those that have the specified names.
///
///
public List EnvironmentNames
{
get { return this._environmentNames; }
set { this._environmentNames = value; }
}
// Check to see if EnvironmentNames property is set
internal bool IsSetEnvironmentNames()
{
return this._environmentNames != null && this._environmentNames.Count > 0;
}
///
/// Gets and sets the property IncludedDeletedBackToUtc.
///
/// If specified when IncludeDeleted
is set to true
, then environments
/// deleted after this date are displayed.
///
///
public DateTime IncludedDeletedBackToUtc
{
get { return this._includedDeletedBackToUtc.GetValueOrDefault(); }
set { this._includedDeletedBackTo = this._includedDeletedBackToUtc = value; }
}
// Check to see if IncludedDeletedBackToUtc property is set
internal bool IsSetIncludedDeletedBackToUtc()
{
return this._includedDeletedBackToUtc.HasValue;
}
///
/// Gets and sets the property IncludeDeleted.
///
/// Indicates whether to include deleted environments:
///
///
///
/// true
: Environments that have been deleted after IncludedDeletedBackTo
/// are displayed.
///
///
///
/// false
: Do not include deleted environments.
///
///
public bool IncludeDeleted
{
get { return this._includeDeleted.GetValueOrDefault(); }
set { this._includeDeleted = value; }
}
// Check to see if IncludeDeleted property is set
internal bool IsSetIncludeDeleted()
{
return this._includeDeleted.HasValue;
}
///
/// Gets and sets the property MaxRecords.
///
/// For a paginated request. Specify a maximum number of environments to include in each
/// response.
///
///
///
/// If no MaxRecords
is specified, all available environments are retrieved
/// in a single response.
///
///
[AWSProperty(Min=1, Max=1000)]
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 NextToken.
///
/// For a paginated request. Specify a token from a previous response page to retrieve
/// the next response page. All other parameter values must be identical to the ones specified
/// in the initial request.
///
///
///
/// If no NextToken
is specified, the first page is retrieved.
///
///
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 VersionLabel.
///
/// If specified, AWS Elastic Beanstalk restricts the returned descriptions to include
/// only those that are associated with this application version.
///
///
[AWSProperty(Min=1, Max=100)]
public string VersionLabel
{
get { return this._versionLabel; }
set { this._versionLabel = value; }
}
// Check to see if VersionLabel property is set
internal bool IsSetVersionLabel()
{
return this._versionLabel != null;
}
#region Backwards compatible properties
private DateTime? _includedDeletedBackTo;
///
/// Gets and sets the property IncludedDeletedBackToUtc.
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use IncludedDeletedBackToUtc instead. Setting either IncludedDeletedBackTo
/// or IncludedDeletedBackToUtc results in both IncludedDeletedBackTo and IncludedDeletedBackToUtc
/// being assigned, the latest assignment to either one of the two property is reflected
/// in the value of both. IncludedDeletedBackTo is provided for backwards compatibility
/// only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed
/// to the service.
///
///
///
/// If specified when IncludeDeleted
is set to true
, then environments
/// deleted after this date are displayed.
///
///
[Obsolete("Setting this property results in non-UTC DateTimes not being marshalled correctly. " +
"Use IncludedDeletedBackToUtc instead. Setting either IncludedDeletedBackTo or IncludedDeletedBackToUtc results in both IncludedDeletedBackTo and " +
"IncludedDeletedBackToUtc being assigned, the latest assignment to either one of the two property is " +
"reflected in the value of both. IncludedDeletedBackTo 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 IncludedDeletedBackTo
{
get { return this._includedDeletedBackTo.GetValueOrDefault(); }
set
{
this._includedDeletedBackTo = value;
this._includedDeletedBackToUtc = new DateTime(value.Ticks, DateTimeKind.Utc);
}
}
#endregion
}
}