@azure/storage-blob 12.5.1-alpha.20210323.1 → 12.6.0

package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js

@@ -1,353 +1,384 @@
 /*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License. See License.txt in the project root for
- * license information.
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
  *
  * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is
- * regenerated.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-import { __assign } from "tslib";
 import * as coreHttp from "@azure/core-http";
-import * as Mappers from "../models/blockBlobMappers";
+import * as Mappers from "../models/mappers";
 import * as Parameters from "../models/parameters";
 /** Class representing a BlockBlob. */
 var BlockBlob = /** @class */ (function () {
     /**
-     * Create a BlockBlob.
-     * @param {StorageClientContext} client Reference to the service client.
+     * Initialize a new instance of the class BlockBlob class.
+     * @param client Reference to the service client
      */
     function BlockBlob(client) {
         this.client = client;
     }
-    BlockBlob.prototype.upload = function (body, contentLength, options, callback) {
-        return this.client.sendOperationRequest({
-            body: body,
+    /**
+     * The Upload Block Blob operation updates the content of an existing block blob. Updating an existing
+     * block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put
+     * Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a
+     * partial update of the content of a block blob, use the Put Block List operation.
+     * @param contentLength The length of the request.
+     * @param body Initial data
+     * @param options The options parameters.
+     */
+    BlockBlob.prototype.upload = function (contentLength, body, options) {
+        var operationArguments = {
             contentLength: contentLength,
-            options: options
-        }, uploadOperationSpec, callback);
+            body: body,
+            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, uploadOperationSpec);
     };
-    BlockBlob.prototype.putBlobFromUrl = function (contentLength, copySource, options, callback) {
-        return this.client.sendOperationRequest({
+    /**
+     * The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read
+     * from a given URL.  This API is supported beginning with the 2020-04-08 version. Partial updates are
+     * not supported with Put Blob from URL; the content of an existing blob is overwritten with the
+     * content of the new blob.  To perform partial updates to a block blob’s contents using a source URL,
+     * use the Put Block from URL API in conjunction with Put Block List.
+     * @param contentLength The length of the request.
+     * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
+     *                   2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
+     *                   appear in a request URI. The source blob must either be public or must be authenticated via a shared
+     *                   access signature.
+     * @param options The options parameters.
+     */
+    BlockBlob.prototype.putBlobFromUrl = function (contentLength, copySource, options) {
+        var operationArguments = {
             contentLength: contentLength,
             copySource: copySource,
-            options: options
-        }, putBlobFromUrlOperationSpec, callback);
+            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, putBlobFromUrlOperationSpec);
     };
-    BlockBlob.prototype.stageBlock = function (blockId, contentLength, body, options, callback) {
-        return this.client.sendOperationRequest({
+    /**
+     * The Stage Block operation creates a new block to be committed as part of a blob
+     * @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
+     *                must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
+     *                for the blockid parameter must be the same size for each block.
+     * @param contentLength The length of the request.
+     * @param body Initial data
+     * @param options The options parameters.
+     */
+    BlockBlob.prototype.stageBlock = function (blockId, contentLength, body, options) {
+        var operationArguments = {
             blockId: blockId,
             contentLength: contentLength,
             body: body,
-            options: options
-        }, stageBlockOperationSpec, callback);
+            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, stageBlockOperationSpec);
     };
-    BlockBlob.prototype.stageBlockFromURL = function (blockId, contentLength, sourceUrl, options, callback) {
-        return this.client.sendOperationRequest({
+    /**
+     * The Stage Block operation creates a new block to be committed as part of a blob where the contents
+     * are read from a URL.
+     * @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
+     *                must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
+     *                for the blockid parameter must be the same size for each block.
+     * @param contentLength The length of the request.
+     * @param sourceUrl Specify a URL to the copy source.
+     * @param options The options parameters.
+     */
+    BlockBlob.prototype.stageBlockFromURL = function (blockId, contentLength, sourceUrl, options) {
+        var operationArguments = {
             blockId: blockId,
             contentLength: contentLength,
             sourceUrl: sourceUrl,
-            options: options
-        }, stageBlockFromURLOperationSpec, callback);
+            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, stageBlockFromURLOperationSpec);
     };
-    BlockBlob.prototype.commitBlockList = function (blocks, options, callback) {
-        return this.client.sendOperationRequest({
+    /**
+     * The Commit Block List operation writes a blob by specifying the list of block IDs that make up the
+     * blob. In order to be written as part of a blob, a block must have been successfully written to the
+     * server in a prior Put Block operation. You can call Put Block List to update a blob by uploading
+     * only those blocks that have changed, then committing the new and existing blocks together. You can
+     * do this by specifying whether to commit a block from the committed block list or from the
+     * uncommitted block list, or to commit the most recently uploaded version of the block, whichever list
+     * it may belong to.
+     * @param blocks
+     * @param options The options parameters.
+     */
+    BlockBlob.prototype.commitBlockList = function (blocks, options) {
+        var operationArguments = {
             blocks: blocks,
-            options: options
-        }, commitBlockListOperationSpec, callback);
+            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, commitBlockListOperationSpec);
     };
-    BlockBlob.prototype.getBlockList = function (listType, options, callback) {
-        return this.client.sendOperationRequest({
+    /**
+     * The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block
+     * blob
+     * @param listType Specifies whether to return the list of committed blocks, the list of uncommitted
+     *                 blocks, or both lists together.
+     * @param options The options parameters.
+     */
+    BlockBlob.prototype.getBlockList = function (listType, options) {
+        var operationArguments = {
             listType: listType,
-            options: options
-        }, getBlockListOperationSpec, callback);
+            options: coreHttp.operationOptionsToRequestOptionsBase(options || {})
+        };
+        return this.client.sendOperationRequest(operationArguments, getBlockListOperationSpec);
     };
     return BlockBlob;
 }());
 export { BlockBlob };
 // Operation Specifications
-var serializer = new coreHttp.Serializer(Mappers, true);
+var xmlSerializer = new coreHttp.Serializer(Mappers, /* isXml */ true);
+var serializer = new coreHttp.Serializer(Mappers, /* isXml */ false);
 var uploadOperationSpec = {
+    path: "/{containerName}/{blob}",
     httpMethod: "PUT",
-    path: "{containerName}/{blob}",
-    urlParameters: [
-        Parameters.url
-    ],
-    queryParameters: [
-        Parameters.timeoutInSeconds
-    ],
+    responses: {
+        201: {
+            headersMapper: Mappers.BlockBlobUploadHeaders
+        },
+        default: {
+            bodyMapper: Mappers.StorageError,
+            headersMapper: Mappers.BlockBlobUploadExceptionHeaders
+        }
+    },
+    requestBody: Parameters.body1,
+    queryParameters: [Parameters.timeoutInSeconds],
+    urlParameters: [Parameters.url],
     headerParameters: [
-        Parameters.transactionalContentMD5,
-        Parameters.contentLength,
-        Parameters.metadata,
-        Parameters.encryptionScope,
-        Parameters.tier0,
         Parameters.version,
         Parameters.requestId,
-        Parameters.blobTagsString,
-        Parameters.blobType2,
-        Parameters.blobContentType,
-        Parameters.blobContentEncoding,
-        Parameters.blobContentLanguage,
-        Parameters.blobContentMD5,
-        Parameters.blobCacheControl,
-        Parameters.blobContentDisposition,
-        Parameters.leaseId0,
-        Parameters.encryptionKey,
-        Parameters.encryptionKeySha256,
-        Parameters.encryptionAlgorithm,
+        Parameters.contentLength,
+        Parameters.metadata,
+        Parameters.leaseId,
         Parameters.ifModifiedSince,
         Parameters.ifUnmodifiedSince,
         Parameters.ifMatch,
         Parameters.ifNoneMatch,
-        Parameters.ifTags
+        Parameters.encryptionKey,
+        Parameters.encryptionKeySha256,
+        Parameters.encryptionAlgorithm,
+        Parameters.ifTags,
+        Parameters.blobCacheControl,
+        Parameters.blobContentType,
+        Parameters.blobContentMD5,
+        Parameters.blobContentEncoding,
+        Parameters.blobContentLanguage,
+        Parameters.blobContentDisposition,
+        Parameters.encryptionScope,
+        Parameters.tier,
+        Parameters.blobTagsString,
+        Parameters.transactionalContentMD5,
+        Parameters.contentType2,
+        Parameters.accept2,
+        Parameters.blobType2
     ],
-    requestBody: {
-        parameterPath: "body",
-        mapper: {
-            required: true,
-            serializedName: "body",
-            type: {
-                name: "Stream"
-            }
-        }
-    },
-    contentType: "application/octet-stream",
+    mediaType: "binary",
+    serializer: serializer
+};
+var putBlobFromUrlOperationSpec = {
+    path: "/{containerName}/{blob}",
+    httpMethod: "PUT",
     responses: {
         201: {
-            headersMapper: Mappers.BlockBlobUploadHeaders
+            headersMapper: Mappers.BlockBlobPutBlobFromUrlHeaders
         },
         default: {
             bodyMapper: Mappers.StorageError,
-            headersMapper: Mappers.BlockBlobUploadHeaders
+            headersMapper: Mappers.BlockBlobPutBlobFromUrlExceptionHeaders
         }
     },
-    isXML: true,
-    serializer: serializer
-};
-var putBlobFromUrlOperationSpec = {
-    httpMethod: "PUT",
-    path: "{containerName}/{blob}",
-    urlParameters: [
-        Parameters.url
-    ],
-    queryParameters: [
-        Parameters.timeoutInSeconds
-    ],
+    queryParameters: [Parameters.timeoutInSeconds],
+    urlParameters: [Parameters.url],
     headerParameters: [
-        Parameters.transactionalContentMD5,
-        Parameters.contentLength,
-        Parameters.metadata,
-        Parameters.encryptionScope,
-        Parameters.tier0,
         Parameters.version,
         Parameters.requestId,
-        Parameters.sourceContentMD5,
-        Parameters.blobTagsString,
-        Parameters.copySource,
-        Parameters.copySourceBlobProperties,
-        Parameters.blobType2,
-        Parameters.blobContentType,
-        Parameters.blobContentEncoding,
-        Parameters.blobContentLanguage,
-        Parameters.blobContentMD5,
-        Parameters.blobCacheControl,
-        Parameters.blobContentDisposition,
-        Parameters.leaseId0,
-        Parameters.encryptionKey,
-        Parameters.encryptionKeySha256,
-        Parameters.encryptionAlgorithm,
+        Parameters.accept1,
+        Parameters.contentLength,
+        Parameters.metadata,
+        Parameters.leaseId,
         Parameters.ifModifiedSince,
         Parameters.ifUnmodifiedSince,
         Parameters.ifMatch,
         Parameters.ifNoneMatch,
-        Parameters.ifTags,
         Parameters.sourceIfModifiedSince,
         Parameters.sourceIfUnmodifiedSince,
         Parameters.sourceIfMatch,
         Parameters.sourceIfNoneMatch,
-        Parameters.sourceIfTags
+        Parameters.encryptionKey,
+        Parameters.encryptionKeySha256,
+        Parameters.encryptionAlgorithm,
+        Parameters.ifTags,
+        Parameters.blobCacheControl,
+        Parameters.blobContentType,
+        Parameters.blobContentMD5,
+        Parameters.blobContentEncoding,
+        Parameters.blobContentLanguage,
+        Parameters.blobContentDisposition,
+        Parameters.encryptionScope,
+        Parameters.tier,
+        Parameters.sourceIfTags,
+        Parameters.copySource,
+        Parameters.blobTagsString,
+        Parameters.sourceContentMD5,
+        Parameters.transactionalContentMD5,
+        Parameters.blobType2,
+        Parameters.copySourceBlobProperties
     ],
+    isXML: true,
+    serializer: xmlSerializer
+};
+var stageBlockOperationSpec = {
+    path: "/{containerName}/{blob}",
+    httpMethod: "PUT",
     responses: {
         201: {
-            headersMapper: Mappers.BlockBlobPutBlobFromUrlHeaders
+            headersMapper: Mappers.BlockBlobStageBlockHeaders
         },
         default: {
             bodyMapper: Mappers.StorageError,
-            headersMapper: Mappers.BlockBlobPutBlobFromUrlHeaders
+            headersMapper: Mappers.BlockBlobStageBlockExceptionHeaders
         }
     },
-    isXML: true,
-    serializer: serializer
-};
-var stageBlockOperationSpec = {
-    httpMethod: "PUT",
-    path: "{containerName}/{blob}",
-    urlParameters: [
-        Parameters.url
-    ],
+    requestBody: Parameters.body1,
     queryParameters: [
-        Parameters.blockId,
         Parameters.timeoutInSeconds,
-        Parameters.comp22
+        Parameters.comp22,
+        Parameters.blockId
     ],
+    urlParameters: [Parameters.url],
     headerParameters: [
-        Parameters.contentLength,
-        Parameters.transactionalContentMD5,
-        Parameters.transactionalContentCrc64,
-        Parameters.encryptionScope,
         Parameters.version,
         Parameters.requestId,
-        Parameters.leaseId0,
+        Parameters.contentLength,
+        Parameters.leaseId,
         Parameters.encryptionKey,
         Parameters.encryptionKeySha256,
-        Parameters.encryptionAlgorithm
+        Parameters.encryptionAlgorithm,
+        Parameters.encryptionScope,
+        Parameters.transactionalContentMD5,
+        Parameters.transactionalContentCrc64,
+        Parameters.contentType2,
+        Parameters.accept2
     ],
-    requestBody: {
-        parameterPath: "body",
-        mapper: {
-            required: true,
-            serializedName: "body",
-            type: {
-                name: "Stream"
-            }
-        }
-    },
-    contentType: "application/octet-stream",
+    mediaType: "binary",
+    serializer: serializer
+};
+var stageBlockFromURLOperationSpec = {
+    path: "/{containerName}/{blob}",
+    httpMethod: "PUT",
     responses: {
         201: {
-            headersMapper: Mappers.BlockBlobStageBlockHeaders
+            headersMapper: Mappers.BlockBlobStageBlockFromURLHeaders
         },
         default: {
             bodyMapper: Mappers.StorageError,
-            headersMapper: Mappers.BlockBlobStageBlockHeaders
+            headersMapper: Mappers.BlockBlobStageBlockFromURLExceptionHeaders
         }
     },
-    isXML: true,
-    serializer: serializer
-};
-var stageBlockFromURLOperationSpec = {
-    httpMethod: "PUT",
-    path: "{containerName}/{blob}",
-    urlParameters: [
-        Parameters.url
-    ],
     queryParameters: [
-        Parameters.blockId,
         Parameters.timeoutInSeconds,
-        Parameters.comp22
+        Parameters.comp22,
+        Parameters.blockId
     ],
+    urlParameters: [Parameters.url],
     headerParameters: [
-        Parameters.contentLength,
-        Parameters.sourceUrl,
-        Parameters.sourceRange1,
-        Parameters.sourceContentMD5,
-        Parameters.sourceContentCrc64,
-        Parameters.encryptionScope,
         Parameters.version,
         Parameters.requestId,
-        Parameters.encryptionKey,
-        Parameters.encryptionKeySha256,
-        Parameters.encryptionAlgorithm,
-        Parameters.leaseId0,
+        Parameters.accept1,
+        Parameters.contentLength,
+        Parameters.leaseId,
         Parameters.sourceIfModifiedSince,
         Parameters.sourceIfUnmodifiedSince,
         Parameters.sourceIfMatch,
-        Parameters.sourceIfNoneMatch
+        Parameters.sourceIfNoneMatch,
+        Parameters.encryptionKey,
+        Parameters.encryptionKeySha256,
+        Parameters.encryptionAlgorithm,
+        Parameters.encryptionScope,
+        Parameters.sourceContentMD5,
+        Parameters.sourceUrl,
+        Parameters.sourceContentCrc64,
+        Parameters.sourceRange1
     ],
+    isXML: true,
+    serializer: xmlSerializer
+};
+var commitBlockListOperationSpec = {
+    path: "/{containerName}/{blob}",
+    httpMethod: "PUT",
     responses: {
         201: {
-            headersMapper: Mappers.BlockBlobStageBlockFromURLHeaders
+            headersMapper: Mappers.BlockBlobCommitBlockListHeaders
         },
         default: {
             bodyMapper: Mappers.StorageError,
-            headersMapper: Mappers.BlockBlobStageBlockFromURLHeaders
+            headersMapper: Mappers.BlockBlobCommitBlockListExceptionHeaders
         }
     },
-    isXML: true,
-    serializer: serializer
-};
-var commitBlockListOperationSpec = {
-    httpMethod: "PUT",
-    path: "{containerName}/{blob}",
-    urlParameters: [
-        Parameters.url
-    ],
-    queryParameters: [
-        Parameters.timeoutInSeconds,
-        Parameters.comp23
-    ],
+    requestBody: Parameters.blocks,
+    queryParameters: [Parameters.timeoutInSeconds, Parameters.comp23],
+    urlParameters: [Parameters.url],
     headerParameters: [
-        Parameters.transactionalContentMD5,
-        Parameters.transactionalContentCrc64,
-        Parameters.metadata,
-        Parameters.encryptionScope,
-        Parameters.tier0,
+        Parameters.contentType,
+        Parameters.accept,
         Parameters.version,
         Parameters.requestId,
-        Parameters.blobTagsString,
+        Parameters.metadata,
+        Parameters.leaseId,
+        Parameters.ifModifiedSince,
+        Parameters.ifUnmodifiedSince,
+        Parameters.ifMatch,
+        Parameters.ifNoneMatch,
+        Parameters.encryptionKey,
+        Parameters.encryptionKeySha256,
+        Parameters.encryptionAlgorithm,
+        Parameters.ifTags,
         Parameters.blobCacheControl,
         Parameters.blobContentType,
+        Parameters.blobContentMD5,
         Parameters.blobContentEncoding,
         Parameters.blobContentLanguage,
-        Parameters.blobContentMD5,
         Parameters.blobContentDisposition,
-        Parameters.leaseId0,
-        Parameters.encryptionKey,
-        Parameters.encryptionKeySha256,
-        Parameters.encryptionAlgorithm,
-        Parameters.ifModifiedSince,
-        Parameters.ifUnmodifiedSince,
-        Parameters.ifMatch,
-        Parameters.ifNoneMatch,
-        Parameters.ifTags
+        Parameters.encryptionScope,
+        Parameters.tier,
+        Parameters.blobTagsString,
+        Parameters.transactionalContentMD5,
+        Parameters.transactionalContentCrc64
     ],
-    requestBody: {
-        parameterPath: "blocks",
-        mapper: __assign(__assign({}, Mappers.BlockLookupList), { required: true })
-    },
+    isXML: true,
     contentType: "application/xml; charset=utf-8",
+    mediaType: "xml",
+    serializer: xmlSerializer
+};
+var getBlockListOperationSpec = {
+    path: "/{containerName}/{blob}",
+    httpMethod: "GET",
     responses: {
-        201: {
-            headersMapper: Mappers.BlockBlobCommitBlockListHeaders
+        200: {
+            bodyMapper: Mappers.BlockList,
+            headersMapper: Mappers.BlockBlobGetBlockListHeaders
         },
         default: {
             bodyMapper: Mappers.StorageError,
-            headersMapper: Mappers.BlockBlobCommitBlockListHeaders
+            headersMapper: Mappers.BlockBlobGetBlockListExceptionHeaders
         }
     },
-    isXML: true,
-    serializer: serializer
-};
-var getBlockListOperationSpec = {
-    httpMethod: "GET",
-    path: "{containerName}/{blob}",
-    urlParameters: [
-        Parameters.url
-    ],
     queryParameters: [
-        Parameters.snapshot,
-        Parameters.listType,
         Parameters.timeoutInSeconds,
-        Parameters.comp23
+        Parameters.snapshot,
+        Parameters.comp23,
+        Parameters.listType
     ],
+    urlParameters: [Parameters.url],
     headerParameters: [
         Parameters.version,
         Parameters.requestId,
-        Parameters.leaseId0,
+        Parameters.accept1,
+        Parameters.leaseId,
         Parameters.ifTags
     ],
-    responses: {
-        200: {
-            bodyMapper: Mappers.BlockList,
-            headersMapper: Mappers.BlockBlobGetBlockListHeaders
-        },
-        default: {
-            bodyMapper: Mappers.StorageError,
-            headersMapper: Mappers.BlockBlobGetBlockListHeaders
-        }
-    },
     isXML: true,
-    serializer: serializer
+    serializer: xmlSerializer
 };
 //# sourceMappingURL=blockBlob.js.map