/******************************************************************************* * 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.WorkDocs; using Amazon.WorkDocs.Model; namespace Amazon.PowerShell.Cmdlets.WD { /// /// Describes the contents of the specified folder, including its documents and subfolders. /// /// /// /// By default, Amazon WorkDocs returns the first 100 active document and folder metadata /// items. If there are more results, the response includes a marker that you can use /// to request the next set of results. You can also request initialized documents. ///

In the AWS.Tools.WorkDocs module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Get", "WDFolderContent")] [OutputType("Amazon.WorkDocs.Model.DescribeFolderContentsResponse")] [AWSCmdlet("Calls the Amazon WorkDocs DescribeFolderContents API operation.", Operation = new[] {"DescribeFolderContents"}, SelectReturnType = typeof(Amazon.WorkDocs.Model.DescribeFolderContentsResponse))] [AWSCmdletOutput("Amazon.WorkDocs.Model.DescribeFolderContentsResponse", "This cmdlet returns an Amazon.WorkDocs.Model.DescribeFolderContentsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetWDFolderContentCmdlet : AmazonWorkDocsClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter AuthenticationToken /// /// /// Amazon WorkDocs authentication token. Not required when using Amazon Web Services /// administrator credentials to access the API. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AuthenticationToken { get; set; } #endregion #region Parameter FolderId /// /// /// The ID of the folder. /// /// #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 FolderId { get; set; } #endregion #region Parameter Include /// /// /// The contents to include. Specify "INITIALIZED" to include initialized documents. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Include { get; set; } #endregion #region Parameter Order /// /// /// The order for the contents of the folder. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.WorkDocs.OrderType")] public Amazon.WorkDocs.OrderType Order { get; set; } #endregion #region Parameter Sort /// /// /// The sorting criteria. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.WorkDocs.ResourceSortType")] public Amazon.WorkDocs.ResourceSortType Sort { get; set; } #endregion #region Parameter Type /// /// /// The type of items. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.WorkDocs.FolderContentType")] public Amazon.WorkDocs.FolderContentType Type { get; set; } #endregion #region Parameter Limit /// /// /// The maximum number of items to return with this call. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Limit { get; set; } #endregion #region Parameter Marker /// /// /// The marker for the next set of results. This marker was received from a previous call. /// /// ///
Note: In the AWS.Tools.WorkDocs module, this parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String Marker { 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.WorkDocs.Model.DescribeFolderContentsResponse). /// Specifying the name of a property of type Amazon.WorkDocs.Model.DescribeFolderContentsResponse 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 FolderId parameter. /// The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter NoAutoIteration #if MODULAR /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { get; set; } #endif #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.FolderId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AuthenticationToken = this.AuthenticationToken; context.FolderId = this.FolderId; #if MODULAR if (this.FolderId == null && ParameterWasBound(nameof(this.FolderId))) { WriteWarning("You are passing $null as a value for parameter FolderId 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.Include = this.Include; context.Limit = this.Limit; context.Marker = this.Marker; context.Order = this.Order; context.Sort = this.Sort; context.Type = this.Type; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members #if MODULAR public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // create request and set iteration invariants var request = new Amazon.WorkDocs.Model.DescribeFolderContentsRequest(); if (cmdletContext.AuthenticationToken != null) { request.AuthenticationToken = cmdletContext.AuthenticationToken; } if (cmdletContext.FolderId != null) { request.FolderId = cmdletContext.FolderId; } if (cmdletContext.Include != null) { request.Include = cmdletContext.Include; } if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.Value; } if (cmdletContext.Order != null) { request.Order = cmdletContext.Order; } if (cmdletContext.Sort != null) { request.Sort = cmdletContext.Sort; } if (cmdletContext.Type != null) { request.Type = cmdletContext.Type; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.Marker; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.Marker; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #else public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.WorkDocs.Model.DescribeFolderContentsRequest(); if (cmdletContext.AuthenticationToken != null) { request.AuthenticationToken = cmdletContext.AuthenticationToken; } if (cmdletContext.FolderId != null) { request.FolderId = cmdletContext.FolderId; } if (cmdletContext.Include != null) { request.Include = cmdletContext.Include; } if (cmdletContext.Limit != null) { request.Limit = cmdletContext.Limit.Value; } if (cmdletContext.Marker != null) { request.Marker = cmdletContext.Marker; } if (cmdletContext.Order != null) { request.Order = cmdletContext.Order; } if (cmdletContext.Sort != null) { request.Sort = cmdletContext.Sort; } if (cmdletContext.Type != null) { request.Type = cmdletContext.Type; } 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; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.WorkDocs.Model.DescribeFolderContentsResponse CallAWSServiceOperation(IAmazonWorkDocs client, Amazon.WorkDocs.Model.DescribeFolderContentsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkDocs", "DescribeFolderContents"); try { #if DESKTOP return client.DescribeFolderContents(request); #elif CORECLR return client.DescribeFolderContentsAsync(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 AuthenticationToken { get; set; } public System.String FolderId { get; set; } public System.String Include { get; set; } public System.Int32? Limit { get; set; } public System.String Marker { get; set; } public Amazon.WorkDocs.OrderType Order { get; set; } public Amazon.WorkDocs.ResourceSortType Sort { get; set; } public Amazon.WorkDocs.FolderContentType Type { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }