share_options.hpp

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
 
#pragma once
 
#include "azure/storage/files/shares/rest_client.hpp"
 
#include <azure/core/internal/client_options.hpp>
#include <azure/core/internal/extendable_enumeration.hpp>
#include <azure/core/nullable.hpp>
#include <azure/storage/common/access_conditions.hpp>
 
#include <memory>
#include <string>
#include <vector>
 
/* cSpell:ignore dacl */
 
namespace Azure { namespace Storage { namespace Files { namespace Shares {
 
  namespace Models {
    enum class RolePermissions
    {
      /*
       * @brief No permissions.
       */
      None = 0,
 
      /*
       * @brief The execute permission.
       */
      Execute = 1,
 
      /*
       * @brief The write permission.
       */
      Write = 2,
 
      /*
       * @brief The read permission.
       */
      Read = 4,
    };
 
    inline RolePermissions operator|(const RolePermissions& lhs, const RolePermissions& rhs)
    {
      using type = std::underlying_type_t<RolePermissions>;
      return static_cast<RolePermissions>(static_cast<type>(lhs) | static_cast<type>(rhs));
    }
 
    inline RolePermissions operator&(const RolePermissions& lhs, const RolePermissions& rhs)
    {
      using type = std::underlying_type_t<RolePermissions>;
      return static_cast<RolePermissions>(static_cast<type>(lhs) & static_cast<type>(rhs));
    }
 
    struct NfsFileMode final
    {
      RolePermissions Owner;
 
      RolePermissions Group;
 
      RolePermissions Other;
 
      bool EffectiveUserIdentity = false;
 
      bool EffectiveGroupIdentity = false;
 
      bool StickyBit = false;
 
      std::string ToOctalFileMode() const;
 
      std::string ToSymbolicFileMode() const;
 
      static NfsFileMode ParseOctalFileMode(const std::string& modeString);
 
      static NfsFileMode ParseSymbolicFileMode(const std::string& modeString);
    };
 
    struct FilePosixProperties final
    {
      Nullable<NfsFileMode> FileMode;
 
      Nullable<std::string> Owner;
 
      Nullable<std::string> Group;
 
      Nullable<Models::NfsFileType> NfsFileType;
 
      Nullable<std::int64_t> LinkCount;
    };
  } // namespace Models
 
  enum class CopyableFileSmbPropertyFlags
  {
    None = 0,
 
    FileAttributes = 1,
 
    CreatedOn = 2,
 
    LastWrittenOn = 4,
 
    ChangedOn = 8,
 
    Permission = 16,
 
    All = ~None
  };
 
  inline CopyableFileSmbPropertyFlags operator|(
      CopyableFileSmbPropertyFlags lhs,
      CopyableFileSmbPropertyFlags rhs)
  {
    using type = std::underlying_type_t<CopyableFileSmbPropertyFlags>;
    return static_cast<CopyableFileSmbPropertyFlags>(
        static_cast<type>(lhs) | static_cast<type>(rhs));
  }
  inline CopyableFileSmbPropertyFlags& operator|=(
      CopyableFileSmbPropertyFlags& lhs,
      CopyableFileSmbPropertyFlags rhs)
  {
    lhs = lhs | rhs;
    return lhs;
  }
  inline CopyableFileSmbPropertyFlags operator&(
      CopyableFileSmbPropertyFlags lhs,
      CopyableFileSmbPropertyFlags rhs)
  {
    using type = std::underlying_type_t<CopyableFileSmbPropertyFlags>;
    return static_cast<CopyableFileSmbPropertyFlags>(
        static_cast<type>(lhs) & static_cast<type>(rhs));
  }
  inline CopyableFileSmbPropertyFlags& operator&=(
      CopyableFileSmbPropertyFlags& lhs,
      CopyableFileSmbPropertyFlags rhs)
  {
    lhs = lhs & rhs;
    return lhs;
  }
 
