/*******************************************************************************
* Copyright 2012-2019 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.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.Panorama;
using Amazon.Panorama.Model;
namespace Amazon.PowerShell.Cmdlets.PAN
{
/// <summary>
/// Returns a list of devices.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.
/// </summary>
[Cmdlet("Get", "PANDeviceList")]
[OutputType("Amazon.Panorama.Model.Device")]
[AWSCmdlet("Calls the AWS Panorama ListDevices API operation.", Operation = new[] {"ListDevices"}, SelectReturnType = typeof(Amazon.Panorama.Model.ListDevicesResponse))]
[AWSCmdletOutput("Amazon.Panorama.Model.Device or Amazon.Panorama.Model.ListDevicesResponse",
"This cmdlet returns a collection of Amazon.Panorama.Model.Device objects.",
"The service call response (type Amazon.Panorama.Model.ListDevicesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetPANDeviceListCmdlet : AmazonPanoramaClientCmdlet, IExecutor
{
#region Parameter DeviceAggregatedStatusFilter
/// <summary>
/// <para>
/// <para>Filter based on a device's status.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Panorama.DeviceAggregatedStatus")]
public Amazon.Panorama.DeviceAggregatedStatus DeviceAggregatedStatusFilter { get; set; }
#endregion
#region Parameter NameFilter
/// <summary>
/// <para>
/// <para>Filter based on device's name. Prefixes supported.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NameFilter { get; set; }
#endregion
#region Parameter SortBy
/// <summary>
/// <para>
/// <para>The target column to be sorted on. Default column sort is CREATED_TIME.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Panorama.ListDevicesSortBy")]
public Amazon.Panorama.ListDevicesSortBy SortBy { get; set; }
#endregion
#region Parameter SortOrder
/// <summary>
/// <para>
/// <para>The sorting order for the returned list. SortOrder is DESCENDING by default based
/// on CREATED_TIME. Otherwise, SortOrder is ASCENDING.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Panorama.SortOrder")]
public Amazon.Panorama.SortOrder SortOrder { get; set; }
#endregion
#region Parameter MaxResult
/// <summary>
/// <para>
/// <para>The maximum number of devices to return in one page of results.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
/// <summary>
/// <para>
/// <para>Specify the pagination token from a previous request to retrieve the next page of
/// results.</para>
/// </para>
/// <para>
/// <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
/// <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'Devices'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Panorama.Model.ListDevicesResponse).
/// Specifying the name of a property of type Amazon.Panorama.Model.ListDevicesResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "Devices";
#endregion
#region Parameter NoAutoIteration
/// <summary>
/// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple
/// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken
/// as the start point.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoAutoIteration { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate<Amazon.Panorama.Model.ListDevicesResponse, GetPANDeviceListCmdlet>(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.DeviceAggregatedStatusFilter = this.DeviceAggregatedStatusFilter;
context.MaxResult = this.MaxResult;
context.NameFilter = this.NameFilter;
context.NextToken = this.NextToken;
context.SortBy = this.SortBy;
context.SortOrder = this.SortOrder;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^");
// create request and set iteration invariants
var request = new Amazon.Panorama.Model.ListDevicesRequest();
if (cmdletContext.DeviceAggregatedStatusFilter != null)
{
request.DeviceAggregatedStatusFilter = cmdletContext.DeviceAggregatedStatusFilter;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NameFilter != null)
{
request.NameFilter = cmdletContext.NameFilter;
}
if (cmdletContext.SortBy != null)
{
request.SortBy = cmdletContext.SortBy;
}
if (cmdletContext.SortOrder != null)
{
request.SortOrder = cmdletContext.SortOrder;
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.NextToken;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
_nextToken = response.NextToken;
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return null;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Panorama.Model.ListDevicesResponse CallAWSServiceOperation(IAmazonPanorama client, Amazon.Panorama.Model.ListDevicesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Panorama", "ListDevices");
try
{
#if DESKTOP
return client.ListDevices(request);
#elif CORECLR
return client.ListDevicesAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public Amazon.Panorama.DeviceAggregatedStatus DeviceAggregatedStatusFilter { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NameFilter { get; set; }
public System.String NextToken { get; set; }
public Amazon.Panorama.ListDevicesSortBy SortBy { get; set; }
public Amazon.Panorama.SortOrder SortOrder { get; set; }
public System.Func<Amazon.Panorama.Model.ListDevicesResponse, GetPANDeviceListCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.Devices;
}
}
}