blob_responses.hpp

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <cstdint>
#include <string>
#include <thread>
#include <vector>
 
#include <azure/core/operation.hpp>
#include <azure/core/paged_response.hpp>
 
#include "azure/storage/blobs/blob_options.hpp"
#include "azure/storage/blobs/protocol/blob_rest_client.hpp"
 
namespace Azure { namespace Storage {
 
  namespace Files { namespace DataLake {
    class ListFileSystemsPagedResponse;
  }} // namespace Files::DataLake
 
  namespace Blobs {
 
    class BlobServiceClient;
    class BlobContainerClient;
    class BlobClient;
    class PageBlobClient;
 
    namespace Models {
 
      struct DownloadBlobToResult final
      {
        Models::BlobType BlobType;
 
        Azure::Core::Http::HttpRange ContentRange;
 
        int64_t BlobSize = 0;
 
        Azure::Nullable<ContentHash> TransactionalContentHash;
 
        DownloadBlobDetails Details;
      };
 
      using UploadBlockBlobFromResult = UploadBlockBlobResult;
 
      struct AcquireLeaseResult final
      {
        Azure::ETag ETag;
 
        Azure::DateTime LastModified;
 
        std::string LeaseId;
      };
 
      struct BreakLeaseResult final
      {
        Azure::ETag ETag;
 
        Azure::DateTime LastModified;
      };
 
      struct ChangeLeaseResult final
      {
        Azure::ETag ETag;
 
        Azure::DateTime LastModified;
 
        std::string LeaseId;
      };
 
      struct ReleaseLeaseResult final
      {
        Azure::ETag ETag;
 
        Azure::DateTime LastModified;
      };
 
      struct RenewLeaseResult final
      {
        Azure::ETag ETag;
 
        Azure::DateTime LastModified;
 
        std::string LeaseId;
      };
 
    } // namespace Models
 
    class StartBlobCopyOperation final : public Azure::Core::Operation<Models::BlobProperties> {
    public:
      Models::BlobProperties Value() const override { return m_pollResult; }
 
      StartBlobCopyOperation() = default;
 
      StartBlobCopyOperation(StartBlobCopyOperation&&) = default;
 
      StartBlobCopyOperation& operator=(StartBlobCopyOperation&&) = default;
 
      ~StartBlobCopyOperation() override {}
 
    private:
      std::string GetResumeToken() const override { AZURE_NOT_IMPLEMENTED(); }
 
      std::unique_ptr<Azure::Core::Http::RawResponse> PollInternal(
          const Azure::Core::Context& context) override;
 
      Azure::Response<Models::BlobProperties> PollUntilDoneInternal(
          std::chrono::milliseconds period,
          Azure::Core::Context& context) override;
 
      Azure::Core::Http::RawResponse const& GetRawResponseInternal() const override
      {
        return *m_rawResponse;
      }
 
      std::shared_ptr<BlobClient> m_blobClient;
      Models::BlobProperties m_pollResult;
 
      friend class Blobs::BlobClient;
      friend class Blobs::PageBlobClient;
    };
 
    class ListBlobContainersPagedResponse final
        : public Azure::Core::PagedResponse<ListBlobContainersPagedResponse> {
    public:
      std::string ServiceEndpoint;
 
      std::string Prefix;
 
      std::vector<Models::BlobContainerItem> BlobContainers;
 
    private:
      void OnNextPage(const Azure::Core::Context& context);
 
      std::shared_ptr<BlobServiceClient> m_blobServiceClient;
      ListBlobContainersOptions m_operationOptions;
 
      friend class BlobServiceClient;
      friend class Azure::Core::PagedResponse<ListBlobContainersPagedResponse>;
      friend class Files::DataLake::ListFileSystemsPagedResponse;
    };
 
    class FindBlobsByTagsPagedResponse final
        : public Azure::Core::PagedResponse<FindBlobsByTagsPagedResponse> {
    public:
      std::string ServiceEndpoint;
 
      std::vector<Models::TaggedBlobItem> TaggedBlobs;
 
    private:
      void OnNextPage(const Azure::Core::Context& context);
 
      std::shared_ptr<BlobServiceClient> m_blobServiceClient;
      FindBlobsByTagsOptions m_operationOptions;
      std::string m_tagFilterSqlExpression;
 
      friend class BlobServiceClient;
      friend class Azure::Core::PagedResponse<FindBlobsByTagsPagedResponse>;
    };
 
    class ListBlobsPagedResponse final : public Azure::Core::PagedResponse<ListBlobsPagedResponse> {
    public:
      std::string ServiceEndpoint;
 
      std::string BlobContainerName;
 
      std::string Prefix;
 
      std::vector<Models::BlobItem> Blobs;
 
    private:
      void OnNextPage(const Azure::Core::Context& context);
 
      std::shared_ptr<BlobContainerClient> m_blobContainerClient;
      ListBlobsOptions m_operationOptions;
 
      friend class BlobContainerClient;
      friend class Azure::Core::PagedResponse<ListBlobsPagedResponse>;
    };
 
    class ListBlobsByHierarchyPagedResponse final
        : public Azure::Core::PagedResponse<ListBlobsByHierarchyPagedResponse> {
    public:
      std::string ServiceEndpoint;
 
      std::string BlobContainerName;
 
      std::string Prefix;
 
      std::string Delimiter;
 
      std::vector<Models::BlobItem> Blobs;
 
      std::vector<std::string> BlobPrefixes;
 
    private:
      void OnNextPage(const Azure::Core::Context& context);
 
      std::shared_ptr<BlobContainerClient> m_blobContainerClient;
      ListBlobsOptions m_operationOptions;
      std::string m_delimiter;
 
      friend class BlobContainerClient;
      friend class Azure::Core::PagedResponse<ListBlobsByHierarchyPagedResponse>;
    };
 
    class GetPageRangesPagedResponse final
        : public Azure::Core::PagedResponse<GetPageRangesPagedResponse> {
    public:
      Azure::ETag ETag;
 
      Azure::DateTime LastModified;
 
      int64_t BlobSize = 0;
 
      std::vector<Azure::Core::Http::HttpRange> PageRanges;
 
    private:
      void OnNextPage(const Azure::Core::Context& context);
 
      std::shared_ptr<PageBlobClient> m_pageBlobClient;
      GetPageRangesOptions m_operationOptions;
 
      friend class PageBlobClient;
      friend class Azure::Core::PagedResponse<GetPageRangesPagedResponse>;
    };
 
    class GetPageRangesDiffPagedResponse final
        : public Azure::Core::PagedResponse<GetPageRangesDiffPagedResponse> {
    public:
      Azure::ETag ETag;
 
      Azure::DateTime LastModified;
 
      int64_t BlobSize = 0;
 
      std::vector<Azure::Core::Http::HttpRange> PageRanges;
 
      std::vector<Azure::Core::Http::HttpRange> ClearRanges;
 
    private:
      void OnNextPage(const Azure::Core::Context& context);
 
      std::shared_ptr<PageBlobClient> m_pageBlobClient;
      GetPageRangesOptions m_operationOptions;
      Azure::Nullable<std::string> m_previousSnapshot;
      Azure::Nullable<std::string> m_previousSnapshotUrl;
 
      friend class PageBlobClient;
      friend class Azure::Core::PagedResponse<GetPageRangesDiffPagedResponse>;
    };
 
  } // namespace Blobs
}} // namespace Azure::Storage