  class ShareAudience final : public Azure::Core::_internal::ExtendableEnumeration<ShareAudience> {
  public:
    explicit ShareAudience(std::string shareAudience)
        : ExtendableEnumeration(std::move(shareAudience))
    {
    }
 
    static ShareAudience CreateShareServiceAccountAudience(const std::string& storageAccountName)
    {
      return ShareAudience("https://" + storageAccountName + ".file.core.windows.net/");
    }
 
    AZ_STORAGE_FILES_SHARES_DLLEXPORT const static ShareAudience DefaultAudience;
  };
 
  struct ShareClientOptions final : Azure::Core::_internal::ClientOptions
  {
    std::string ApiVersion;
 
    Nullable<bool> AllowTrailingDot;
 
    Nullable<bool> AllowSourceTrailingDot;
 
    Nullable<Models::ShareTokenIntent> ShareTokenIntent;
 
    Azure::Nullable<ShareAudience> Audience;
  };
 
  struct ListSharesOptions final
  {
    Azure::Nullable<std::string> Prefix;
 
    Azure::Nullable<std::string> ContinuationToken;
 
    Azure::Nullable<int32_t> PageSizeHint;
 
    Azure::Nullable<Models::ListSharesIncludeFlags> ListSharesIncludeFlags;
  };
 
  struct SetServicePropertiesOptions final
  {
  };
 
  struct GetServicePropertiesOptions final
  {
  };
 
  struct CreateShareOptions final
  {
    Storage::Metadata Metadata;
 
    Azure::Nullable<Models::AccessTier> AccessTier;
 
    Azure::Nullable<int64_t> ShareQuotaInGiB;
 
    Azure::Nullable<Models::ShareProtocols> EnabledProtocols;
 
    Azure::Nullable<Models::ShareRootSquash> RootSquash;
 
    Nullable<bool> EnableSnapshotVirtualDirectoryAccess;
 
    Nullable<bool> EnablePaidBursting;
 
    Nullable<std::int64_t> PaidBurstingMaxIops;
 
    Nullable<std::int64_t> PaidBurstingMaxBandwidthMibps;
 
    Nullable<std::int64_t> ProvisionedMaxIops;
 
    Nullable<std::int64_t> ProvisionedMaxBandwidthMibps;
  };
 
  struct DeleteShareOptions final
  {
    Azure::Nullable<bool> DeleteSnapshots;
  };
 
  struct CreateShareSnapshotOptions final
  {
    Storage::Metadata Metadata;
  };
 
  struct GetSharePropertiesOptions final
  {
  };
 
  struct SetSharePropertiesOptions final
  {
    Azure::Nullable<Models::AccessTier> AccessTier;
 
    Azure::Nullable<int64_t> ShareQuotaInGiB;
 
    Azure::Nullable<Models::ShareRootSquash> RootSquash;
 
    Nullable<bool> EnableSnapshotVirtualDirectoryAccess;
 
    Nullable<bool> EnablePaidBursting;
 
    Nullable<std::int64_t> PaidBurstingMaxIops;
 
    Nullable<std::int64_t> PaidBurstingMaxBandwidthMibps;
 
    Nullable<std::int64_t> ProvisionedMaxIops;
 
    Nullable<std::int64_t> ProvisionedMaxBandwidthMibps;
  };
 
  struct SetShareMetadataOptions final
  {
  };
 
  struct GetShareAccessPolicyOptions final
  {
  };
 
  struct SetShareAccessPolicyOptions final
  {
  };
 
  struct GetShareStatisticsOptions final
  {
  };
 
  struct CreateSharePermissionOptions final
  {
    Nullable<Models::FilePermissionFormat> FilePermissionFormat;
  };
 
  struct GetSharePermissionOptions final
  {
    Nullable<Models::FilePermissionFormat> FilePermissionFormat;
  };
 
  struct CreateDirectoryOptions final
  {
    Storage::Metadata Metadata;
 
