/******************************************************************************* * 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.LakeFormation; using Amazon.LakeFormation.Model; namespace Amazon.PowerShell.Cmdlets.LKF { /// /// Returns the work units resulting from the query. Work units can be executed in any /// order and in parallel. /// [Cmdlet("Get", "LKFWorkUnitResult")] [OutputType("System.IO.Stream")] [AWSCmdlet("Calls the AWS Lake Formation GetWorkUnitResults API operation.", Operation = new[] {"GetWorkUnitResults"}, SelectReturnType = typeof(Amazon.LakeFormation.Model.GetWorkUnitResultsResponse))] [AWSCmdletOutput("System.IO.Stream or Amazon.LakeFormation.Model.GetWorkUnitResultsResponse", "This cmdlet returns a System.IO.Stream object.", "The service call response (type Amazon.LakeFormation.Model.GetWorkUnitResultsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetLKFWorkUnitResultCmdlet : AmazonLakeFormationClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter QueryId /// /// /// The ID of the plan query operation for which to get results. /// /// #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 QueryId { get; set; } #endregion #region Parameter WorkUnitId /// /// /// The work unit ID for which to get results. Value generated by enumerating WorkUnitIdMin /// to WorkUnitIdMax (inclusive) from the WorkUnitRange in the /// output of GetWorkUnits. /// /// #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] public System.Int64? WorkUnitId { get; set; } #endregion #region Parameter WorkUnitToken /// /// /// A work token used to query the execution service. Token output from GetWorkUnits. /// /// #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 WorkUnitToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ResultStream'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LakeFormation.Model.GetWorkUnitResultsResponse). /// Specifying the name of a property of type Amazon.LakeFormation.Model.GetWorkUnitResultsResponse 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; } = "ResultStream"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the QueryId parameter. /// The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^QueryId' 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.QueryId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.QueryId = this.QueryId; #if MODULAR if (this.QueryId == null && ParameterWasBound(nameof(this.QueryId))) { WriteWarning("You are passing $null as a value for parameter QueryId 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.WorkUnitId = this.WorkUnitId; #if MODULAR if (this.WorkUnitId == null && ParameterWasBound(nameof(this.WorkUnitId))) { WriteWarning("You are passing $null as a value for parameter WorkUnitId 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.WorkUnitToken = this.WorkUnitToken; #if MODULAR if (this.WorkUnitToken == null && ParameterWasBound(nameof(this.WorkUnitToken))) { WriteWarning("You are passing $null as a value for parameter WorkUnitToken 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.LakeFormation.Model.GetWorkUnitResultsRequest(); if (cmdletContext.QueryId != null) { request.QueryId = cmdletContext.QueryId; } if (cmdletContext.WorkUnitId != null) { request.WorkUnitId = cmdletContext.WorkUnitId.Value; } if (cmdletContext.WorkUnitToken != null) { request.WorkUnitToken = cmdletContext.WorkUnitToken; } 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.LakeFormation.Model.GetWorkUnitResultsResponse CallAWSServiceOperation(IAmazonLakeFormation client, Amazon.LakeFormation.Model.GetWorkUnitResultsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Lake Formation", "GetWorkUnitResults"); try { #if DESKTOP return client.GetWorkUnitResults(request); #elif CORECLR return client.GetWorkUnitResultsAsync(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 QueryId { get; set; } public System.Int64? WorkUnitId { get; set; } public System.String WorkUnitToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ResultStream; } } }