/*******************************************************************************
* 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.Appflow;
using Amazon.Appflow.Model;
namespace Amazon.PowerShell.Cmdlets.AF
{
///
/// Returns the list of available connector entities supported by Amazon AppFlow. For
/// example, you can query Salesforce for Account and Opportunity entities,
/// or query ServiceNow for the Incident entity.
///
[Cmdlet("Get", "AFConnectorEntityList")]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon Appflow ListConnectorEntities API operation.", Operation = new[] {"ListConnectorEntities"}, SelectReturnType = typeof(Amazon.Appflow.Model.ListConnectorEntitiesResponse))]
[AWSCmdletOutput("System.String or Amazon.Appflow.Model.ListConnectorEntitiesResponse",
"This cmdlet returns a collection of System.String objects.",
"The service call response (type Amazon.Appflow.Model.ListConnectorEntitiesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetAFConnectorEntityListCmdlet : AmazonAppflowClientCmdlet, IExecutor
{
#region Parameter ApiVersion
///
///
/// The version of the API that's used by the connector.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ApiVersion { get; set; }
#endregion
#region Parameter ConnectorProfileName
///
///
/// The name of the connector profile. The name is unique for each ConnectorProfile
/// in the Amazon Web Services account, and is used to query the downstream connector.
///
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String ConnectorProfileName { get; set; }
#endregion
#region Parameter ConnectorType
///
///
/// The type of connector, such as Salesforce, Amplitude, and so on.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Appflow.ConnectorType")]
public Amazon.Appflow.ConnectorType ConnectorType { get; set; }
#endregion
#region Parameter EntitiesPath
///
///
/// This optional parameter is specific to connector implementation. Some connectors
/// support multiple levels or categories of entities. You can find out the list of roots
/// for such providers by sending a request without the entitiesPath
parameter.
/// If the connector supports entities at different roots, this initial request returns
/// the list of roots. Otherwise, this request returns all entities supported by the provider.
///
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String EntitiesPath { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of items that the operation returns in the response.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// A token that was provided by your prior ListConnectorEntities
operation
/// if the response was too big for the page size. You specify this token to get the next
/// page of results in paginated response.
///
///
[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 'ConnectorEntityMap'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Appflow.Model.ListConnectorEntitiesResponse).
/// Specifying the name of a property of type Amazon.Appflow.Model.ListConnectorEntitiesResponse 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; } = "ConnectorEntityMap";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ConnectorProfileName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ConnectorProfileName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ConnectorProfileName' 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.ConnectorProfileName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ApiVersion = this.ApiVersion;
context.ConnectorProfileName = this.ConnectorProfileName;
context.ConnectorType = this.ConnectorType;
context.EntitiesPath = this.EntitiesPath;
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
// 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.Appflow.Model.ListConnectorEntitiesRequest();
if (cmdletContext.ApiVersion != null)
{
request.ApiVersion = cmdletContext.ApiVersion;
}
if (cmdletContext.ConnectorProfileName != null)
{
request.ConnectorProfileName = cmdletContext.ConnectorProfileName;
}
if (cmdletContext.ConnectorType != null)
{
request.ConnectorType = cmdletContext.ConnectorType;
}
if (cmdletContext.EntitiesPath != null)
{
request.EntitiesPath = cmdletContext.EntitiesPath;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
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.Appflow.Model.ListConnectorEntitiesResponse CallAWSServiceOperation(IAmazonAppflow client, Amazon.Appflow.Model.ListConnectorEntitiesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Appflow", "ListConnectorEntities");
try
{
#if DESKTOP
return client.ListConnectorEntities(request);
#elif CORECLR
return client.ListConnectorEntitiesAsync(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 ApiVersion { get; set; }
public System.String ConnectorProfileName { get; set; }
public Amazon.Appflow.ConnectorType ConnectorType { get; set; }
public System.String EntitiesPath { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ConnectorEntityMap;
}
}
}