Codeunit 8956 AFS Optional Parameters
src/System Application/App/Azure File Services API/src/AFSOptionalParameters.Codeunit.al337 lines, Copyright (c) Microsoft Corporation. MIT
// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace System.Azure.Storage.Files;/// <summary>/// Holds procedures to format headers and parameters to be used in requests./// </summary>codeunit 8956 "AFS Optional Parameters"{ Access = Public; InherentEntitlements = X; InherentPermissions = X; var AFSOptionalParametersImpl: Codeunit "AFS Optional Parameters Impl."; /// <summary> /// Sets the value for 'x-ms-range' HttpHeader for a request. /// </summary> /// <param name="BytesStartValue">Integer value specifying the Bytes start range value</param> /// <param name="BytesEndValue">Integer value specifying the Bytes end range value</param> procedure Range(BytesStartValue: Integer; BytesEndValue: Integer) begin AFSOptionalParametersImpl.Range(BytesStartValue, BytesEndValue); end; /// <summary> /// Sets the value for 'x-ms-write' HttpHeader for a request. /// </summary> /// <param name="Value">Enum "AFS Write" value specifying the HttpHeader value</param> procedure Write("Value": Enum "AFS Write") begin AFSOptionalParametersImpl.Write("Value"); end; /// <summary> /// Sets the value for 'x-ms-lease-id' HttpHeader for a request. /// </summary> /// <param name="Value">Guid value specifying the LeaseID</param> procedure LeaseId("Value": Guid) begin AFSOptionalParametersImpl.LeaseId("Value"); end; /// <summary> /// Sets the value for 'x-ms-lease-action' HttpHeader for a request. /// </summary> /// <param name="Value">Enum "AFS Lease Action" value specifying the LeaseAction</param> internal procedure LeaseAction("Value": Enum "AFS Lease Action") begin AFSOptionalParametersImpl.LeaseAction("Value"); end; /// <summary> /// Sets the value for 'x-ms-lease-duration' HttpHeader for a request. /// </summary> /// <param name="Value">Integer value specifying the LeaseDuration in seconds</param> procedure LeaseDuration("Value": Integer) begin AFSOptionalParametersImpl.LeaseDuration("Value"); end; /// <summary> /// Sets the value for 'x-ms-proposed-lease-id' HttpHeader for a request. /// </summary> /// <param name="Value">Guid value specifying the ProposedLeaseId in seconds</param> procedure ProposedLeaseId("Value": Guid) begin AFSOptionalParametersImpl.ProposedLeaseId("Value"); end; /// <summary> /// Sets the value for 'x-ms-client-request-id' HttpHeader for a request. /// </summary> /// <param name="Value">Text value specifying the HttpHeader value</param> procedure ClientRequestId("Value": Text) begin AFSOptionalParametersImpl.ClientRequestId("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-last-write-time' HttpHeader for a request. /// </summary> /// <param name="Value">Enum "AFS File Last Write Time" value specifying the HttpHeader value</param> procedure FileLastWriteTime("Value": Enum "AFS File Last Write Time") begin AFSOptionalParametersImpl.FileLastWriteTime("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-request-intent' HttpHeader for a request, 'backup' is an acceptable value. /// </summary> /// <param name="Value">Text value specifying the HttpHeader value</param> procedure FileRequestIntent("Value": Text) begin AFSOptionalParametersImpl.FileRequestIntent("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-permission' HttpHeader for a request. /// </summary> /// <param name="Value">Text value specifying the HttpHeader value</param> procedure FilePermission("Value": Text) begin AFSOptionalParametersImpl.FilePermission("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-permission-key' HttpHeader for a request. /// </summary> /// <param name="Value">Text value specifying the HttpHeader value</param> procedure FilePermissionKey("Value": Text) begin AFSOptionalParametersImpl.FilePermissionKey("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-attributes' HttpHeader for a request. /// </summary> /// <param name="Value">Text value specifying the HttpHeader value</param> procedure FileAttributes("Value": List of [Enum "AFS File Attribute"]) begin AFSOptionalParametersImpl.FileAttributes("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-creation-time' HttpHeader for a request. /// </summary> /// <param name="Value">Datetime of the file creation</param> procedure FileCreationTime("Value": DateTime) begin AFSOptionalParametersImpl.FileCreationTime("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-last-write-time' HttpHeader for a request. /// </summary> /// <param name="Value">Datetime of the file last write time</param> procedure FileLastWriteTime("Value": DateTime) begin AFSOptionalParametersImpl.FileLastWriteTime("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-change-time' HttpHeader for a request. /// </summary> /// <param name="Value">Datetime of the file last change time</param> procedure FileChangeTime("Value": DateTime) begin AFSOptionalParametersImpl.FileChangeTime("Value"); end; /// <summary> /// Sets the value for 'x-ms-meta-name' HttpHeader for a request. name should adhere to C# identifiers naming convention. /// </summary> /// <param name="Key">Text value specifying the metadata name key</param> /// <param name="Value">Text value specifying the HttpHeader value</param> procedure Meta("Key": Text; "Value": Text) begin AFSOptionalParametersImpl.Meta("Key", "Value"); end; /// <summary> /// Sets the value for 'x-ms-file-permission-copy-mode' HttpHeader for a request. /// </summary> /// <param name="Value">Enum "AFS File Permission Copy Mode" value specifying the HttpHeader value</param> procedure FilePermissionCopyMode("Value": Enum "AFS File Permission Copy Mode") begin AFSOptionalParametersImpl.FilePermissionCopyMode("Value"); end; /// <summary> /// Sets the value for 'x-ms-copy-source' HttpHeader for a request. /// </summary> /// <param name="Value">Text value specifying the HttpHeader value</param> procedure CopySource("Value": Text) begin AFSOptionalParametersImpl.CopySource("Value"); end; /// <summary> /// Sets the value for 'x-ms-allow-trailing-dot' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure AllowTrailingDot("Value": Boolean) begin AFSOptionalParametersImpl.AllowTrailingDot("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-rename-replace-if-exists' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure FileRenameReplaceIfExists("Value": Boolean) begin AFSOptionalParametersImpl.FileRenameReplaceIfExists("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-rename-ignore-readonly' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure FileRenameIgnoreReadOnly("Value": Boolean) begin AFSOptionalParametersImpl.FileRenameIgnoreReadOnly("Value"); end; /// <summary> /// Sets the value for 'x-ms-source-lease-id' HttpHeader for a request. /// </summary> /// <param name="Value">Guid value specifying the SourceLeaseID</param> procedure SourceLeaseId("Value": Guid) begin AFSOptionalParametersImpl.SourceLeaseId("Value"); end; /// <summary> /// Sets the value for 'x-ms-destination-lease-id' HttpHeader for a request. /// </summary> /// <param name="Value">Guid value specifying the DestinationLeaseID</param> procedure DestinationLeaseId("Value": Guid) begin AFSOptionalParametersImpl.DestinationLeaseId("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-copy-ignore-readonly' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure FileCopyIgnoreReadOnly("Value": Boolean) begin AFSOptionalParametersImpl.FileCopyIgnoreReadOnly("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-copy-set-archive' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure FileCopySetArchive("Value": Boolean) begin AFSOptionalParametersImpl.FileCopySetArchive("Value"); end; /// <summary> /// Sets the value for 'x-ms-file-extended-info' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure FileExtendedInfo("Value": Boolean) begin AFSOptionalParametersImpl.FileExtendedInfo("Value"); end; /// <summary> /// Sets the value for 'x-ms-range-get-content-md5' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure RangeGetContentMD5("Value": Boolean) begin AFSOptionalParametersImpl.RangeGetContentMD5("Value"); end; /// <summary> /// Sets the value for 'x-ms-recursive' HttpHeader for a request. /// </summary> /// <param name="Value">Boolean value specifying the HttpHeader value</param> procedure Recursive("Value": Boolean) begin AFSOptionalParametersImpl.Recursive("Value"); end; /// <summary> /// Sets the optional timeout value for the request. /// </summary> /// <param name="Value">Timeout in seconds. Most operations have a max. limit of 30 seconds. For more Information see: https://go.microsoft.com/fwlink/?linkid=2210591</param> procedure Timeout("Value": Integer) begin AFSOptionalParametersImpl.Timeout("Value"); end; /// <summary> /// Filters the results to return only blobs whose names begin with the specified prefix. /// </summary> /// <param name="Value">Prefix to search for</param> procedure Prefix("Value": Text) begin AFSOptionalParametersImpl.Prefix(Value); end; /// <summary> /// Specifies the share snapshot to query for the list of files and directories. /// </summary> /// <param name="Value">Datetime of the snapshot to query</param> procedure ShareSnapshot("Value": DateTime) begin AFSOptionalParametersImpl.ShareSnapshot("Value"); end; /// <summary> /// A string value that identifies the portion of the list to be returned with the next list operation. /// </summary> /// <param name="Value">Text marker that was returned in previous operation</param> procedure Marker("Value": Text) begin AFSOptionalParametersImpl.Marker("Value"); end; /// <summary> /// Specifies the maximum number of files or directories to return /// </summary> /// <param name="Value">Max. number of results to return. Must be positive, must not be greater than 5000</param> procedure MaxResults("Value": Integer) begin AFSOptionalParametersImpl.MaxResults("Value"); end; /// <summary> /// Specifies one or more properties to include in the response. /// </summary> /// <param name="Value">List of properties to include.</param> procedure Include("Value": List of [Enum "AFS Property"]) begin AFSOptionalParametersImpl.Include("Value"); end; internal procedure GetRequestHeaders(): Dictionary of [Text, Text] begin exit(AFSOptionalParametersImpl.GetRequestHeaders()); end; internal procedure GetParameters(): Dictionary of [Text, Text] begin exit(AFSOptionalParametersImpl.GetParameters()); end;}