/*******************************************************************************
* 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.Proton;
using Amazon.Proton.Model;
namespace Amazon.PowerShell.Cmdlets.PRO
{
/// <summary>
/// List components with summary data. You can filter the result list by environment,
/// service, or a single service instance.
///
///
/// <para>
/// For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton
/// components</a> in the <i>Proton User Guide</i>.
/// </para>
/// </summary>
[Cmdlet("Get", "PROComponentList")]
[OutputType("Amazon.Proton.Model.ComponentSummary")]
[AWSCmdlet("Calls the AWS Proton ListComponents API operation.", Operation = new[] {"ListComponents"}, SelectReturnType = typeof(Amazon.Proton.Model.ListComponentsResponse))]
[AWSCmdletOutput("Amazon.Proton.Model.ComponentSummary or Amazon.Proton.Model.ListComponentsResponse",
"This cmdlet returns a collection of Amazon.Proton.Model.ComponentSummary objects.",
"The service call response (type Amazon.Proton.Model.ListComponentsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetPROComponentListCmdlet : AmazonProtonClientCmdlet, IExecutor
{
protected override bool IsSensitiveResponse { get; set; } = true;
#region Parameter EnvironmentName
/// <summary>
/// <para>
/// <para>The name of an environment for result list filtering. Proton returns components associated
/// with the environment or attached to service instances running in it.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EnvironmentName { get; set; }
#endregion
#region Parameter ServiceInstanceName
/// <summary>
/// <para>
/// <para>The name of a service instance for result list filtering. Proton returns the component
/// attached to the service instance, if any.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ServiceInstanceName { get; set; }
#endregion
#region Parameter ServiceName
/// <summary>
/// <para>
/// <para>The name of a service for result list filtering. Proton returns components attached
/// to service instances of the service.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ServiceName { get; set; }
#endregion
#region Parameter MaxResult
/// <summary>
/// <para>
/// <para>The maximum number of components to list.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
/// <summary>
/// <para>
/// <para>A token that indicates the location of the next component in the array of components,
/// after the list of components that was previously requested.</para>
/// </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 'Components'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListComponentsResponse).
/// Specifying the name of a property of type Amazon.Proton.Model.ListComponentsResponse 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; } = "Components";
#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.Proton.Model.ListComponentsResponse, GetPROComponentListCmdlet>(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.EnvironmentName = this.EnvironmentName;
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.ServiceInstanceName = this.ServiceInstanceName;
context.ServiceName = this.ServiceName;
// 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.Proton.Model.ListComponentsRequest();
if (cmdletContext.EnvironmentName != null)
{
request.EnvironmentName = cmdletContext.EnvironmentName;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
if (cmdletContext.ServiceInstanceName != null)
{
request.ServiceInstanceName = cmdletContext.ServiceInstanceName;
}
if (cmdletContext.ServiceName != null)
{
request.ServiceName = cmdletContext.ServiceName;
}
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.Proton.Model.ListComponentsResponse CallAWSServiceOperation(IAmazonProton client, Amazon.Proton.Model.ListComponentsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Proton", "ListComponents");
try
{
#if DESKTOP
return client.ListComponents(request);
#elif CORECLR
return client.ListComponentsAsync(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 System.String EnvironmentName { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.String ServiceInstanceName { get; set; }
public System.String ServiceName { get; set; }
public System.Func<Amazon.Proton.Model.ListComponentsResponse, GetPROComponentListCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.Components;
}
}
}