    Azure::Nullable<std::string> DirectoryPermission;
 
    Nullable<Models::FilePermissionFormat> DirectoryPermissionFormat;
 
    Models::FileSmbProperties SmbProperties;
 
    Models::FilePosixProperties PosixProperties;
  };
 
  struct RenameFileOptions final
  {
    Azure::Nullable<bool> ReplaceIfExists;
 
    Azure::Nullable<bool> IgnoreReadOnly;
 
    LeaseAccessConditions AccessConditions;
 
    LeaseAccessConditions SourceAccessConditions;
 
    Models::FileSmbProperties SmbProperties;
 
    Azure::Nullable<std::string> FilePermission;
 
    Nullable<Models ::FilePermissionFormat> FilePermissionFormat;
 
    Storage::Metadata Metadata;
 
    Azure::Nullable<std::string> ContentType;
  };
 
  struct RenameDirectoryOptions final
  {
    Azure::Nullable<bool> ReplaceIfExists;
 
    Azure::Nullable<bool> IgnoreReadOnly;
 
    LeaseAccessConditions AccessConditions;
 
    LeaseAccessConditions SourceAccessConditions;
 
    Models::FileSmbProperties SmbProperties;
 
    Azure::Nullable<std::string> FilePermission;
 
    Nullable<Models ::FilePermissionFormat> FilePermissionFormat;
 
    Storage::Metadata Metadata;
  };
 
  struct DeleteDirectoryOptions final
  {
  };
 
  struct GetDirectoryPropertiesOptions final
  {
  };
 
  struct SetDirectoryPropertiesOptions final
  {
    Azure::Nullable<std::string> FilePermission;
 
    Nullable<Models ::FilePermissionFormat> FilePermissionFormat;
 
    Models::FilePosixProperties PosixProperties;
  };
 
  struct SetDirectoryMetadataOptions final
  {
  };
 
  struct ListFilesAndDirectoriesOptions final
  {
    Azure::Nullable<std::string> Prefix;
 
    Azure::Nullable<std::string> ContinuationToken;
 
    Azure::Nullable<int32_t> PageSizeHint;
 
    Models::ListFilesIncludeFlags Include = Models::ListFilesIncludeFlags ::None;
 
    Nullable<bool> IncludeExtendedInfo;
  };
 
  struct ListDirectoryHandlesOptions final
  {
    Azure::Nullable<std::string> ContinuationToken;
 
    Azure::Nullable<int32_t> PageSizeHint;
 
    Azure::Nullable<bool> Recursive;
  };
 
  struct ForceCloseDirectoryHandleOptions final
  {
  };
 
  struct ForceCloseAllDirectoryHandlesOptions final
  {
    Azure::Nullable<std::string> ContinuationToken;
 
    Azure::Nullable<bool> Recursive;
  };
 
  struct CreateFileOptions final
  {
    Azure::Nullable<std::string> Permission;
 
    Nullable<Models ::FilePermissionFormat> FilePermissionFormat;
 
    Models::FileSmbProperties SmbProperties;
 
    Models::FileHttpHeaders HttpHeaders;
 
    Storage::Metadata Metadata;
 
    LeaseAccessConditions AccessConditions;
 
    Models::FilePosixProperties PosixProperties;
  };
 
  struct DeleteFileOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct DownloadFileOptions final
  {
    Azure::Nullable<Core::Http::HttpRange> Range;
 
