share_options.hpp

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <memory>
#include <string>
#include <vector>
 
#include <azure/core/internal/client_options.hpp>
#include <azure/core/nullable.hpp>
#include <azure/storage/common/access_conditions.hpp>
 
#include "azure/storage/files/shares/protocol/share_rest_client.hpp"
 
namespace Azure { namespace Storage { namespace Files { namespace Shares {
 
  struct ShareClientOptions final : Azure::Core::_internal::ClientOptions
  {
    std::string ApiVersion = _detail::DefaultServiceApiVersion;
  };
 
  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;
  };
 
  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;
  };
 
  struct SetShareMetadataOptions final
  {
  };
 
  struct GetShareAccessPolicyOptions final
  {
  };
 
  struct SetShareAccessPolicyOptions final
  {
  };
 
  struct GetShareStatisticsOptions final
  {
  };
 
  struct CreateSharePermissionOptions final
  {
  };
 
  struct GetSharePermissionOptions final
  {
  };
 
  struct CreateDirectoryOptions final
  {
    Storage::Metadata Metadata;
 
    Azure::Nullable<std::string> DirectoryPermission;
 
    Models::FileSmbProperties SmbProperties;
  };
 
  struct DeleteDirectoryOptions final
  {
  };
 
  struct GetDirectoryPropertiesOptions final
  {
  };
 
  struct SetDirectoryPropertiesOptions final
  {
    Azure::Nullable<std::string> FilePermission;
  };
 
  struct SetDirectoryMetadataOptions final
  {
  };
 
  struct ListFilesAndDirectoriesOptions final
  {
    Azure::Nullable<std::string> Prefix;
 
    Azure::Nullable<std::string> ContinuationToken;
 
    Azure::Nullable<int32_t> PageSizeHint;
  };
 
  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;
 
    Models::FileSmbProperties SmbProperties;
 
    Models::FileHttpHeaders HttpHeaders;
 
    Storage::Metadata Metadata;
 
    LeaseAccessConditions AccessConditions;
  };
 
  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;
 
    Models::FileSmbProperties SmbProperties;
 
    Azure::Nullable<Models::PermissionCopyMode> PermissionCopyMode;
 
    Azure::Nullable<bool> IgnoreReadOnly;
 
    Azure::Nullable<bool> SetArchiveAttribute;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct AbortFileCopyOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct GetFilePropertiesOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct SetFilePropertiesOptions final
  {
    Azure::Nullable<std::string> Permission;
 
    Azure::Nullable<int64_t> Size;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct SetFileMetadataOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct UploadFileRangeOptions final
  {
    Azure::Nullable<ContentHash> TransactionalContentHash;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct ClearFileRangeOptions final
  {
    LeaseAccessConditions AccessConditions;
  };
 
  struct UploadFileRangeFromUriOptions final
  {
    Azure::Nullable<ContentHash> TransactionalContentHash;
 
    ContentHashAccessConditions SourceAccessCondition;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct GetFileRangeListOptions final
  {
    Azure::Nullable<Core::Http::HttpRange> Range;
 
    LeaseAccessConditions AccessConditions;
  };
 
  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;
 
    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
  {
  };
}}}} // namespace Azure::Storage::Files::Shares