/*******************************************************************************
* 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.Private5G;
using Amazon.Private5G.Model;
namespace Amazon.PowerShell.Cmdlets.PV5G
{
///
/// Lists network sites. Add filters to your request to return a more specific list of
/// results. Use filters to match the status of the network site.
///
[Cmdlet("Get", "PV5GNetworkSiteList")]
[OutputType("Amazon.Private5G.Model.NetworkSite")]
[AWSCmdlet("Calls the AWS Private 5G ListNetworkSites API operation.", Operation = new[] {"ListNetworkSites"}, SelectReturnType = typeof(Amazon.Private5G.Model.ListNetworkSitesResponse))]
[AWSCmdletOutput("Amazon.Private5G.Model.NetworkSite or Amazon.Private5G.Model.ListNetworkSitesResponse",
"This cmdlet returns a collection of Amazon.Private5G.Model.NetworkSite objects.",
"The service call response (type Amazon.Private5G.Model.ListNetworkSitesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetPV5GNetworkSiteListCmdlet : AmazonPrivate5GClientCmdlet, IExecutor
{
#region Parameter Filter
///
///
/// The filters. Add filters to your request to return a more specific list of results.
/// Use filters to match the status of the network sites.STATUS
- The status (AVAILABLE
| CREATED
|
/// DELETED
| DEPROVISIONING
| PROVISIONING
).
Filter values are case sensitive. If you specify multiple values for a filter, the
/// values are joined with an OR
, and the request returns all results that
/// match any of the specified values.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public System.Collections.Hashtable Filter { get; set; }
#endregion
#region Parameter NetworkArn
///
///
/// The Amazon Resource Name (ARN) of the network.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String NetworkArn { get; set; }
#endregion
#region Parameter StartToken
///
///
/// The token for the next page of results.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String StartToken { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of results to return.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'NetworkSites'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Private5G.Model.ListNetworkSitesResponse).
/// Specifying the name of a property of type Amazon.Private5G.Model.ListNetworkSitesResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "NetworkSites";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the NetworkArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^NetworkArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^NetworkArn' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { 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);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.NetworkArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.Filter != null)
{
context.Filter = new Dictionary>(StringComparer.Ordinal);
foreach (var hashKey in this.Filter.Keys)
{
object hashValue = this.Filter[hashKey];
if (hashValue == null)
{
context.Filter.Add((String)hashKey, null);
continue;
}
var enumerable = SafeEnumerable(hashValue);
var valueSet = new List();
foreach (var s in enumerable)
{
valueSet.Add((System.String)s);
}
context.Filter.Add((String)hashKey, valueSet);
}
}
context.MaxResult = this.MaxResult;
context.NetworkArn = this.NetworkArn;
#if MODULAR
if (this.NetworkArn == null && ParameterWasBound(nameof(this.NetworkArn)))
{
WriteWarning("You are passing $null as a value for parameter NetworkArn which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.StartToken = this.StartToken;
// 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;
// create request
var request = new Amazon.Private5G.Model.ListNetworkSitesRequest();
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NetworkArn != null)
{
request.NetworkArn = cmdletContext.NetworkArn;
}
if (cmdletContext.StartToken != null)
{
request.StartToken = cmdletContext.StartToken;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Private5G.Model.ListNetworkSitesResponse CallAWSServiceOperation(IAmazonPrivate5G client, Amazon.Private5G.Model.ListNetworkSitesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Private 5G", "ListNetworkSites");
try
{
#if DESKTOP
return client.ListNetworkSites(request);
#elif CORECLR
return client.ListNetworkSitesAsync(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 Dictionary> Filter { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NetworkArn { get; set; }
public System.String StartToken { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.NetworkSites;
}
}
}