blob_options.hpp

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include "azure/storage/blobs/protocol/blob_rest_client.hpp"
#include "azure/storage/common/access_conditions.hpp"
 
#include <limits>
#include <string>
#include <utility>
 
namespace Azure { namespace Storage { namespace Blobs {
 
  struct ContainerAccessConditions : public LastModifiedTimeAccessConditions,
                                     public LeaseAccessConditions
  {
  };
 
  struct TagAccessConditions
  {
    std::string TagConditions;
  };
 
  struct BlobAccessConditions : public LastModifiedTimeAccessConditions,
                                public ETagAccessConditions,
                                public LeaseAccessConditions,
                                public TagAccessConditions
  {
  };
 
  struct AppendBlobAccessConditions : public BlobAccessConditions
  {
    Azure::Core::Nullable<int64_t> MaxSize;
 
    Azure::Core::Nullable<int64_t> AppendPosition;
  };
 
  struct PageBlobAccessConditions : public BlobAccessConditions
  {
    Azure::Core::Nullable<int64_t> IfSequenceNumberLessThan;
 
    Azure::Core::Nullable<int64_t> IfSequenceNumberLessThanOrEqual;
 
    Azure::Core::Nullable<int64_t> IfSequenceNumberEqual;
  };
 
  struct BlobServiceClientOptions
  {
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerOperationPolicies;
 
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerRetryPolicies;
  };
 
  struct ListContainersSegmentOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> Prefix;
 
    Azure::Core::Nullable<std::string> Marker;
 
    Azure::Core::Nullable<int32_t> MaxResults;
 
    ListBlobContainersIncludeItem Include = ListBlobContainersIncludeItem::None;
  };
 
  struct GetUserDelegationKeyOptions
  {
    Azure::Core::Context Context;
  };
 
  struct SetServicePropertiesOptions
  {
    Azure::Core::Context Context;
  };
 
  struct GetServicePropertiesOptions
  {
    Azure::Core::Context Context;
  };
 
  struct GetAccountInfoOptions
  {
    Azure::Core::Context Context;
  };
 
  struct GetBlobServiceStatisticsOptions
  {
    Azure::Core::Context Context;
  };
 
  struct FindBlobsByTagsOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> Marker;
 
    Azure::Core::Nullable<int32_t> MaxResults;
  };
 
  struct EncryptionKey
  {
    std::string Key;
 
    std::string KeyHash;
 
    EncryptionAlgorithmType Algorithm;
  };
 
  struct BlobContainerClientOptions
  {
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerOperationPolicies;
 
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerRetryPolicies;
 
    Azure::Core::Nullable<EncryptionKey> CustomerProvidedKey;
 
    Azure::Core::Nullable<std::string> EncryptionScope;
  };
 
  struct CreateContainerOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<PublicAccessType> AccessType;
 
    std::map<std::string, std::string> Metadata;
 
    Azure::Core::Nullable<std::string> DefaultEncryptionScope;
 
