/*******************************************************************************
* 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.CloudDirectory;
using Amazon.CloudDirectory.Model;
namespace Amazon.PowerShell.Cmdlets.CDIR
{
///
/// Detaches the specified object from the specified index.
///
[Cmdlet("Dismount", "CDIRObjectFromIndex", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon Cloud Directory DetachFromIndex API operation.", Operation = new[] {"DetachFromIndex"}, SelectReturnType = typeof(Amazon.CloudDirectory.Model.DetachFromIndexResponse))]
[AWSCmdletOutput("System.String or Amazon.CloudDirectory.Model.DetachFromIndexResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.CloudDirectory.Model.DetachFromIndexResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class DismountCDIRObjectFromIndexCmdlet : AmazonCloudDirectoryClientCmdlet, IExecutor
{
#region Parameter DirectoryArn
///
///
/// The Amazon Resource Name (ARN) of the directory the index and object exist in.
///
///
#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 DirectoryArn { get; set; }
#endregion
#region Parameter IndexReference_Selector
///
///
/// A path selector supports easy selection of an object by the parent/child links leading
/// to it from the directory root. Use the link names from each parent/child link to construct
/// the path. Path selectors start with a slash (/) and link names are separated by slashes.
/// For more information about paths, see Access
/// Objects. You can identify an object in one of the following ways:- $ObjectIdentifier - An object identifier is an opaque string provided by Amazon
/// Cloud Directory. When creating objects, the system will provide you with the identifier
/// of the created object. An object’s identifier is immutable and no two objects will
/// ever share the same object identifier. To identify an object with ObjectIdentifier,
/// the ObjectIdentifier must be wrapped in double quotes.
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String IndexReference_Selector { get; set; }
#endregion
#region Parameter TargetReference_Selector
///
///
/// A path selector supports easy selection of an object by the parent/child links leading
/// to it from the directory root. Use the link names from each parent/child link to construct
/// the path. Path selectors start with a slash (/) and link names are separated by slashes.
/// For more information about paths, see Access
/// Objects. You can identify an object in one of the following ways:- $ObjectIdentifier - An object identifier is an opaque string provided by Amazon
/// Cloud Directory. When creating objects, the system will provide you with the identifier
/// of the created object. An object’s identifier is immutable and no two objects will
/// ever share the same object identifier. To identify an object with ObjectIdentifier,
/// the ObjectIdentifier must be wrapped in double quotes.
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TargetReference_Selector { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'DetachedObjectIdentifier'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudDirectory.Model.DetachFromIndexResponse).
/// Specifying the name of a property of type Amazon.CloudDirectory.Model.DetachFromIndexResponse 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; } = "DetachedObjectIdentifier";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the DirectoryArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DirectoryArn' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.DirectoryArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Dismount-CDIRObjectFromIndex (DetachFromIndex)"))
{
return;
}
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.DirectoryArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.DirectoryArn = this.DirectoryArn;
#if MODULAR
if (this.DirectoryArn == null && ParameterWasBound(nameof(this.DirectoryArn)))
{
WriteWarning("You are passing $null as a value for parameter DirectoryArn 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.IndexReference_Selector = this.IndexReference_Selector;
context.TargetReference_Selector = this.TargetReference_Selector;
// 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.CloudDirectory.Model.DetachFromIndexRequest();
if (cmdletContext.DirectoryArn != null)
{
request.DirectoryArn = cmdletContext.DirectoryArn;
}
// populate IndexReference
var requestIndexReferenceIsNull = true;
request.IndexReference = new Amazon.CloudDirectory.Model.ObjectReference();
System.String requestIndexReference_indexReference_Selector = null;
if (cmdletContext.IndexReference_Selector != null)
{
requestIndexReference_indexReference_Selector = cmdletContext.IndexReference_Selector;
}
if (requestIndexReference_indexReference_Selector != null)
{
request.IndexReference.Selector = requestIndexReference_indexReference_Selector;
requestIndexReferenceIsNull = false;
}
// determine if request.IndexReference should be set to null
if (requestIndexReferenceIsNull)
{
request.IndexReference = null;
}
// populate TargetReference
var requestTargetReferenceIsNull = true;
request.TargetReference = new Amazon.CloudDirectory.Model.ObjectReference();
System.String requestTargetReference_targetReference_Selector = null;
if (cmdletContext.TargetReference_Selector != null)
{
requestTargetReference_targetReference_Selector = cmdletContext.TargetReference_Selector;
}
if (requestTargetReference_targetReference_Selector != null)
{
request.TargetReference.Selector = requestTargetReference_targetReference_Selector;
requestTargetReferenceIsNull = false;
}
// determine if request.TargetReference should be set to null
if (requestTargetReferenceIsNull)
{
request.TargetReference = null;
}
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.CloudDirectory.Model.DetachFromIndexResponse CallAWSServiceOperation(IAmazonCloudDirectory client, Amazon.CloudDirectory.Model.DetachFromIndexRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Cloud Directory", "DetachFromIndex");
try
{
#if DESKTOP
return client.DetachFromIndex(request);
#elif CORECLR
return client.DetachFromIndexAsync(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 DirectoryArn { get; set; }
public System.String IndexReference_Selector { get; set; }
public System.String TargetReference_Selector { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DetachedObjectIdentifier;
}
}
}