/*******************************************************************************
* 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.CodeCommit;
using Amazon.CodeCommit.Model;
namespace Amazon.PowerShell.Cmdlets.CC
{
///
/// Deletes a specified file from a specified branch. A commit is created on the branch
/// that contains the revision. The file still exists in the commits earlier to the commit
/// that contains the deletion.
///
[Cmdlet("Remove", "CCFile", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)]
[OutputType("Amazon.CodeCommit.Model.DeleteFileResponse")]
[AWSCmdlet("Calls the AWS CodeCommit DeleteFile API operation.", Operation = new[] {"DeleteFile"}, SelectReturnType = typeof(Amazon.CodeCommit.Model.DeleteFileResponse))]
[AWSCmdletOutput("Amazon.CodeCommit.Model.DeleteFileResponse",
"This cmdlet returns an Amazon.CodeCommit.Model.DeleteFileResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RemoveCCFileCmdlet : AmazonCodeCommitClientCmdlet, IExecutor
{
#region Parameter BranchName
///
///
/// The name of the branch where the commit that deletes the file is made.
///
///
#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 BranchName { get; set; }
#endregion
#region Parameter CommitMessage
///
///
/// The commit message you want to include as part of deleting the file. Commit messages
/// are limited to 256 KB. If no message is specified, a default message is used.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CommitMessage { get; set; }
#endregion
#region Parameter Email
///
///
/// The email address for the commit that deletes the file. If no email address is specified,
/// the email address is left blank.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Email { get; set; }
#endregion
#region Parameter FilePath
///
///
/// The fully qualified path to the file that to be deleted, including the full name and
/// extension of that file. For example, /examples/file.md is a fully qualified path to
/// a file named file.md in a folder named examples.
///
///
#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 FilePath { get; set; }
#endregion
#region Parameter KeepEmptyFolder
///
///
/// If a file is the only object in the folder or directory, specifies whether to delete
/// the folder or directory that contains the file. By default, empty folders are deleted.
/// This includes empty folders that are part of the directory structure. For example,
/// if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting
/// the last file in dir4 also deletes the empty folders dir4, dir3, and dir2.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("KeepEmptyFolders")]
public System.Boolean? KeepEmptyFolder { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the author of the commit that deletes the file. If no name is specified,
/// the user's ARN is used as the author name and committer name.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Name { get; set; }
#endregion
#region Parameter ParentCommitId
///
///
/// The ID of the commit that is the tip of the branch where you want to create the commit
/// that deletes the file. This must be the HEAD commit for the branch. The commit that
/// deletes the file is created from this commit ID.
///
///
#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 ParentCommitId { get; set; }
#endregion
#region Parameter RepositoryName
///
///
/// The name of the repository that contains the file to delete.
///
///
#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 RepositoryName { 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.CodeCommit.Model.DeleteFileResponse).
/// Specifying the name of a property of type Amazon.CodeCommit.Model.DeleteFileResponse 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
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the RepositoryName parameter.
/// The -PassThru parameter is deprecated, use -Select '^RepositoryName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RepositoryName' 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.RepositoryName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-CCFile (DeleteFile)"))
{
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.RepositoryName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.BranchName = this.BranchName;
#if MODULAR
if (this.BranchName == null && ParameterWasBound(nameof(this.BranchName)))
{
WriteWarning("You are passing $null as a value for parameter BranchName 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.CommitMessage = this.CommitMessage;
context.Email = this.Email;
context.FilePath = this.FilePath;
#if MODULAR
if (this.FilePath == null && ParameterWasBound(nameof(this.FilePath)))
{
WriteWarning("You are passing $null as a value for parameter FilePath 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.KeepEmptyFolder = this.KeepEmptyFolder;
context.Name = this.Name;
context.ParentCommitId = this.ParentCommitId;
#if MODULAR
if (this.ParentCommitId == null && ParameterWasBound(nameof(this.ParentCommitId)))
{
WriteWarning("You are passing $null as a value for parameter ParentCommitId 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.RepositoryName = this.RepositoryName;
#if MODULAR
if (this.RepositoryName == null && ParameterWasBound(nameof(this.RepositoryName)))
{
WriteWarning("You are passing $null as a value for parameter RepositoryName 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.CodeCommit.Model.DeleteFileRequest();
if (cmdletContext.BranchName != null)
{
request.BranchName = cmdletContext.BranchName;
}
if (cmdletContext.CommitMessage != null)
{
request.CommitMessage = cmdletContext.CommitMessage;
}
if (cmdletContext.Email != null)
{
request.Email = cmdletContext.Email;
}
if (cmdletContext.FilePath != null)
{
request.FilePath = cmdletContext.FilePath;
}
if (cmdletContext.KeepEmptyFolder != null)
{
request.KeepEmptyFolders = cmdletContext.KeepEmptyFolder.Value;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.ParentCommitId != null)
{
request.ParentCommitId = cmdletContext.ParentCommitId;
}
if (cmdletContext.RepositoryName != null)
{
request.RepositoryName = cmdletContext.RepositoryName;
}
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.CodeCommit.Model.DeleteFileResponse CallAWSServiceOperation(IAmazonCodeCommit client, Amazon.CodeCommit.Model.DeleteFileRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CodeCommit", "DeleteFile");
try
{
#if DESKTOP
return client.DeleteFile(request);
#elif CORECLR
return client.DeleteFileAsync(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 BranchName { get; set; }
public System.String CommitMessage { get; set; }
public System.String Email { get; set; }
public System.String FilePath { get; set; }
public System.Boolean? KeepEmptyFolder { get; set; }
public System.String Name { get; set; }
public System.String ParentCommitId { get; set; }
public System.String RepositoryName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}