    Azure::Core::Nullable<bool> PreventEncryptionScopeOverride;
  };
 
  struct DeleteContainerOptions
  {
    Azure::Core::Context Context;
 
    ContainerAccessConditions AccessConditions;
  };
 
  struct UndeleteContainerOptions
  {
    Azure::Core::Context Context;
  };
 
  struct GetContainerPropertiesOptions
  {
    Azure::Core::Context Context;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct SetContainerMetadataOptions
  {
    Azure::Core::Context Context;
 
    ContainerAccessConditions AccessConditions;
  };
 
  struct ListBlobsSegmentOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> Prefix;
 
    Azure::Core::Nullable<std::string> Marker;
 
    Azure::Core::Nullable<int32_t> MaxResults;
 
    ListBlobsIncludeItem Include = ListBlobsIncludeItem::None;
  };
 
  struct GetContainerAccessPolicyOptions
  {
    Azure::Core::Context Context;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct SetContainerAccessPolicyOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<PublicAccessType> AccessType;
 
    std::vector<BlobSignedIdentifier> SignedIdentifiers;
 
    ContainerAccessConditions AccessConditions;
  };
 
  struct AcquireContainerLeaseOptions : public LastModifiedTimeAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct RenewContainerLeaseOptions : public LastModifiedTimeAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct ChangeContainerLeaseOptions : public LastModifiedTimeAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct ReleaseContainerLeaseOptions : public LastModifiedTimeAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct BreakContainerLeaseOptions : public LastModifiedTimeAccessConditions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<int32_t> breakPeriod;
  };
 
  struct BlobClientOptions
  {
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerOperationPolicies;
 
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerRetryPolicies;
 
    Azure::Core::Nullable<EncryptionKey> CustomerProvidedKey;
 
    Azure::Core::Nullable<std::string> EncryptionScope;
  };
 
  struct BlockBlobClientOptions : public BlobClientOptions
  {
  };
 
  struct AppendBlobClientOptions : public BlobClientOptions
  {
  };
 
  struct PageBlobClientOptions : public BlobClientOptions
  {
  };
 
  struct GetBlobPropertiesOptions
  {
    Azure::Core::Context Context;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct SetBlobHttpHeadersOptions
  {
    Azure::Core::Context Context;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct SetBlobMetadataOptions
  {
    Azure::Core::Context Context;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct SetBlobAccessTierOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<Blobs::RehydratePriority> RehydratePriority;
  };
 
  struct StartCopyBlobFromUriOptions
  {
    Azure::Core::Context Context;
 
    std::map<std::string, std::string> Metadata;
 
    BlobAccessConditions AccessConditions;
 
    BlobAccessConditions SourceConditions;
 
    Azure::Core::Nullable<AccessTier> Tier;
 
    Azure::Core::Nullable<Blobs::RehydratePriority> RehydratePriority;
 
    Azure::Core::Nullable<bool> ShouldSealDestination;
  };
 
  struct AbortCopyBlobFromUriOptions
  {
    Azure::Core::Context Context;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct DownloadBlobOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<int64_t> Offset;
 
    Azure::Core::Nullable<int64_t> Length;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct DownloadBlobToOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<int64_t> Offset;
 
    Azure::Core::Nullable<int64_t> Length;
 
    Azure::Core::Nullable<int64_t> InitialChunkSize;
 
    Azure::Core::Nullable<int64_t> ChunkSize;
 
    int Concurrency = 1;
  };
 
  struct CreateBlobSnapshotOptions
  {
    Azure::Core::Context Context;
 
    std::map<std::string, std::string> Metadata;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct DeleteBlobOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<DeleteSnapshotsOption> DeleteSnapshots;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct UndeleteBlobOptions
  {
    Azure::Core::Context Context;
  };
 
  struct AcquireBlobLeaseOptions : public LastModifiedTimeAccessConditions,
                                   public ETagAccessConditions,
                                   public TagAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct RenewBlobLeaseOptions : public LastModifiedTimeAccessConditions,
                                 public ETagAccessConditions,
                                 public TagAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct ChangeBlobLeaseOptions : public LastModifiedTimeAccessConditions,
                                  public ETagAccessConditions,
                                  public TagAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct ReleaseBlobLeaseOptions : public LastModifiedTimeAccessConditions,
                                   public ETagAccessConditions,
                                   public TagAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct BreakBlobLeaseOptions : public LastModifiedTimeAccessConditions,
                                 public ETagAccessConditions,
                                 public TagAccessConditions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<int32_t> breakPeriod;
  };
 
  struct SetBlobTagsOptions : public TagAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct GetBlobTagsOptions : public TagAccessConditions
  {
    Azure::Core::Context Context;
  };
 
  struct UploadBlockBlobOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> TransactionalContentMd5;
 
    Azure::Core::Nullable<std::string> TransactionalContentCrc64;
 
    BlobHttpHeaders HttpHeaders;
 
    std::map<std::string, std::string> Metadata;
 
    Azure::Core::Nullable<AccessTier> Tier;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct UploadBlockBlobFromOptions
  {
    Azure::Core::Context Context;
 
    BlobHttpHeaders HttpHeaders;
 
    std::map<std::string, std::string> Metadata;
 
    Azure::Core::Nullable<AccessTier> Tier;
 
    Azure::Core::Nullable<int64_t> ChunkSize;
 
    int Concurrency = 1;
  };
 
  struct StageBlockOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> TransactionalContentMd5;
 
    Azure::Core::Nullable<std::string> TransactionalContentCrc64;
 
    LeaseAccessConditions AccessConditions;
  };
 
  struct StageBlockFromUriOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<int64_t> SourceOffset;
 
    Azure::Core::Nullable<int64_t> SourceLength;
 
    Azure::Core::Nullable<std::string> TransactionalContentMd5;
 
    Azure::Core::Nullable<std::string> TransactionalContentCrc64;
 
    LeaseAccessConditions AccessConditions;
 
    struct : public LastModifiedTimeAccessConditions, public ETagAccessConditions
    {
    } SourceConditions;
  };
 
  struct CommitBlockListOptions
  {
    Azure::Core::Context Context;
 
    BlobHttpHeaders HttpHeaders;
 
    std::map<std::string, std::string> Metadata;
 
    Azure::Core::Nullable<AccessTier> Tier;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct GetBlockListOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<BlockListTypeOption> ListType;
 
    struct : public LeaseAccessConditions, public TagAccessConditions
    {
    } AccessConditions;
  };
 
  struct CreateAppendBlobOptions
  {
    Azure::Core::Context Context;
 
    BlobHttpHeaders HttpHeaders;
 
    std::map<std::string, std::string> Metadata;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct AppendBlockOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> TransactionalContentMd5;
 
    Azure::Core::Nullable<std::string> TransactionalContentCrc64;
 
    AppendBlobAccessConditions AccessConditions;
  };
 
  struct AppendBlockFromUriOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<int64_t> SourceOffset;
 
    Azure::Core::Nullable<int64_t> SourceLength;
 
    Azure::Core::Nullable<std::string> TransactionalContentMd5;
 
    Azure::Core::Nullable<std::string> TransactionalContentCrc64;
 
    AppendBlobAccessConditions AccessConditions;
  };
 
  struct SealAppendBlobOptions
  {
    Azure::Core::Context Context;
 
    AppendBlobAccessConditions AccessConditions;
  };
 
  struct CreatePageBlobOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<int64_t> SequenceNumber;
 
    BlobHttpHeaders HttpHeaders;
 
    std::map<std::string, std::string> Metadata;
 
    Azure::Core::Nullable<AccessTier> Tier;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct UploadPageBlobPagesOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> TransactionalContentMd5;
 
    Azure::Core::Nullable<std::string> TransactionalContentCrc64;
 
    PageBlobAccessConditions AccessConditions;
  };
 
  struct UploadPageBlobPagesFromUriOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> TransactionalContentMd5;
 
    Azure::Core::Nullable<std::string> TransactionalContentCrc64;
 
    PageBlobAccessConditions AccessConditions;
  };
 
  struct ClearPageBlobPagesOptions
  {
    Azure::Core::Context Context;
 
    PageBlobAccessConditions AccessConditions;
  };
 
  struct ResizePageBlobOptions
  {
    Azure::Core::Context Context;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct GetPageBlobPageRangesOptions
  {
    Azure::Core::Context Context;
 
    Azure::Core::Nullable<std::string> PreviousSnapshot;
 
    Azure::Core::Nullable<std::string> PreviousSnapshotUrl;
 
    Azure::Core::Nullable<int64_t> Offset;
 
    Azure::Core::Nullable<int64_t> Length;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct StartCopyPageBlobIncrementalOptions
  {
    Azure::Core::Context Context;
 
    BlobAccessConditions AccessConditions;
  };
 
  struct BlobBatchClientOptions
  {
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerOperationPolicies;
 
    std::vector<std::unique_ptr<Azure::Core::Http::HttpPolicy>> PerRetryPolicies;
  };
 
  struct SubmitBlobBatchOptions
  {
    Azure::Core::Context Context;
  };
 
}}} // namespace Azure::Storage::Blobs