datalake_responses.hpp

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/storage/files/datalake/datalake_options.hpp"
 
#include <azure/storage/blobs/blob_responses.hpp>
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace Azure { namespace Storage { namespace Files { namespace DataLake {
 
  class DataLakeServiceClient;
  class DataLakeFileSystemClient;
  class DataLakePathClient;
  class DataLakeDirectoryClient;
 
  namespace Models {
 
    using LeaseDurationType = Blobs::Models::LeaseDurationType;
    using LeaseDuration [[deprecated]] = LeaseDurationType;
    using LeaseState = Blobs::Models::LeaseState;
    using LeaseStatus = Blobs::Models::LeaseStatus;
 
    // ServiceClient models:
 
    using UserDelegationKey = Blobs::Models::UserDelegationKey;
    using RetentionPolicy = Blobs::Models::RetentionPolicy;
    using AnalyticsLogging = Blobs::Models::AnalyticsLogging;
    using Metrics = Blobs::Models::Metrics;
    using CorsRule = Blobs::Models::CorsRule;
    using StaticWebsite = Blobs::Models::StaticWebsite;
    using DataLakeServiceProperties = Blobs::Models::BlobServiceProperties;
    using SetServicePropertiesResult = Blobs::Models::SetServicePropertiesResult;
 
    struct FileSystemItemDetails final
    {
      Azure::ETag ETag;
 
      Azure::DateTime LastModified;
 
      Storage::Metadata Metadata;
 
      PublicAccessType AccessType = PublicAccessType::None;
 
      bool HasImmutabilityPolicy = false;
 
      bool HasLegalHold = false;
 
      Azure::Nullable<Models::LeaseDurationType> LeaseDuration;
 
      Models::LeaseState LeaseState = Models::LeaseState::Available;
 
      Models::LeaseStatus LeaseStatus = Models::LeaseStatus::Unlocked;
 
      std::string DefaultEncryptionScope = "$account-encryption-key";
 
      bool PreventEncryptionScopeOverride = false;
    }; // struct FileSystemItemDetails
 
    struct FileSystemItem final
    {
      std::string Name;
 
      FileSystemItemDetails Details;
    }; // struct BlobContainerItem
 
    // FileSystemClient models:
 
    struct FileSystemAccessPolicy final
    {
      PublicAccessType AccessType = PublicAccessType::None;
 
      std::vector<SignedIdentifier> SignedIdentifiers;
    };
 
    using SetFileSystemAccessPolicyResult = Blobs::Models::SetBlobContainerAccessPolicyResult;
 
    struct FileSystemProperties final
    {
      Azure::ETag ETag;
 
      DateTime LastModified;
 
      Storage::Metadata Metadata;
 
      std::string DefaultEncryptionScope = "$account-encryption-key";
 
      bool PreventEncryptionScopeOverride = false;
    };
 
    struct CreateFileSystemResult final
    {
      bool Created = true;
 
      Azure::ETag ETag;
 
      DateTime LastModified;
    };
 
    struct DeleteFileSystemResult final
    {
      bool Deleted = true;
    };
 
    struct SetFileSystemMetadataResult final
    {
      Azure::ETag ETag;
 
      DateTime LastModified;
    };
 
    // PathClient models:
 
    using AcquireLeaseResult = Blobs::Models::AcquireLeaseResult;
    using RenewLeaseResult = Blobs::Models::RenewLeaseResult;
    using ReleaseLeaseResult = Blobs::Models::ReleaseLeaseResult;
    using ChangeLeaseResult = Blobs::Models::ChangeLeaseResult;
    using BreakLeaseResult = Blobs::Models::BreakLeaseResult;
    using RehydratePriority = Blobs::Models::RehydratePriority;
    using ArchiveStatus = Blobs::Models::ArchiveStatus;
 
    struct PathItem final
    {
      std::string Name;
 
      bool IsDirectory = false;
 
      DateTime LastModified;
 
      int64_t FileSize = int64_t();
 
      std::string Owner;
 
      std::string Group;
 
      std::string Permissions;
 
      Nullable<std::string> EncryptionScope;
 
      Nullable<std::string> EncryptionContext;
 
      Nullable<DateTime> CreatedOn;
 
      Nullable<DateTime> ExpiresOn;
 
      std::string ETag;
    };
 
    struct PathProperties final
    {
      Azure::ETag ETag;
 
      DateTime LastModified;
 
      DateTime CreatedOn;
 
      int64_t FileSize = 0;
 
      Storage::Metadata Metadata;
 
      Azure::Nullable<Models::LeaseDurationType> LeaseDuration;
 
      Azure::Nullable<Models::LeaseState> LeaseState;
 
      Azure::Nullable<Models::LeaseStatus> LeaseStatus;
 
      PathHttpHeaders HttpHeaders;
 
      Azure::Nullable<bool> IsServerEncrypted;
 
      Azure::Nullable<std::vector<uint8_t>> EncryptionKeySha256;
 
      Nullable<std::string> EncryptionScope;
 
      Nullable<std::string> EncryptionContext;
 
      Azure::Nullable<std::string> CopyId;
 
      Azure::Nullable<std::string> CopySource;
 
      Azure::Nullable<Blobs::Models::CopyStatus> CopyStatus;
 
      Azure::Nullable<std::string> CopyProgress;
 
      Azure::Nullable<DateTime> CopyCompletedOn;
 
      Azure::Nullable<DateTime> ExpiresOn;
 
      Azure::Nullable<DateTime> LastAccessedOn;
 
      bool IsDirectory = false;
 
      Azure::Nullable<Models::ArchiveStatus> ArchiveStatus;
 
      Azure::Nullable<Models::RehydratePriority> RehydratePriority;
 
      Azure::Nullable<std::string> CopyStatusDescription;
 
      Azure::Nullable<bool> IsIncrementalCopy;
 
      Azure::Nullable<std::string> IncrementalCopyDestinationSnapshot;
 
      Azure::Nullable<std::string> VersionId;
 
      Azure::Nullable<bool> IsCurrentVersion;
 
      Azure::Nullable<std::vector<Acl>> Acls;
 
      Azure::Nullable<std::string> Owner;
 
      Azure::Nullable<std::string> Group;
 
      Azure::Nullable<std::string> Permissions;
    };
 
    struct PathAccessControlList final
    {
      std::string Owner;
 
      std::string Group;
 
      std::string Permissions;
 
      std::vector<Acl> Acls;
    };
 
    struct SetPathHttpHeadersResult final
    {
      Azure::ETag ETag;
 
      DateTime LastModified;
    };
 
    struct SetPathMetadataResult final
    {
      Azure::ETag ETag;
 
      DateTime LastModified;
    };
 
    using SetPathPermissionsResult = SetPathAccessControlListResult;
 
    struct PathDeletedItem final
    {
      std::string Name;
 
      std::string DeletionId;
 
      DateTime DeletedOn;
 
      int64_t RemainingRetentionDays = int64_t();
    };
 
    // FileClient models:
 
    using UploadFileFromResult = Blobs::Models::UploadBlockBlobResult;
    using ScheduleFileDeletionResult = Blobs::Models::SetBlobExpiryResult;
    using CopyStatus = Blobs::Models::CopyStatus;
 
    struct QueryFileResult final
    {
      std::unique_ptr<Core::IO::BodyStream> BodyStream;
      DateTime LastModified;
      Azure::ETag ETag;
      Nullable<LeaseDurationType> LeaseDuration;
      Models::LeaseState LeaseState;
      Models::LeaseStatus LeaseStatus;
      bool IsServerEncrypted = bool();
    };
 
    struct DownloadFileDetails final
    {
      Azure::ETag ETag;
 
      DateTime LastModified;
 
      Azure::Nullable<Models::LeaseDurationType> LeaseDuration;
 
      Models::LeaseState LeaseState;
 
      Models::LeaseStatus LeaseStatus;
 
      PathHttpHeaders HttpHeaders;
 
      Storage::Metadata Metadata;
 
      DateTime CreatedOn;
 
      Azure::Nullable<DateTime> ExpiresOn;
 
      Azure::Nullable<DateTime> LastAccessedOn;
 
      Azure::Nullable<std::string> CopyId;
 
      Azure::Nullable<std::string> CopySource;
 
      Azure::Nullable<Models::CopyStatus> CopyStatus;
 
      Azure::Nullable<std::string> CopyStatusDescription;
 
      Azure::Nullable<std::string> CopyProgress;
 
      Azure::Nullable<Azure::DateTime> CopyCompletedOn;
 
      Azure::Nullable<std::string> VersionId;
 
      Azure::Nullable<bool> IsCurrentVersion;
 
      bool IsServerEncrypted = false;
 
      Azure::Nullable<std::vector<uint8_t>> EncryptionKeySha256;
 
      Azure::Nullable<std::string> EncryptionScope;
 
      Nullable<std::string> EncryptionContext;
 
      Azure::Nullable<std::vector<Acl>> Acls;
 
      Azure::Nullable<std::string> Owner;
 
      Azure::Nullable<std::string> Group;
 
      Azure::Nullable<std::string> Permissions;
    };
 
    struct DownloadFileResult final
    {
      std::unique_ptr<Azure::Core::IO::BodyStream> Body;
 
      int64_t FileSize = int64_t();
 
      Azure::Core::Http::HttpRange ContentRange;
 
      Azure::Nullable<Storage::ContentHash> TransactionalContentHash;
 
      DownloadFileDetails Details;
    };
 
    struct DownloadFileToResult final
    {
      int64_t FileSize = int64_t();
 
      Azure::Core::Http::HttpRange ContentRange;
 
      DownloadFileDetails Details;
    };
 
    using CreateFileResult = CreatePathResult;
    using DeleteFileResult = DeletePathResult;
 
    // DirectoryClient models:
 
    using CreateDirectoryResult = CreatePathResult;
    using DeleteDirectoryResult = DeletePathResult;
 
  } // namespace Models
 
  class ListFileSystemsPagedResponse final
      : public Azure::Core::PagedResponse<ListFileSystemsPagedResponse> {
  public:
    std::string ServiceEndpoint;
    std::string Prefix;
    std::vector<Models::FileSystemItem> FileSystems;
 
  private:
    void OnNextPage(const Azure::Core::Context& context);
 
    std::shared_ptr<DataLakeServiceClient> m_dataLakeServiceClient;
    ListFileSystemsOptions m_operationOptions;
 
    friend class DataLakeServiceClient;
    friend class Azure::Core::PagedResponse<ListFileSystemsPagedResponse>;
  };
 
  class ListPathsPagedResponse final : public Azure::Core::PagedResponse<ListPathsPagedResponse> {
  public:
    std::vector<Models::PathItem> Paths;
 
  private:
    void OnNextPage(const Azure::Core::Context& context);
 
    std::shared_ptr<DataLakeFileSystemClient> m_fileSystemClient;
    std::shared_ptr<DataLakeDirectoryClient> m_directoryClient;
    bool m_recursive = false;
    ListPathsOptions m_operationOptions;
 
    friend class DataLakeFileSystemClient;
    friend class DataLakeDirectoryClient;
    friend class Azure::Core::PagedResponse<ListPathsPagedResponse>;
  };
 
  class ListDeletedPathsPagedResponse final
      : public Azure::Core::PagedResponse<ListDeletedPathsPagedResponse> {
  public:
    std::vector<Models::PathDeletedItem> DeletedPaths;
 
  private:
    void OnNextPage(const Azure::Core::Context& context);
 
    std::shared_ptr<DataLakeFileSystemClient> m_fileSystemClient;
    ListDeletedPathsOptions m_operationOptions;
 
    friend class DataLakeFileSystemClient;
    friend class Azure::Core::PagedResponse<ListDeletedPathsPagedResponse>;
  };
 
  class SetPathAccessControlListRecursivePagedResponse final
      : public Azure::Core::PagedResponse<SetPathAccessControlListRecursivePagedResponse> {
  public:
    int32_t NumberOfSuccessfulDirectories = 0;
    int32_t NumberOfSuccessfulFiles = 0;
    int32_t NumberOfFailures = 0;
    std::vector<Models::AclFailedEntry> FailedEntries;
 
  private:
    void OnNextPage(const Azure::Core::Context& context);
 
    std::shared_ptr<DataLakePathClient> m_dataLakePathClient;
    SetPathAccessControlListRecursiveOptions m_operationOptions;
    std::vector<Models::Acl> m_acls;
    Models::_detail::PathSetAccessControlListRecursiveMode m_mode;
 
    friend class DataLakePathClient;
    friend class Azure::Core::PagedResponse<SetPathAccessControlListRecursivePagedResponse>;
  };
 
  using UpdatePathAccessControlListRecursivePagedResponse
      = SetPathAccessControlListRecursivePagedResponse;
  using RemovePathAccessControlListRecursivePagedResponse
      = SetPathAccessControlListRecursivePagedResponse;
 
}}}} // namespace Azure::Storage::Files::DataLake