@depup/azure__storage-blob 12.31.0-depup.0

package/dist/esm/generated/src/operations/blob.d.ts

@@ -0,0 +1,178 @@
+import { Blob } from "../operationsInterfaces/index.js";
+import { StorageClient } from "../storageClient.js";
+import { BlobDownloadOptionalParams, BlobDownloadResponse, BlobGetPropertiesOptionalParams, BlobGetPropertiesResponse, BlobDeleteOptionalParams, BlobDeleteResponse, BlobUndeleteOptionalParams, BlobUndeleteResponse, BlobExpiryOptions, BlobSetExpiryOptionalParams, BlobSetExpiryResponse, BlobSetHttpHeadersOptionalParams, BlobSetHttpHeadersResponse, BlobSetImmutabilityPolicyOptionalParams, BlobSetImmutabilityPolicyResponse, BlobDeleteImmutabilityPolicyOptionalParams, BlobDeleteImmutabilityPolicyResponse, BlobSetLegalHoldOptionalParams, BlobSetLegalHoldResponse, BlobSetMetadataOptionalParams, BlobSetMetadataResponse, BlobAcquireLeaseOptionalParams, BlobAcquireLeaseResponse, BlobReleaseLeaseOptionalParams, BlobReleaseLeaseResponse, BlobRenewLeaseOptionalParams, BlobRenewLeaseResponse, BlobChangeLeaseOptionalParams, BlobChangeLeaseResponse, BlobBreakLeaseOptionalParams, BlobBreakLeaseResponse, BlobCreateSnapshotOptionalParams, BlobCreateSnapshotResponse, BlobStartCopyFromURLOptionalParams, BlobStartCopyFromURLResponse, BlobCopyFromURLOptionalParams, BlobCopyFromURLResponse, BlobAbortCopyFromURLOptionalParams, BlobAbortCopyFromURLResponse, AccessTier, BlobSetTierOptionalParams, BlobSetTierResponse, BlobGetAccountInfoOptionalParams, BlobGetAccountInfoResponse, BlobQueryOptionalParams, BlobQueryResponse, BlobGetTagsOptionalParams, BlobGetTagsResponse, BlobSetTagsOptionalParams, BlobSetTagsResponse } from "../models/index.js";
+/** Class containing Blob operations. */
+export declare class BlobImpl implements Blob {
+    private readonly client;
+    /**
+     * Initialize a new instance of the class Blob class.
+     * @param client Reference to the service client
+     */
+    constructor(client: StorageClient);
+    /**
+     * The Download operation reads or downloads a blob from the system, including its metadata and
+     * properties. You can also call Download to read a snapshot.
+     * @param options The options parameters.
+     */
+    download(options?: BlobDownloadOptionalParams): Promise<BlobDownloadResponse>;
+    /**
+     * The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system
+     * properties for the blob. It does not return the content of the blob.
+     * @param options The options parameters.
+     */
+    getProperties(options?: BlobGetPropertiesOptionalParams): Promise<BlobGetPropertiesResponse>;
+    /**
+     * If the storage account's soft delete feature is disabled then, when a blob is deleted, it is
+     * permanently removed from the storage account. If the storage account's soft delete feature is
+     * enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible
+     * immediately. However, the blob service retains the blob or snapshot for the number of days specified
+     * by the DeleteRetentionPolicy section of [Storage service properties]
+     * (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is
+     * permanently removed from the storage account. Note that you continue to be charged for the
+     * soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the
+     * "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You
+     * can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a
+     * soft-deleted blob or snapshot causes the service to return an HTTP status code of 404
+     * (ResourceNotFound).
+     * @param options The options parameters.
+     */
+    delete(options?: BlobDeleteOptionalParams): Promise<BlobDeleteResponse>;
+    /**
+     * Undelete a blob that was previously soft deleted
+     * @param options The options parameters.
+     */
+    undelete(options?: BlobUndeleteOptionalParams): Promise<BlobUndeleteResponse>;
+    /**
+     * Sets the time a blob will expire and be deleted.
+     * @param expiryOptions Required. Indicates mode of the expiry time
+     * @param options The options parameters.
+     */
+    setExpiry(expiryOptions: BlobExpiryOptions, options?: BlobSetExpiryOptionalParams): Promise<BlobSetExpiryResponse>;
+    /**
+     * The Set HTTP Headers operation sets system properties on the blob
+     * @param options The options parameters.
+     */
+    setHttpHeaders(options?: BlobSetHttpHeadersOptionalParams): Promise<BlobSetHttpHeadersResponse>;
+    /**
+     * The Set Immutability Policy operation sets the immutability policy on the blob
+     * @param options The options parameters.
+     */
+    setImmutabilityPolicy(options?: BlobSetImmutabilityPolicyOptionalParams): Promise<BlobSetImmutabilityPolicyResponse>;
+    /**
+     * The Delete Immutability Policy operation deletes the immutability policy on the blob
+     * @param options The options parameters.
+     */
+    deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptionalParams): Promise<BlobDeleteImmutabilityPolicyResponse>;
+    /**
+     * The Set Legal Hold operation sets a legal hold on the blob.
+     * @param legalHold Specified if a legal hold should be set on the blob.
+     * @param options The options parameters.
+     */
+    setLegalHold(legalHold: boolean, options?: BlobSetLegalHoldOptionalParams): Promise<BlobSetLegalHoldResponse>;
+    /**
+     * The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more
+     * name-value pairs
+     * @param options The options parameters.
+     */
+    setMetadata(options?: BlobSetMetadataOptionalParams): Promise<BlobSetMetadataResponse>;
+    /**
+     * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+     * operations
+     * @param options The options parameters.
+     */
+    acquireLease(options?: BlobAcquireLeaseOptionalParams): Promise<BlobAcquireLeaseResponse>;
+    /**
+     * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+     * operations
+     * @param leaseId Specifies the current lease ID on the resource.
+     * @param options The options parameters.
+     */
+    releaseLease(leaseId: string, options?: BlobReleaseLeaseOptionalParams): Promise<BlobReleaseLeaseResponse>;
+    /**
+     * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+     * operations
+     * @param leaseId Specifies the current lease ID on the resource.
+     * @param options The options parameters.
+     */
+    renewLease(leaseId: string, options?: BlobRenewLeaseOptionalParams): Promise<BlobRenewLeaseResponse>;
+    /**
+     * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+     * operations
+     * @param leaseId Specifies the current lease ID on the resource.
+     * @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
+     *                        (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
+     *                        (String) for a list of valid GUID string formats.
+     * @param options The options parameters.
+     */
+    changeLease(leaseId: string, proposedLeaseId: string, options?: BlobChangeLeaseOptionalParams): Promise<BlobChangeLeaseResponse>;
+    /**
+     * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+     * operations
+     * @param options The options parameters.
+     */
+    breakLease(options?: BlobBreakLeaseOptionalParams): Promise<BlobBreakLeaseResponse>;
+    /**
+     * The Create Snapshot operation creates a read-only snapshot of a blob
+     * @param options The options parameters.
+     */
+    createSnapshot(options?: BlobCreateSnapshotOptionalParams): Promise<BlobCreateSnapshotResponse>;
+    /**
+     * The Start Copy From URL operation copies a blob or an internet resource to a new blob.
+     * @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.
+     */
+    startCopyFromURL(copySource: string, options?: BlobStartCopyFromURLOptionalParams): Promise<BlobStartCopyFromURLResponse>;
+    /**
+     * The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return
+     * a response until the copy is complete.
+     * @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.
+     */
+    copyFromURL(copySource: string, options?: BlobCopyFromURLOptionalParams): Promise<BlobCopyFromURLResponse>;
+    /**
+     * The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination
+     * blob with zero length and full metadata.
+     * @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy Blob
+     *               operation.
+     * @param options The options parameters.
+     */
+    abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptionalParams): Promise<BlobAbortCopyFromURLResponse>;
+    /**
+     * The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium
+     * storage account and on a block blob in a blob storage account (locally redundant storage only). A
+     * premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block
+     * blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's
+     * ETag.
+     * @param tier Indicates the tier to be set on the blob.
+     * @param options The options parameters.
+     */
+    setTier(tier: AccessTier, options?: BlobSetTierOptionalParams): Promise<BlobSetTierResponse>;
+    /**
+     * Returns the sku name and account kind
+     * @param options The options parameters.
+     */
+    getAccountInfo(options?: BlobGetAccountInfoOptionalParams): Promise<BlobGetAccountInfoResponse>;
+    /**
+     * The Query operation enables users to select/project on blob data by providing simple query
+     * expressions.
+     * @param options The options parameters.
+     */
+    query(options?: BlobQueryOptionalParams): Promise<BlobQueryResponse>;
+    /**
+     * The Get Tags operation enables users to get the tags associated with a blob.
+     * @param options The options parameters.
+     */
+    getTags(options?: BlobGetTagsOptionalParams): Promise<BlobGetTagsResponse>;
+    /**
+     * The Set Tags operation enables users to set tags on a blob.
+     * @param options The options parameters.
+     */
+    setTags(options?: BlobSetTagsOptionalParams): Promise<BlobSetTagsResponse>;
+}
+//# sourceMappingURL=blob.d.ts.map

