blob_container_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_client.hpp"
#include "azure/storage/blobs/blob_options.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 Blobs {
 
  class BlobContainerClient {
  public:
    static BlobContainerClient CreateFromConnectionString(
        const std::string& connectionString,
        const std::string& containerName,
        const BlobContainerClientOptions& options = BlobContainerClientOptions());
 
    explicit BlobContainerClient(
        const std::string& containerUri,
        std::shared_ptr<SharedKeyCredential> credential,
        const BlobContainerClientOptions& options = BlobContainerClientOptions());
 
    explicit BlobContainerClient(
        const std::string& containerUri,
        std::shared_ptr<Core::Credentials::ClientSecretCredential> credential,
        const BlobContainerClientOptions& options = BlobContainerClientOptions());
 
    explicit BlobContainerClient(
        const std::string& containerUri,
        const BlobContainerClientOptions& options = BlobContainerClientOptions());
 
    BlobClient GetBlobClient(const std::string& blobName) const;
 
    BlockBlobClient GetBlockBlobClient(const std::string& blobName) const;
 
    AppendBlobClient GetAppendBlobClient(const std::string& blobName) const;
 
    PageBlobClient GetPageBlobClient(const std::string& blobName) const;
 
    std::string GetUri() const { return m_containerUrl.GetAbsoluteUrl(); }
 
    Azure::Core::Response<CreateContainerResult> Create(
        const CreateContainerOptions& options = CreateContainerOptions()) const;
 
    Azure::Core::Response<DeleteContainerResult> Delete(
        const DeleteContainerOptions& options = DeleteContainerOptions()) const;
 
    Azure::Core::Response<UndeleteContainerResult> Undelete(
        const std::string& deletedContainerName,
        const std::string& deletedContainerVersion,
        const UndeleteContainerOptions& options = UndeleteContainerOptions()) const;
 
    Azure::Core::Response<GetContainerPropertiesResult> GetProperties(
        const GetContainerPropertiesOptions& options = GetContainerPropertiesOptions()) const;
 
    Azure::Core::Response<SetContainerMetadataResult> SetMetadata(
        std::map<std::string, std::string> metadata,
        SetContainerMetadataOptions options = SetContainerMetadataOptions()) const;
 
    Azure::Core::Response<ListBlobsFlatSegmentResult> ListBlobsFlatSegment(
        const ListBlobsSegmentOptions& options = ListBlobsSegmentOptions()) const;
 
    Azure::Core::Response<ListBlobsByHierarchySegmentResult> ListBlobsByHierarchySegment(
        const std::string& delimiter,
        const ListBlobsSegmentOptions& options = ListBlobsSegmentOptions()) const;
 
    Azure::Core::Response<GetContainerAccessPolicyResult> GetAccessPolicy(
        const GetContainerAccessPolicyOptions& options = GetContainerAccessPolicyOptions()) const;
 
    Azure::Core::Response<SetContainerAccessPolicyResult> SetAccessPolicy(
        const SetContainerAccessPolicyOptions& options = SetContainerAccessPolicyOptions()) const;
 
    Azure::Core::Response<AcquireContainerLeaseResult> AcquireLease(
        const std::string& proposedLeaseId,
        int32_t duration,
        const AcquireContainerLeaseOptions& options = AcquireContainerLeaseOptions()) const;
 
    Azure::Core::Response<RenewContainerLeaseResult> RenewLease(
        const std::string& leaseId,
        const RenewContainerLeaseOptions& options = RenewContainerLeaseOptions()) const;
 
    Azure::Core::Response<ReleaseContainerLeaseResult> ReleaseLease(
        const std::string& leaseId,
        const ReleaseContainerLeaseOptions& options = ReleaseContainerLeaseOptions()) const;
 
    Azure::Core::Response<ChangeContainerLeaseResult> ChangeLease(
        const std::string& leaseId,
        const std::string& proposedLeaseId,
        const ChangeContainerLeaseOptions& options = ChangeContainerLeaseOptions()) const;
 
    Azure::Core::Response<BreakContainerLeaseResult> BreakLease(
        const BreakContainerLeaseOptions& options = BreakContainerLeaseOptions()) const;
 
  protected:
    Azure::Core::Http::Url m_containerUrl;
    std::shared_ptr<Azure::Core::Http::HttpPipeline> m_pipeline;
    Azure::Core::Nullable<EncryptionKey> m_customerProvidedKey;
    Azure::Core::Nullable<std::string> m_encryptionScope;
 
  private:
    explicit BlobContainerClient(
        Azure::Core::Http::Url containerUri,
        std::shared_ptr<Azure::Core::Http::HttpPipeline> pipeline)
        : m_containerUrl(std::move(containerUri)), m_pipeline(std::move(pipeline))
    {
    }
 
    friend class BlobServiceClient;
  };
 
}}} // namespace Azure::Storage::Blobs