/*******************************************************************************
* 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.Honeycode;
using Amazon.Honeycode.Model;
namespace Amazon.PowerShell.Cmdlets.HC
{
///
/// The QueryTableRows API allows you to use a filter formula to query for specific rows
/// in a table.
///
[Cmdlet("Invoke", "HCQueryTableRow")]
[OutputType("Amazon.Honeycode.Model.QueryTableRowsResponse")]
[AWSCmdlet("Calls the Amazon Honeycode QueryTableRows API operation.", Operation = new[] {"QueryTableRows"}, SelectReturnType = typeof(Amazon.Honeycode.Model.QueryTableRowsResponse))]
[AWSCmdletOutput("Amazon.Honeycode.Model.QueryTableRowsResponse",
"This cmdlet returns an Amazon.Honeycode.Model.QueryTableRowsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class InvokeHCQueryTableRowCmdlet : AmazonHoneycodeClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
protected override bool IsSensitiveResponse { get; set; } = true;
#region Parameter FilterFormula_ContextRowId
///
///
/// The optional contextRowId attribute can be used to specify the row id of the context
/// row if the filter formula contains unqualified references to table columns and needs
/// a context row to evaluate them successfully.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String FilterFormula_ContextRowId { get; set; }
#endregion
#region Parameter FilterFormula_Formula
///
///
/// A formula representing a filter function that returns zero or more matching rows
/// from a table. Valid formulas in this field return a list of rows from a table. The
/// most common ways of writing a formula to return a list of rows are to use the FindRow()
/// or Filter() functions. Any other formula that returns zero or more rows is also acceptable.
/// For example, you can use a formula that points to a cell that contains a filter function.
///
///
///
#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 FilterFormula_Formula { get; set; }
#endregion
#region Parameter TableId
///
///
/// The ID of the table whose rows are being queried. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
///
///
///
#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 TableId { get; set; }
#endregion
#region Parameter WorkbookId
///
///
/// The ID of the workbook whose table rows are being queried. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
///
///
///
#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 WorkbookId { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of rows to return in each page of the results.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// This parameter is optional. If a nextToken is not specified, the API returns the
/// first page of data. Pagination tokens expire after 1 hour. If you use a token that was returned more
/// than an hour back, the API will throw ValidationException.
///
///
[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 '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Honeycode.Model.QueryTableRowsResponse).
/// Specifying the name of a property of type Amazon.Honeycode.Model.QueryTableRowsResponse 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; } = "*";
#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.FilterFormula_ContextRowId = this.FilterFormula_ContextRowId;
context.FilterFormula_Formula = this.FilterFormula_Formula;
#if MODULAR
if (this.FilterFormula_Formula == null && ParameterWasBound(nameof(this.FilterFormula_Formula)))
{
WriteWarning("You are passing $null as a value for parameter FilterFormula_Formula 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.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.TableId = this.TableId;
#if MODULAR
if (this.TableId == null && ParameterWasBound(nameof(this.TableId)))
{
WriteWarning("You are passing $null as a value for parameter TableId 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.WorkbookId = this.WorkbookId;
#if MODULAR
if (this.WorkbookId == null && ParameterWasBound(nameof(this.WorkbookId)))
{
WriteWarning("You are passing $null as a value for parameter WorkbookId 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.Honeycode.Model.QueryTableRowsRequest();
// populate FilterFormula
var requestFilterFormulaIsNull = true;
request.FilterFormula = new Amazon.Honeycode.Model.Filter();
System.String requestFilterFormula_filterFormula_ContextRowId = null;
if (cmdletContext.FilterFormula_ContextRowId != null)
{
requestFilterFormula_filterFormula_ContextRowId = cmdletContext.FilterFormula_ContextRowId;
}
if (requestFilterFormula_filterFormula_ContextRowId != null)
{
request.FilterFormula.ContextRowId = requestFilterFormula_filterFormula_ContextRowId;
requestFilterFormulaIsNull = false;
}
System.String requestFilterFormula_filterFormula_Formula = null;
if (cmdletContext.FilterFormula_Formula != null)
{
requestFilterFormula_filterFormula_Formula = cmdletContext.FilterFormula_Formula;
}
if (requestFilterFormula_filterFormula_Formula != null)
{
request.FilterFormula.Formula = requestFilterFormula_filterFormula_Formula;
requestFilterFormulaIsNull = false;
}
// determine if request.FilterFormula should be set to null
if (requestFilterFormulaIsNull)
{
request.FilterFormula = null;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
if (cmdletContext.TableId != null)
{
request.TableId = cmdletContext.TableId;
}
if (cmdletContext.WorkbookId != null)
{
request.WorkbookId = cmdletContext.WorkbookId;
}
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.Honeycode.Model.QueryTableRowsResponse CallAWSServiceOperation(IAmazonHoneycode client, Amazon.Honeycode.Model.QueryTableRowsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Honeycode", "QueryTableRows");
try
{
#if DESKTOP
return client.QueryTableRows(request);
#elif CORECLR
return client.QueryTableRowsAsync(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 FilterFormula_ContextRowId { get; set; }
public System.String FilterFormula_Formula { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.String TableId { get; set; }
public System.String WorkbookId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}