package/dist/esm/generated/src/operations/blob.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../../../../../src/generated/src/operations/blob.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AAIxD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,EACpB,+BAA+B,EAC/B,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,0BAA0B,EAC1B,oBAAoB,EACpB,iBAAiB,EACjB,2BAA2B,EAC3B,qBAAqB,EACrB,gCAAgC,EAChC,0BAA0B,EAC1B,uCAAuC,EACvC,iCAAiC,EACjC,0CAA0C,EAC1C,oCAAoC,EACpC,8BAA8B,EAC9B,wBAAwB,EACxB,6BAA6B,EAC7B,uBAAuB,EACvB,8BAA8B,EAC9B,wBAAwB,EACxB,8BAA8B,EAC9B,wBAAwB,EACxB,4BAA4B,EAC5B,sBAAsB,EACtB,6BAA6B,EAC7B,uBAAuB,EACvB,4BAA4B,EAC5B,sBAAsB,EACtB,gCAAgC,EAChC,0BAA0B,EAC1B,kCAAkC,EAClC,4BAA4B,EAC5B,6BAA6B,EAC7B,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,UAAU,EACV,yBAAyB,EACzB,mBAAmB,EACnB,gCAAgC,EAChC,0BAA0B,EAC1B,uBAAuB,EACvB,iBAAiB,EACjB,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACpB,MAAM,oBAAoB,CAAC;AAE5B,wCAAwC;AACxC,qBAAa,QAAS,YAAW,IAAI;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;OAGG;gBACS,MAAM,EAAE,aAAa;IAIjC;;;;OAIG;IACH,QAAQ,CACN,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;OAIG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,+BAA+B,GACxC,OAAO,CAAC,yBAAyB,CAAC;IAOrC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIvE;;;OAGG;IACH,QAAQ,CACN,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;OAIG;IACH,SAAS,CACP,aAAa,EAAE,iBAAiB,EAChC,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,qBAAqB,CAAC;IAOjC;;;OAGG;IACH,cAAc,CACZ,OAAO,CAAC,EAAE,gCAAgC,GACzC,OAAO,CAAC,0BAA0B,CAAC;IAOtC;;;OAGG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,uCAAuC,GAChD,OAAO,CAAC,iCAAiC,CAAC;IAO7C;;;OAGG;IACH,wBAAwB,CACtB,OAAO,CAAC,EAAE,0CAA0C,GACnD,OAAO,CAAC,oCAAoC,CAAC;IAOhD;;;;OAIG;IACH,YAAY,CACV,SAAS,EAAE,OAAO,EAClB,OAAO,CAAC,EAAE,8BAA8B,GACvC,OAAO,CAAC,wBAAwB,CAAC;IAOpC;;;;OAIG;IACH,WAAW,CACT,OAAO,CAAC,EAAE,6BAA6B,GACtC,OAAO,CAAC,uBAAuB,CAAC;IAOnC;;;;OAIG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,8BAA8B,GACvC,OAAO,CAAC,wBAAwB,CAAC;IAOpC;;;;;OAKG;IACH,YAAY,CACV,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,8BAA8B,GACvC,OAAO,CAAC,wBAAwB,CAAC;IAOpC;;;;;OAKG;IACH,UAAU,CACR,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,sBAAsB,CAAC;IAOlC;;;;;;;;OAQG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,6BAA6B,GACtC,OAAO,CAAC,uBAAuB,CAAC;IAOnC;;;;OAIG;IACH,UAAU,CACR,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,sBAAsB,CAAC;IAOlC;;;OAGG;IACH,cAAc,CACZ,OAAO,CAAC,EAAE,gCAAgC,GACzC,OAAO,CAAC,0BAA0B,CAAC;IAOtC;;;;;;;OAOG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,kCAAkC,GAC3C,OAAO,CAAC,4BAA4B,CAAC;IAOxC;;;;;;;;OAQG;IACH,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,6BAA6B,GACtC,OAAO,CAAC,uBAAuB,CAAC;IAOnC;;;;;;OAMG;IACH,gBAAgB,CACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,kCAAkC,GAC3C,OAAO,CAAC,4BAA4B,CAAC;IAOxC;;;;;;;;OAQG;IACH,OAAO,CACL,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;;OAGG;IACH,cAAc,CACZ,OAAO,CAAC,EAAE,gCAAgC,GACzC,OAAO,CAAC,0BAA0B,CAAC;IAOtC;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIpE;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAI1E;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAG3E"}