/*******************************************************************************
* 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.Glue;
using Amazon.Glue.Model;
namespace Amazon.PowerShell.Cmdlets.GLUE
{
/// <summary>
/// Retrieves the <code>Table</code> definition in a Data Catalog for a specified table.
/// </summary>
[Cmdlet("Get", "GLUETable")]
[OutputType("Amazon.Glue.Model.Table")]
[AWSCmdlet("Calls the AWS Glue GetTable API operation.", Operation = new[] {"GetTable"}, SelectReturnType = typeof(Amazon.Glue.Model.GetTableResponse))]
[AWSCmdletOutput("Amazon.Glue.Model.Table or Amazon.Glue.Model.GetTableResponse",
"This cmdlet returns an Amazon.Glue.Model.Table object.",
"The service call response (type Amazon.Glue.Model.GetTableResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetGLUETableCmdlet : AmazonGlueClientCmdlet, IExecutor
{
#region Parameter CatalogId
/// <summary>
/// <para>
/// <para>The ID of the Data Catalog where the table resides. If none is provided, the Amazon
/// Web Services account ID is used by default.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CatalogId { get; set; }
#endregion
#region Parameter DatabaseName
/// <summary>
/// <para>
/// <para>The name of the database in the catalog in which the table resides. For Hive compatibility,
/// this name is entirely lowercase.</para>
/// </para>
/// </summary>
#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 DatabaseName { get; set; }
#endregion
#region Parameter Name
/// <summary>
/// <para>
/// <para>The name of the table for which to retrieve the definition. For Hive compatibility,
/// this name is entirely lowercase.</para>
/// </para>
/// </summary>
#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 Name { get; set; }
#endregion
#region Parameter QueryAsOfTime
/// <summary>
/// <para>
/// <para>The time as of when to read the table contents. If not set, the most recent transaction
/// commit time will be used. Cannot be specified along with <code>TransactionId</code>.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? QueryAsOfTime { get; set; }
#endregion
#region Parameter TransactionId
/// <summary>
/// <para>
/// <para>The transaction ID at which to read the table contents. </para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TransactionId { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'Table'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.GetTableResponse).
/// Specifying the name of a property of type Amazon.Glue.Model.GetTableResponse 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; } = "Table";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the Name parameter.
/// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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<Amazon.Glue.Model.GetTableResponse, GetGLUETableCmdlet>(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.Name;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CatalogId = this.CatalogId;
context.DatabaseName = this.DatabaseName;
#if MODULAR
if (this.DatabaseName == null && ParameterWasBound(nameof(this.DatabaseName)))
{
WriteWarning("You are passing $null as a value for parameter DatabaseName 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.QueryAsOfTime = this.QueryAsOfTime;
context.TransactionId = this.TransactionId;
// 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.Glue.Model.GetTableRequest();
if (cmdletContext.CatalogId != null)
{
request.CatalogId = cmdletContext.CatalogId;
}
if (cmdletContext.DatabaseName != null)
{
request.DatabaseName = cmdletContext.DatabaseName;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.QueryAsOfTime != null)
{
request.QueryAsOfTime = cmdletContext.QueryAsOfTime.Value;
}
if (cmdletContext.TransactionId != null)
{
request.TransactionId = cmdletContext.TransactionId;
}
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.Glue.Model.GetTableResponse CallAWSServiceOperation(IAmazonGlue client, Amazon.Glue.Model.GetTableRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Glue", "GetTable");
try
{
#if DESKTOP
return client.GetTable(request);
#elif CORECLR
return client.GetTableAsync(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 CatalogId { get; set; }
public System.String DatabaseName { get; set; }
public System.String Name { get; set; }
public System.DateTime? QueryAsOfTime { get; set; }
public System.String TransactionId { get; set; }
public System.Func<Amazon.Glue.Model.GetTableResponse, GetGLUETableCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.Table;
}
}
}