/******************************************************************************* * 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.CleanRooms; using Amazon.CleanRooms.Model; namespace Amazon.PowerShell.Cmdlets.CRS { /// /// Retrieves a schema analysis rule. /// [Cmdlet("Get", "CRSSchemaAnalysisRule")] [OutputType("Amazon.CleanRooms.Model.AnalysisRule")] [AWSCmdlet("Calls the AWS Clean Rooms Service GetSchemaAnalysisRule API operation.", Operation = new[] {"GetSchemaAnalysisRule"}, SelectReturnType = typeof(Amazon.CleanRooms.Model.GetSchemaAnalysisRuleResponse))] [AWSCmdletOutput("Amazon.CleanRooms.Model.AnalysisRule or Amazon.CleanRooms.Model.GetSchemaAnalysisRuleResponse", "This cmdlet returns an Amazon.CleanRooms.Model.AnalysisRule object.", "The service call response (type Amazon.CleanRooms.Model.GetSchemaAnalysisRuleResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetCRSSchemaAnalysisRuleCmdlet : AmazonCleanRoomsClientCmdlet, IExecutor { #region Parameter CollaborationIdentifier /// /// /// A unique identifier for the collaboration that the schema belongs to. Currently accepts /// a collaboration ID. /// /// #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 CollaborationIdentifier { get; set; } #endregion #region Parameter Name /// /// /// The name of the schema to retrieve the analysis rule for. /// /// #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 Name { get; set; } #endregion #region Parameter Type /// /// /// The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely /// identified by a combination of the collaboration, the schema name, and their type. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.CleanRooms.AnalysisRuleType")] public Amazon.CleanRooms.AnalysisRuleType Type { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'AnalysisRule'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRooms.Model.GetSchemaAnalysisRuleResponse). /// Specifying the name of a property of type Amazon.CleanRooms.Model.GetSchemaAnalysisRuleResponse 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; } = "AnalysisRule"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the CollaborationIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^CollaborationIdentifier' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CollaborationIdentifier' 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.CollaborationIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CollaborationIdentifier = this.CollaborationIdentifier; #if MODULAR if (this.CollaborationIdentifier == null && ParameterWasBound(nameof(this.CollaborationIdentifier))) { WriteWarning("You are passing $null as a value for parameter CollaborationIdentifier 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.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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.Type = this.Type; #if MODULAR if (this.Type == null && ParameterWasBound(nameof(this.Type))) { WriteWarning("You are passing $null as a value for parameter Type 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; // create request var request = new Amazon.CleanRooms.Model.GetSchemaAnalysisRuleRequest(); if (cmdletContext.CollaborationIdentifier != null) { request.CollaborationIdentifier = cmdletContext.CollaborationIdentifier; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.Type != null) { request.Type = cmdletContext.Type; } 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.CleanRooms.Model.GetSchemaAnalysisRuleResponse CallAWSServiceOperation(IAmazonCleanRooms client, Amazon.CleanRooms.Model.GetSchemaAnalysisRuleRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Clean Rooms Service", "GetSchemaAnalysisRule"); try { #if DESKTOP return client.GetSchemaAnalysisRule(request); #elif CORECLR return client.GetSchemaAnalysisRuleAsync(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 CollaborationIdentifier { get; set; } public System.String Name { get; set; } public Amazon.CleanRooms.AnalysisRuleType Type { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.AnalysisRule; } } }