    Azure::Nullable<HashAlgorithm> RangeHashAlgorithm;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct StartFileCopyOptions final
  {
    Storage::Metadata Metadata;
 
    Azure::Nullable<std::string> Permission;
 
    Nullable<Models ::FilePermissionFormat> FilePermissionFormat;
 
    Models::FileSmbProperties SmbProperties;
 
    Azure::Nullable<Models::PermissionCopyMode> PermissionCopyMode;
 
    Azure::Nullable<CopyableFileSmbPropertyFlags> SmbPropertiesToCopy;
 
    Azure::Nullable<bool> IgnoreReadOnly;
 
    Azure::Nullable<bool> SetArchiveAttribute;
 
    LeaseAccessConditions AccessConditions;
 
    Models::FilePosixProperties PosixProperties;
 
    Azure::Nullable<Models::ModeCopyMode> ModeCopyMode;
 
    Azure::Nullable<Models::OwnerCopyMode> OwnerCopyMode;
  };
 
  struct AbortFileCopyOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct GetFilePropertiesOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct SetFilePropertiesOptions final
  {
    Azure::Nullable<std::string> Permission;
 
    Nullable<Models ::FilePermissionFormat> FilePermissionFormat;
 
    Azure::Nullable<int64_t> Size;
 
    LeaseAccessConditions AccessConditions;
 
    Models::FilePosixProperties PosixProperties;
  };
 
  struct SetFileMetadataOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct UploadFileRangeOptions final
  {
    Azure::Nullable<ContentHash> TransactionalContentHash;
 
    LeaseAccessConditions AccessConditions;
 
    Azure::Nullable<Models::FileLastWrittenMode> FileLastWrittenMode;
  };
 
  struct ClearFileRangeOptions final
  {
    LeaseAccessConditions AccessConditions;
 
    Azure::Nullable<Models::FileLastWrittenMode> FileLastWrittenMode;
  };
 
  struct UploadFileRangeFromUriOptions final
  {
    Azure::Nullable<ContentHash> TransactionalContentHash;
 
    ContentHashAccessConditions SourceAccessCondition;
 
    LeaseAccessConditions AccessConditions;
 
    Azure::Nullable<Models::FileLastWrittenMode> FileLastWrittenMode;
 
    std::string SourceAuthorization;
  };
 
  struct GetFileRangeListOptions final
  {
    Azure::Nullable<Core::Http::HttpRange> Range;
 
    LeaseAccessConditions AccessConditions;
 
    Azure::Nullable<bool> IncludeRenames;
  };
 
  struct ListFileHandlesOptions final
  {
    Azure::Nullable<std::string> ContinuationToken;
 
    Azure::Nullable<int32_t> PageSizeHint;
  };
 
  struct ForceCloseFileHandleOptions final
  {
  };
 
  struct ForceCloseAllFileHandlesOptions final
  {
    Azure::Nullable<std::string> ContinuationToken;
  };
 
  struct DownloadFileToOptions final
  {
    Azure::Nullable<Core::Http::HttpRange> Range;
 
    struct
    {
      int64_t InitialChunkSize = 256 * 1024 * 1024;
 
      int64_t ChunkSize = 4 * 1024 * 1024;
 
      int32_t Concurrency = 5;
    } TransferOptions;
  };
 
  struct UploadFileFromOptions final
  {
    Models::FileHttpHeaders HttpHeaders;
 
    Storage::Metadata Metadata;
 
    Models::FileSmbProperties SmbProperties;
 
    Azure::Nullable<std::string> FilePermission;
 
    Nullable<Models::FilePermissionFormat> FilePermissionFormat;
 
    Models::FilePosixProperties PosixProperties;
 
    struct
    {
      int64_t SingleUploadThreshold = 4 * 1024 * 1024;
 
      int64_t ChunkSize = 4 * 1024 * 1024;
 
      int32_t Concurrency = 5;
    } TransferOptions;
  };
 
  struct AcquireLeaseOptions final
  {
  };
 
  struct ChangeLeaseOptions final
  {
  };
 
  struct ReleaseLeaseOptions final
  {
  };
 
  struct BreakLeaseOptions final
  {
    Azure::Nullable<int32_t> BreakPeriod;
  };
 
  struct RenewLeaseOptions final
  {
  };
 
  struct CreateHardLinkOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
}}}} // namespace Azure::Storage::Files::Shares