datalake_path_client.hpp

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/storage/files/datalake/datalake_file_system_client.hpp"
#include "azure/storage/files/datalake/datalake_options.hpp"
#include "azure/storage/files/datalake/datalake_responses.hpp"
 
#include <azure/core/credentials/credentials.hpp>
#include <azure/core/internal/http/pipeline.hpp>
#include <azure/core/response.hpp>
#include <azure/storage/blobs/blob_client.hpp>
#include <azure/storage/common/storage_credential.hpp>
 
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
namespace Azure { namespace Storage { namespace Files { namespace DataLake {
 
  class DataLakePathClient {
  public:
    virtual ~DataLakePathClient() = default;
 
    static DataLakePathClient CreateFromConnectionString(
        const std::string& connectionString,
        const std::string& fileSystemName,
        const std::string& path,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    explicit DataLakePathClient(
        const std::string& pathUrl,
        std::shared_ptr<StorageSharedKeyCredential> credential,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    explicit DataLakePathClient(
        const std::string& pathUrl,
        std::shared_ptr<const Core::Credentials::TokenCredential> credential,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    explicit DataLakePathClient(
        const std::string& pathUrl,
        const DataLakeClientOptions& options = DataLakeClientOptions());
 
    std::string GetUrl() const { return m_blobClient.GetUrl(); }
 
    Azure::Response<Models::CreatePathResult> Create(
        Models::PathResourceType type,
        const CreatePathOptions& options = CreatePathOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::CreatePathResult> CreateIfNotExists(
        Models::PathResourceType type,
        const CreatePathOptions& options = CreatePathOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DeletePathResult> Delete(
        const DeletePathOptions& options = DeletePathOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::DeletePathResult> DeleteIfExists(
        const DeletePathOptions& options = DeletePathOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetPathAccessControlListResult> SetAccessControlList(
        std::vector<Models::Acl> acls,
        const SetPathAccessControlListOptions& options = SetPathAccessControlListOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetPathPermissionsResult> SetPermissions(
        std::string permissions,
        const SetPathPermissionsOptions& options = SetPathPermissionsOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetPathHttpHeadersResult> SetHttpHeaders(
        Models::PathHttpHeaders httpHeaders,
        const SetPathHttpHeadersOptions& options = SetPathHttpHeadersOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::PathProperties> GetProperties(
        const GetPathPropertiesOptions& options = GetPathPropertiesOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::PathAccessControlList> GetAccessControlList(
        const GetPathAccessControlListOptions& options = GetPathAccessControlListOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    Azure::Response<Models::SetPathMetadataResult> SetMetadata(
        Storage::Metadata metadata,
        const SetPathMetadataOptions& options = SetPathMetadataOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const;
 
    SetPathAccessControlListRecursivePagedResponse SetAccessControlListRecursive(
        const std::vector<Models::Acl>& acls,
        const SetPathAccessControlListRecursiveOptions& options
        = SetPathAccessControlListRecursiveOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const
    {
      return SetAccessControlListRecursiveInternal(
          Models::_detail::PathSetAccessControlListRecursiveMode::Set, acls, options, context);
    }
 
    UpdatePathAccessControlListRecursivePagedResponse UpdateAccessControlListRecursive(
        const std::vector<Models::Acl>& acls,
        const UpdatePathAccessControlListRecursiveOptions& options
        = UpdatePathAccessControlListRecursiveOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const
    {
      return SetAccessControlListRecursiveInternal(
          Models::_detail::PathSetAccessControlListRecursiveMode::Modify, acls, options, context);
    }
 
    RemovePathAccessControlListRecursivePagedResponse RemoveAccessControlListRecursive(
        const std::vector<Models::Acl>& acls,
        const RemovePathAccessControlListRecursiveOptions& options
        = RemovePathAccessControlListRecursiveOptions(),
        const Azure::Core::Context& context = Azure::Core::Context()) const
    {
      return SetAccessControlListRecursiveInternal(
          Models::_detail::PathSetAccessControlListRecursiveMode::Remove, acls, options, context);
    }
 
  protected:
    Azure::Core::Url m_pathUrl;
 
    Blobs::BlobClient m_blobClient;
 
    std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> m_pipeline;
 
    _detail::DatalakeClientConfiguration m_clientConfiguration;
 
    explicit DataLakePathClient(
        Azure::Core::Url pathUrl,
        Blobs::BlobClient blobClient,
        std::shared_ptr<Azure::Core::Http::_internal::HttpPipeline> pipeline,
        _detail::DatalakeClientConfiguration clientConfiguration)
        : m_pathUrl(std::move(pathUrl)), m_blobClient(std::move(blobClient)),
          m_pipeline(std::move(pipeline)), m_clientConfiguration(std::move(clientConfiguration))
    {
    }
 
  private:
    SetPathAccessControlListRecursivePagedResponse SetAccessControlListRecursiveInternal(
        Models::_detail::PathSetAccessControlListRecursiveMode mode,
        const std::vector<Models::Acl>& acls,
        const SetPathAccessControlListRecursiveOptions& options,
        const Azure::Core::Context& context) const;
 
    friend class DataLakeFileSystemClient;
    friend class DataLakeLeaseClient;
  };
}}}} // namespace Azure::Storage::Files::DataLake