blob_client.hpp

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <cstdint>
#include <map>
#include <memory>
#include <string>
 
#include <azure/core/credentials/credentials.hpp>
#include <azure/storage/common/storage_credential.hpp>
 
#include "azure/storage/blobs/blob_options.hpp"
#include "azure/storage/blobs/blob_responses.hpp"
#include "azure/storage/blobs/protocol/blob_rest_client.hpp"
 
namespace Azure { namespace Storage { namespace Files { namespace DataLake {
  class DataLakeFileSystemClient;
  class DataLakeDirectoryClient;
  class DataLakeFileClient;
}}}} // namespace Azure::Storage::Files::DataLake
 
namespace Azure { namespace Storage { namespace Blobs {
 
  class BlockBlobClient;
  class AppendBlobClient;
  class PageBlobClient;
  class BlobLeaseClient;
 
  class BlobClient {
  public:
    virtual ~BlobClient() = default;
 
    static BlobClient CreateFromConnectionString(
        const std::string& connectionString,
        const std::string& blobContainerName,
        const std::string& blobName,
        const BlobClientOptions& options = BlobClientOptions());
 
    explicit BlobClient(
        const std::string& blobUrl,
        std::shared_ptr<StorageSharedKeyCredential> credential,
        const BlobClientOptions& options = BlobClientOptions());
 
    explicit BlobClient(
        const std::string& blobUrl,
        std::shared_ptr<Core::Credentials::TokenCredential> credential,
        const BlobClientOptions& options = BlobClientOptions());
 
    explicit BlobClient(
        const std::string& blobUrl,
        const BlobClientOptions& options = BlobClientOptions());
 
    BlockBlobClient AsBlockBlobClient() const;
 
    AppendBlobClient AsAppendBlobClient() const;
 
    PageBlobClient AsPageBlobClient() const;
 
    std::string GetUrl() const { return m_blobUrl.GetAbsoluteUrl(); }
 
    BlobClient WithSnapshot(const std::string& snapshot) const;
 
    BlobClient WithVersionId(const std::string& versionId) const;
 
    Azure::Response<Models::BlobProperties> GetProperties(
        const GetBlobPropertiesOptions& options = GetBlobPropertiesOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetBlobHttpHeadersResult> SetHttpHeaders(
        Models::BlobHttpHeaders httpHeaders,
        const SetBlobHttpHeadersOptions& options = SetBlobHttpHeadersOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetBlobMetadataResult> SetMetadata(
        Metadata metadata,
        const SetBlobMetadataOptions& options = SetBlobMetadataOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetBlobAccessTierResult> SetAccessTier(
        Models::AccessTier accessTier,
        const SetBlobAccessTierOptions& options = SetBlobAccessTierOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    StartBlobCopyOperation StartCopyFromUri(
        const std::string& sourceUri,
        const StartBlobCopyFromUriOptions& options = StartBlobCopyFromUriOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::AbortBlobCopyFromUriResult> AbortCopyFromUri(
        const std::string& copyId,
        const AbortBlobCopyFromUriOptions& options = AbortBlobCopyFromUriOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DownloadBlobResult> Download(
        const DownloadBlobOptions& options = DownloadBlobOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DownloadBlobToResult> DownloadTo(
        uint8_t* buffer,
        size_t bufferSize,
        const DownloadBlobToOptions& options = DownloadBlobToOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DownloadBlobToResult> DownloadTo(
        const std::string& fileName,
        const DownloadBlobToOptions& options = DownloadBlobToOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::CreateBlobSnapshotResult> CreateSnapshot(
        const CreateBlobSnapshotOptions& options = CreateBlobSnapshotOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DeleteBlobResult> Delete(
        const DeleteBlobOptions& options = DeleteBlobOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DeleteBlobResult> DeleteIfExists(
        const DeleteBlobOptions& options = DeleteBlobOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::UndeleteBlobResult> Undelete(
        const UndeleteBlobOptions& options = UndeleteBlobOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetBlobTagsResult> SetTags(
        std::map<std::string, std::string> tags,
        const SetBlobTagsOptions& options = SetBlobTagsOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<std::map<std::string, std::string>> GetTags(
        const GetBlobTagsOptions& options = GetBlobTagsOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
  protected:
    Azure::Core::Url m_blobUrl;
    std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> m_pipeline;
    Azure::Nullable<EncryptionKey> m_customerProvidedKey;
    Azure::Nullable<std::string> m_encryptionScope;
 
  private:
    explicit BlobClient(
        Azure::Core::Url blobUrl,
        std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> pipeline,
        Azure::Nullable<EncryptionKey> customerProvidedKey = Azure::Nullable<EncryptionKey>(),
        Azure::Nullable<std::string> encryptionScope = Azure::Nullable<std::string>())
        : m_blobUrl(std::move(blobUrl)), m_pipeline(std::move(pipeline)),
          m_customerProvidedKey(std::move(customerProvidedKey)),
          m_encryptionScope(std::move(encryptionScope))
    {
    }
 
    friend class BlobContainerClient;
    friend class Files::DataLake::DataLakeFileSystemClient;
    friend class Files::DataLake::DataLakeDirectoryClient;
    friend class Files::DataLake::DataLakeFileClient;
    friend class BlobLeaseClient;
  };
}}} // namespace Azure::Storage::Blobs