blob_client.hpp

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include "azure/core/credentials/credentials.hpp"
#include "azure/storage/blobs/blob_options.hpp"
#include "azure/storage/blobs/blob_responses.hpp"
#include "azure/storage/blobs/protocol/blob_rest_client.hpp"
#include "azure/storage/common/storage_credential.hpp"
 
#include <map>
#include <memory>
#include <string>
 
namespace Azure { namespace Storage { namespace Files { namespace DataLake {
  class DirectoryClient;
  class FileClient;
}}}} // namespace Azure::Storage::Files::DataLake
 
namespace Azure { namespace Storage { namespace Blobs {
 
  class BlockBlobClient;
  class AppendBlobClient;
  class PageBlobClient;
 
  class BlobClient {
  public:
    static BlobClient CreateFromConnectionString(
        const std::string& connectionString,
        const std::string& containerName,
        const std::string& blobName,
        const BlobClientOptions& options = BlobClientOptions());
 
    explicit BlobClient(
        const std::string& blobUri,
        std::shared_ptr<SharedKeyCredential> credential,
        const BlobClientOptions& options = BlobClientOptions());
 
    explicit BlobClient(
        const std::string& blobUri,
        std::shared_ptr<Core::Credentials::ClientSecretCredential> credential,
        const BlobClientOptions& options = BlobClientOptions());
 
    explicit BlobClient(
        const std::string& blobUri,
        const BlobClientOptions& options = BlobClientOptions());
 
    BlockBlobClient GetBlockBlobClient() const;
 
    AppendBlobClient GetAppendBlobClient() const;
 
    PageBlobClient GetPageBlobClient() const;
 
    std::string GetUri() const { return m_blobUrl.GetAbsoluteUrl(); }
 
    BlobClient WithSnapshot(const std::string& snapshot) const;
 
    BlobClient WithVersionId(const std::string& versionId) const;
 
    Azure::Core::Response<GetBlobPropertiesResult> GetProperties(
        const GetBlobPropertiesOptions& options = GetBlobPropertiesOptions()) const;
 
    Azure::Core::Response<SetBlobHttpHeadersResult> SetHttpHeaders(
        BlobHttpHeaders httpHeaders,
        const SetBlobHttpHeadersOptions& options = SetBlobHttpHeadersOptions()) const;
 
    Azure::Core::Response<SetBlobMetadataResult> SetMetadata(
        std::map<std::string, std::string> metadata,
        const SetBlobMetadataOptions& options = SetBlobMetadataOptions()) const;
 
    Azure::Core::Response<SetBlobAccessTierResult> SetAccessTier(
        AccessTier Tier,
        const SetBlobAccessTierOptions& options = SetBlobAccessTierOptions()) const;
 
    Azure::Core::Response<StartCopyBlobFromUriResult> StartCopyFromUri(
        const std::string& sourceUri,
        const StartCopyBlobFromUriOptions& options = StartCopyBlobFromUriOptions()) const;
 
    Azure::Core::Response<AbortCopyBlobFromUriResult> AbortCopyFromUri(
        const std::string& copyId,
        const AbortCopyBlobFromUriOptions& options = AbortCopyBlobFromUriOptions()) const;
 
    Azure::Core::Response<DownloadBlobResult> Download(
        const DownloadBlobOptions& options = DownloadBlobOptions()) const;
 
    Azure::Core::Response<DownloadBlobToResult> DownloadTo(
        uint8_t* buffer,
        std::size_t bufferSize,
        const DownloadBlobToOptions& options = DownloadBlobToOptions()) const;
 
    Azure::Core::Response<DownloadBlobToResult> DownloadTo(
        const std::string& file,
        const DownloadBlobToOptions& options = DownloadBlobToOptions()) const;
 
    Azure::Core::Response<CreateBlobSnapshotResult> CreateSnapshot(
        const CreateBlobSnapshotOptions& options = CreateBlobSnapshotOptions()) const;
 
    Azure::Core::Response<DeleteBlobResult> Delete(
        const DeleteBlobOptions& options = DeleteBlobOptions()) const;
 
    Azure::Core::Response<UndeleteBlobResult> Undelete(
        const UndeleteBlobOptions& options = UndeleteBlobOptions()) const;
 
    Azure::Core::Response<AcquireBlobLeaseResult> AcquireLease(
        const std::string& proposedLeaseId,
        int32_t duration,
        const AcquireBlobLeaseOptions& options = AcquireBlobLeaseOptions()) const;
 
    Azure::Core::Response<RenewBlobLeaseResult> RenewLease(
        const std::string& leaseId,
        const RenewBlobLeaseOptions& options = RenewBlobLeaseOptions()) const;
 
    Azure::Core::Response<ReleaseBlobLeaseResult> ReleaseLease(
        const std::string& leaseId,
        const ReleaseBlobLeaseOptions& options = ReleaseBlobLeaseOptions()) const;
 
    Azure::Core::Response<ChangeBlobLeaseResult> ChangeLease(
        const std::string& leaseId,
        const std::string& proposedLeaseId,
        const ChangeBlobLeaseOptions& options = ChangeBlobLeaseOptions()) const;
 
    Azure::Core::Response<BreakBlobLeaseResult> BreakLease(
        const BreakBlobLeaseOptions& options = BreakBlobLeaseOptions()) const;
 
    Azure::Core::Response<SetBlobTagsResult> SetTags(
        std::map<std::string, std::string> tags,
        const SetBlobTagsOptions& options = SetBlobTagsOptions()) const;
 
    Azure::Core::Response<GetBlobTagsResult> GetTags(
        const GetBlobTagsOptions& options = GetBlobTagsOptions()) const;
 
  protected:
    Azure::Core::Http::Url m_blobUrl;
    std::shared_ptr<Azure::Core::Http::HttpPipeline> m_pipeline;
    Azure::Core::Nullable<EncryptionKey> m_customerProvidedKey;
    Azure::Core::Nullable<std::string> m_encryptionScope;
 
  private:
    explicit BlobClient(
        Azure::Core::Http::Url blobUri,
        std::shared_ptr<Azure::Core::Http::HttpPipeline> pipeline,
        Azure::Core::Nullable<EncryptionKey> customerProvidedKey,
        Azure::Core::Nullable<std::string> encryptionScope)
        : m_blobUrl(std::move(blobUri)), m_pipeline(std::move(pipeline)),
          m_customerProvidedKey(std::move(customerProvidedKey)),
          m_encryptionScope(std::move(encryptionScope))
    {
    }
 
    friend class BlobContainerClient;
    friend class Files::DataLake::DirectoryClient;
    friend class Files::DataLake::FileClient;
  };
}}} // namespace Azure::Storage::Blobs