/******************************************************************************* * 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.Schemas; using Amazon.Schemas.Model; namespace Amazon.PowerShell.Cmdlets.SCHM { /// /// Provides a list of the schema versions and related information.

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. ///
[Cmdlet("Get", "SCHMSchemaVersionList")] [OutputType("Amazon.Schemas.Model.SchemaVersionSummary")] [AWSCmdlet("Calls the Amazon EventBridge Schema Registry ListSchemaVersions API operation.", Operation = new[] {"ListSchemaVersions"}, SelectReturnType = typeof(Amazon.Schemas.Model.ListSchemaVersionsResponse))] [AWSCmdletOutput("Amazon.Schemas.Model.SchemaVersionSummary or Amazon.Schemas.Model.ListSchemaVersionsResponse", "This cmdlet returns a collection of Amazon.Schemas.Model.SchemaVersionSummary objects.", "The service call response (type Amazon.Schemas.Model.ListSchemaVersionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetSCHMSchemaVersionListCmdlet : AmazonSchemasClientCmdlet, IExecutor { #region Parameter RegistryName /// /// /// The name of the registry. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String RegistryName { get; set; } #endregion #region Parameter SchemaName /// /// /// The name of the schema. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String SchemaName { get; set; } #endregion #region Parameter Limit /// /// /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Limit { get; set; } #endregion #region Parameter NextToken /// /// /// The token that specifies the next page of results to return. To request the first /// page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared /// with other accounts. /// /// ///
Note: This parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'SchemaVersions'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Schemas.Model.ListSchemaVersionsResponse). /// Specifying the name of a property of type Amazon.Schemas.Model.ListSchemaVersionsResponse 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; } = "SchemaVersions"; #endregion #region Parameter NoAutoIteration /// /// 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. /// [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(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.Limit = this.Limit; context.NextToken = this.NextToken; context.RegistryName = this.RegistryName; #if MODULAR if (this.RegistryName == null && ParameterWasBound(nameof(this.RegistryName))) { WriteWarning("You are passing $null as a value for parameter RegistryName 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.SchemaName = this.SchemaName; #if MODULAR if (this.SchemaName == null && ParameterWasBound(nameof(this.SchemaName))) { WriteWarning("You are passing $null as a value for parameter SchemaName 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 // 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.Schemas.Model.ListSchemaVersionsRequest(); if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.Value; } if (cmdletContext.RegistryName != null) { request.RegistryName = cmdletContext.RegistryName; } if (cmdletContext.SchemaName != null) { request.SchemaName = cmdletContext.SchemaName; } // 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.Schemas.Model.ListSchemaVersionsResponse CallAWSServiceOperation(IAmazonSchemas client, Amazon.Schemas.Model.ListSchemaVersionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EventBridge Schema Registry", "ListSchemaVersions"); try { #if DESKTOP return client.ListSchemaVersions(request); #elif CORECLR return client.ListSchemaVersionsAsync(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.Int32? Limit { get; set; } public System.String NextToken { get; set; } public System.String RegistryName { get; set; } public System.String SchemaName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.SchemaVersions; } } }