github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add docs for return types and options (#2159)

Browse Source 
* Add docs for return type

* datalake options

* share options

* transfer options
This commit is contained in:
JinmingHu 2021-04-28 10:42:58 +08:00 committed by GitHub
parent 8a369f5e27
commit ff10813ba0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 837 additions and 495 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_options.hpp
View File

@ -153,7 +153,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobServiceClient::ListBlobContainers.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobServiceClient::ListBlobContainers.
*/
struct ListBlobContainersOptions
{
@ -185,7 +185,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobServiceClient::GetUserDelegationKey.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobServiceClient::GetUserDelegationKey.
*/
struct GetUserDelegationKeyOptions
{
@ -197,35 +197,35 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobServiceClient::SetProperties.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobServiceClient::SetProperties.
*/
struct SetServicePropertiesOptions
{
};
/**
* @brief Optional parameters for BlobServiceClient::GetProperties.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobServiceClient::GetProperties.
*/
struct GetServicePropertiesOptions
{
};
/**
* @brief Optional parameters for BlobServiceClient::GetAccountInfo.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobServiceClient::GetAccountInfo.
*/
struct GetAccountInfoOptions
{
};
/**
* @brief Optional parameters for BlobServiceClient::GetStatistics.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobServiceClient::GetStatistics.
*/
struct GetBlobServiceStatisticsOptions
{
};
/**
* @brief Optional parameters for BlobServiceClient::FindBlobsByTags.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobServiceClient::FindBlobsByTags.
*/
struct FindBlobsByTagsOptions
{
@ -244,7 +244,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::Create.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::Create.
*/
struct CreateBlobContainerOptions
{
@ -272,7 +272,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::Delete.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::Delete.
*/
struct DeleteBlobContainerOptions
{
@ -283,7 +283,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::Undelete.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::Undelete.
*/
struct UndeleteBlobContainerOptions
{
@ -295,7 +295,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::GetProperties.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::GetProperties.
*/
struct GetBlobContainerPropertiesOptions
{
@ -306,7 +306,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::SetMetadata.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::SetMetadata.
*/
struct SetBlobContainerMetadataOptions
{
@ -324,8 +324,8 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::ListBlobs and
* BlobContainerClient::ListBlobsByHierarchy.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::ListBlobs and
* #Azure::Storage::Blobs::BlobContainerClient::ListBlobsByHierarchy.
*/
struct ListBlobsOptions
{
@ -357,7 +357,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::GetAccessPolicy.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::GetAccessPolicy.
*/
struct GetBlobContainerAccessPolicyOptions
{
@ -368,7 +368,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobContainerClient::SetAccessPolicy.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::SetAccessPolicy.
*/
struct SetBlobContainerAccessPolicyOptions
{
@ -391,7 +391,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::GetProperties.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::GetProperties.
*/
struct GetBlobPropertiesOptions
{
@ -402,7 +402,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::SetHttpHeaders.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::SetHttpHeaders.
*/
struct SetBlobHttpHeadersOptions
{
@ -413,7 +413,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::SetMetadata.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::SetMetadata.
*/
struct SetBlobMetadataOptions
{
@ -424,7 +424,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::SetAccessTier.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::SetAccessTier.
*/
struct SetBlobAccessTierOptions
{
@ -437,7 +437,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::StartCopyFromUri.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::StartCopyFromUri.
*/
struct StartBlobCopyFromUriOptions
{
@ -479,7 +479,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::AbortCopyFromUri.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::AbortCopyFromUri.
*/
struct AbortBlobCopyFromUriOptions
{
@ -490,7 +490,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::Download.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::Download.
*/
struct DownloadBlobOptions
{
@ -512,7 +512,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::DownloadTo.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::DownloadTo.
*/
struct DownloadBlobToOptions
{
@ -521,6 +521,9 @@ namespace Azure { namespace Storage { namespace Blobs {
*/
Azure::Nullable<Core::Http::HttpRange> Range;
/**
* @brief Options for parallel transfer.
*/
struct
{
/**
@ -543,7 +546,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::CreateSnapshot.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::CreateSnapshot.
*/
struct CreateBlobSnapshotOptions
{
@ -562,7 +565,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::Delete.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::Delete.
*/
struct DeleteBlobOptions
{
@ -580,14 +583,14 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::Undelete.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::Undelete.
*/
struct UndeleteBlobOptions
{
};
/**
* @brief Optional parameters for BlobLeaseClient::Acquire.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobLeaseClient::Acquire.
*/
struct AcquireLeaseOptions
{
@ -598,7 +601,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobLeaseClient::Renew.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobLeaseClient::Renew.
*/
struct RenewLeaseOptions
{
@ -609,7 +612,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobLeaseClient::Change.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobLeaseClient::Change.
*/
struct ChangeLeaseOptions
{
@ -620,7 +623,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobLeaseClient::Release.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobLeaseClient::Release.
*/
struct ReleaseLeaseOptions
{
@ -631,7 +634,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobLeaseClient::Break.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobLeaseClient::Break.
*/
struct BreakLeaseOptions
{
@ -651,7 +654,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::SetTags.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::SetTags.
*/
struct SetBlobTagsOptions
{
@ -662,7 +665,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlobClient::GetTags.
* @brief Optional parameters for #Azure::Storage::Blobs::BlobClient::GetTags.
*/
struct GetBlobTagsOptions
{
@ -673,7 +676,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlockBlobClient::Upload.
* @brief Optional parameters for #Azure::Storage::Blobs::BlockBlobClient::Upload.
*/
struct UploadBlockBlobOptions
{
@ -706,7 +709,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlockBlobClient::UploadFrom.
* @brief Optional parameters for #Azure::Storage::Blobs::BlockBlobClient::UploadFrom.
*/
struct UploadBlockBlobFromOptions
{
@ -725,6 +728,9 @@ namespace Azure { namespace Storage { namespace Blobs {
*/
Azure::Nullable<Models::AccessTier> AccessTier;
/**
* @brief Options for parallel transfer.
*/
struct
{
/**
@ -747,7 +753,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlockBlobClient::StageBlock.
* @brief Optional parameters for #Azure::Storage::Blobs::BlockBlobClient::StageBlock.
*/
struct StageBlockOptions
{
@ -765,7 +771,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlockBlobClient::StageBlockFromUri.
* @brief Optional parameters for #Azure::Storage::Blobs::BlockBlobClient::StageBlockFromUri.
*/
struct StageBlockFromUriOptions
{
@ -795,7 +801,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlockBlobClient::CommitBlockList.
* @brief Optional parameters for #Azure::Storage::Blobs::BlockBlobClient::CommitBlockList.
*/
struct CommitBlockListOptions
{
@ -821,7 +827,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for BlockBlobClient::GetBlockList.
* @brief Optional parameters for #Azure::Storage::Blobs::BlockBlobClient::GetBlockList.
*/
struct GetBlockListOptions
{
@ -840,7 +846,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for AppendBlobClient::Create.
* @brief Optional parameters for #Azure::Storage::Blobs::AppendBlobClient::Create.
*/
struct CreateAppendBlobOptions
{
@ -861,7 +867,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for AppendBlobClient::AppendBlock.
* @brief Optional parameters for #Azure::Storage::Blobs::AppendBlobClient::AppendBlock.
*/
struct AppendBlockOptions
{
@ -879,7 +885,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for AppendBlobClient::AppendBlockFromUri.
* @brief Optional parameters for #Azure::Storage::Blobs::AppendBlobClient::AppendBlockFromUri.
*/
struct AppendBlockFromUriOptions
{
@ -902,7 +908,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for AppendBlobClient::Seal.
* @brief Optional parameters for #Azure::Storage::Blobs::AppendBlobClient::Seal.
*/
struct SealAppendBlobOptions
{
@ -913,7 +919,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for PageBlobClient::Create.
* @brief Optional parameters for #Azure::Storage::Blobs::PageBlobClient::Create.
*/
struct CreatePageBlobOptions
{
@ -945,7 +951,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for PageBlobClient::UploadPages.
* @brief Optional parameters for #Azure::Storage::Blobs::PageBlobClient::UploadPages.
*/
struct UploadPagesOptions
{
@ -963,7 +969,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for PageBlobClient::UploadPagesFromUri.
* @brief Optional parameters for #Azure::Storage::Blobs::PageBlobClient::UploadPagesFromUri.
*/
struct UploadPagesFromUriOptions
{
@ -981,7 +987,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for PageBlobClient::ClearPages.
* @brief Optional parameters for #Azure::Storage::Blobs::PageBlobClient::ClearPages.
*/
struct ClearPagesOptions
{
@ -992,7 +998,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for PageBlobClient::Resize.
* @brief Optional parameters for #Azure::Storage::Blobs::PageBlobClient::Resize.
*/
struct ResizePageBlobOptions
{
@ -1003,7 +1009,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for PageBlobClient::GetPageRanges.
* @brief Optional parameters for #Azure::Storage::Blobs::PageBlobClient::GetPageRanges.
*/
struct GetPageRangesOptions
{
@ -1020,7 +1026,7 @@ namespace Azure { namespace Storage { namespace Blobs {
};
/**
* @brief Optional parameters for PageBlobClient::StartCopyIncremental.
* @brief Optional parameters for #Azure::Storage::Blobs::PageBlobClient::StartCopyIncremental.
*/
struct StartBlobCopyIncrementalOptions
{

216
sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_responses.hpp
View File

@ -29,54 +29,153 @@ namespace Azure { namespace Storage {
namespace Models {
/**
* @brief Response type for #Azure::Storage::Blobs::BlobClient::DownloadTo.
*/
struct DownloadBlobToResult
{
/**
* The blob's type.
*/
Models::BlobType BlobType;
/**
* Indicates the range of bytes returned.
*/
Azure::Core::Http::HttpRange ContentRange;
/**
* Size of the blob.
*/
int64_t BlobSize = 0;
Azure::Nullable<ContentHash> TransactionalContentHash; // hash for the downloaded range
/**
* The request may return a CRC64 or MD5 hash for the downloaded range of data.
*/
Azure::Nullable<ContentHash> TransactionalContentHash;
/**
* Details information of the downloaded blob.
*/
DownloadBlobDetails Details;
};
using UploadBlockBlobFromResult = UploadBlockBlobResult;
/**
* @brief Response type for #Azure::Storage::Blobs::BlobLeaseClient::Acquire.
*/
struct AcquireLeaseResult
{
/**
* The ETag contains a value that you can use to perform operations conditionally.
*/
Azure::ETag ETag;
/**
* The date/time that the blob was last modified. The date format follows RFC 1123.
*/
Azure::DateTime LastModified;
/**
* When you request a lease, the Blob service returns a unique lease ID. While the lease is
* active, you must include the lease ID with any request to write to the blob, or to renew,
* change, or release the lease.
*/
std::string LeaseId;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobLeaseClient::Break.
*/
struct BreakLeaseResult
{
/**
* The ETag contains a value that you can use to perform operations conditionally.
*/
Azure::ETag ETag;
/**
* The date/time that the blob was last modified. The date format follows RFC 1123.
*/
Azure::DateTime LastModified;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobLeaseClient::Change.
*/
struct ChangeLeaseResult
{
/**
* The ETag contains a value that you can use to perform operations conditionally.
*/
Azure::ETag ETag;
/**
* The date/time that the blob was last modified. The date format follows RFC 1123.
*/
Azure::DateTime LastModified;
/**
* When you request a lease, the Blob service returns a unique lease ID. While the lease is
* active, you must include the lease ID with any request to write to the blob, or to renew,
* change, or release the lease.
*/
std::string LeaseId;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobLeaseClient::Release.
*/
struct ReleaseLeaseResult
{
/**
* The ETag contains a value that you can use to perform operations conditionally.
*/
Azure::ETag ETag;
/**
* The date/time that the blob was last modified. The date format follows RFC 1123.
*/
Azure::DateTime LastModified;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobLeaseClient::Renew.
*/
struct RenewLeaseResult
{
/**
* The ETag contains a value that you can use to perform operations conditionally.
*/
Azure::ETag ETag;
/**
* The date/time that the blob was last modified. The date format follows RFC 1123.
*/
Azure::DateTime LastModified;
/**
* When you request a lease, the Blob service returns a unique lease ID. While the lease is
* active, you must include the lease ID with any request to write to the blob, or to renew,
* change, or release the lease.
*/
std::string LeaseId;
};
} // namespace Models
/**
* @brief A long-running operation to copy a blob.
*/
class StartBlobCopyOperation : public Azure::Core::Operation<Models::BlobProperties> {
public:
/**
* @brief Get the #Azure::Storage::Blobs::Models::BlobProperties object, which includes the
* latest copy information.
*
* @return The #Azure::Storage::Blobs::Models::BlobProperties object.
*/
Models::BlobProperties Value() const override { return m_pollResult; }
StartBlobCopyOperation() = default;
@ -101,11 +200,6 @@ namespace Azure { namespace Storage {
std::chrono::milliseconds period,
Azure::Core::Context& context) override;
/**
* @brief Get the raw HTTP response.
* @return A reference to an #Azure::Core::Http::RawResponse.
* @note Does not give up ownership of the RawResponse.
*/
Azure::Core::Http::RawResponse const& GetRawResponseInternal() const override
{
return *m_rawResponse;
@ -118,11 +212,25 @@ namespace Azure { namespace Storage {
friend class Blobs::PageBlobClient;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobServiceClient::ListBlobContainers.
*/
class ListBlobContainersPagedResponse
: public Azure::Core::PagedResponse<ListBlobContainersPagedResponse> {
public:
/**
* Service endpoint.
*/
std::string ServiceEndpoint;
/**
* Container name prefix that's used to filter the result.
*/
std::string Prefix;
/**
* Blob container items.
*/
std::vector<Models::BlobContainerItem> BlobContainers;
private:
@ -136,10 +244,20 @@ namespace Azure { namespace Storage {
friend class Files::DataLake::ListFileSystemsPagedResponse;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobServiceClient::FindBlobsByTags.
*/
class FindBlobsByTagsPagedResponse
: public Azure::Core::PagedResponse<FindBlobsByTagsPagedResponse> {
public:
/**
* Service endpoint.
*/
std::string ServiceEndpoint;
/**
* Blob items filtered by tag.
*/
std::vector<Models::TaggedBlobItem> TaggedBlobs;
private:
@ -153,11 +271,29 @@ namespace Azure { namespace Storage {
friend class PagedResponse<FindBlobsByTagsPagedResponse>;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobContainerClient::ListBlobs.
*/
class ListBlobsPagedResponse : public Azure::Core::PagedResponse<ListBlobsPagedResponse> {
public:
/**
* Service endpoint.
*/
std::string ServiceEndpoint;
/**
* Name of the container.
*/
std::string BlobContainerName;
/**
* Blob name prefix that's used to filter the result.
*/
std::string Prefix;
/**
* Blob items.
*/
std::vector<Models::BlobItem> Blobs;
private:
@ -170,14 +306,41 @@ namespace Azure { namespace Storage {
friend class PagedResponse<ListBlobsPagedResponse>;
};
/**
* @brief Response type for #Azure::Storage::Blobs::BlobContainerClient::ByHierarchy.
*/
class ListBlobsByHierarchyPagedResponse
: public Azure::Core::PagedResponse<ListBlobsByHierarchyPagedResponse> {
public:
/**
* Service endpoint.
*/
std::string ServiceEndpoint;
/**
* Name of the container.
*/
std::string BlobContainerName;
/**
* Blob name prefix that's used to filter the result.
*/
std::string Prefix;
/**
* A character or a string used to traverse a virtual hierarchy of blobs as though it were a
* file system.
*/
std::string Delimiter;
/**
* Blob items.
*/
std::vector<Models::BlobItem> Blobs;
/**
* Blob prefix items.
*/
std::vector<std::string> BlobPrefixes;
private:
@ -191,12 +354,30 @@ namespace Azure { namespace Storage {
friend class PagedResponse<ListBlobsByHierarchyPagedResponse>;
};
/**
* @brief Response type for #Azure::Storage::Blobs::PageBlobClient::GetPageRanges.
*/
class GetPageRangesPagedResponse
: public Azure::Core::PagedResponse<GetPageRangesPagedResponse> {
public:
/**
* The ETag contains a value that you can use to perform operations conditionally.
*/
Azure::ETag ETag;
/**
* The date/time that the blob was last modified. The date format follows RFC 1123.
*/
Azure::DateTime LastModified;
/**
* Size of the blob.
*/
int64_t BlobSize = 0;
/**
* Page range items.
*/
std::vector<Azure::Core::Http::HttpRange> PageRanges;
private:
@ -209,13 +390,36 @@ namespace Azure { namespace Storage {
friend class PagedResponse<GetPageRangesPagedResponse>;
};
/**
* @brief Response type for #Azure::Storage::Blobs::PageBlobClient::GetPageRangesDiff and
* #Azure::Storage::Blobs::PageBlobClient::GetManagedDiskPageRangesDiff.
*/
class GetPageRangesDiffPagedResponse
: public Azure::Core::PagedResponse<GetPageRangesDiffPagedResponse> {
public:
/**
* The ETag contains a value that you can use to perform operations conditionally.
*/
Azure::ETag ETag;
/**
* The date/time that the blob was last modified. The date format follows RFC 1123.
*/
Azure::DateTime LastModified;
/**
* Size of the blob.
*/
int64_t BlobSize = 0;
/**
* Page range items.
*/
std::vector<Azure::Core::Http::HttpRange> PageRanges;
/**
* Clear range items.
*/
std::vector<Azure::Core::Http::HttpRange> ClearRanges;
private:

63
sdk/storage/azure-storage-files-datalake/inc/azure/storage/files/datalake/datalake_options.hpp
View File

@ -25,8 +25,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
using GetUserDelegationKeyOptions = Blobs::GetUserDelegationKeyOptions;
/**
* @brief Client options used to initalize DataLakeServiceClient, FileSystemClient, PathClient,
* FileClient and DirectoryClient.
* @brief Client options used to initalize all DataLake clients.
*/
struct DataLakeClientOptions : Azure::Core::_internal::ClientOptions
{
@ -62,7 +61,8 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for ServiceClient::ListFileSystemsOptions.
* @brief Optional parameters for
* #Azure::Storage::Files::DataLake::ServiceClient::ListFileSystems.
*/
struct ListFileSystemsOptions
{
@ -95,7 +95,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileSystemClient::Create
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileSystemClient::Create.
*/
struct CreateFileSystemOptions
{
@ -113,7 +113,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileSystemClient::Delete
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileSystemClient::Delete.
*/
struct DeleteFileSystemOptions
{
@ -124,7 +124,8 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileSystemClient::GetProperties
* @brief Optional parameters for
* #Azure::Storage::Files::DataLake::FileSystemClient::GetProperties.
*/
struct GetFileSystemPropertiesOptions
{
@ -135,7 +136,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileSystemClient::SetMetadata
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileSystemClient::SetMetadata.
*/
struct SetFileSystemMetadataOptions
{
@ -146,7 +147,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileSystemClient::ListPaths
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileSystemClient::ListPaths.
*/
struct ListPathsOptions
{
@ -180,7 +181,8 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileSystemClient::GetAccessPolicy.
* @brief Optional parameters for
* #Azure::Storage::Files::DataLake::FileSystemClient::GetAccessPolicy.
*/
struct GetFileSystemAccessPolicyOptions
{
@ -191,7 +193,8 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileSystemClient::SetAccessPolicy.
* @brief Optional parameters for
* #Azure::Storage::Files::DataLake::FileSystemClient::SetAccessPolicy.
*/
struct SetFileSystemAccessPolicyOptions
{
@ -214,7 +217,8 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for DataLakeFileSystemClient::RenameDirectory
* @brief Optional parameters for
* #Azure::Storage::Files::DataLake::DataLakeFileSystemClient::RenameDirectory.
* @remark Some optional parameter is mandatory in certain combination.
* More details:
* https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
@ -239,7 +243,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::Append
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::Append.
*/
struct AppendFileOptions
{
@ -255,7 +259,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::Flush
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::Flush.
*/
struct FlushFileOptions
{
@ -303,7 +307,8 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::SetAccessControlList
* @brief Optional parameters for
* #Azure::Storage::Files::DataLake::PathClient::SetAccessControlList.
*/
struct SetPathAccessControlListOptions
{
@ -324,7 +329,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::SetPermissions
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::SetPermissions.
*/
struct SetPathPermissionsOptions
{
@ -345,7 +350,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::SetHttpHeaders
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::SetHttpHeaders.
*/
struct SetPathHttpHeadersOptions
{
@ -356,7 +361,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::SetMetadata
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::SetMetadata.
*/
struct SetPathMetadataOptions
{
@ -367,7 +372,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::Create
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::Create.
* @remark Some optional parameter is mandatory in certain combination.
* More details:
* https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
@ -417,7 +422,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for DirectoryClient::Delete
* @brief Optional parameters for #Azure::Storage::Files::DataLake::DirectoryClient::Delete.
* @remark Some optional parameter is mandatory in certain combination.
* More details:
* https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
@ -438,7 +443,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::GetProperties
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::GetProperties.
* @remark Some optional parameter is mandatory in certain combination.
* More details:
* https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
@ -452,7 +457,8 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::GetAccessControlList
* @brief Optional parameters for
* #Azure::Storage::Files::DataLake::PathClient::GetAccessControlList.
*/
struct GetPathAccessControlListOptions
{
@ -463,7 +469,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for PathClient::Read
* @brief Optional parameters for #Azure::Storage::Files::DataLake::PathClient::Read.
* @remark Some optional parameter is mandatory in certain combination.
* More details:
* https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/read
@ -487,7 +493,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileClient::Create
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileClient::Create.
*/
struct RenameFileOptions
{
@ -509,7 +515,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
};
/**
* @brief Optional parameters for FileClient::Delete
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileClient::Delete.
*/
struct DeleteFileOptions
{
@ -522,7 +528,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
using RenameSubdirectoryOptions = RenameDirectoryOptions;
/**
* @brief Optional parameters for DirectoryClient::Delete
* @brief Optional parameters for #Azure::Storage::Files::DataLake::DirectoryClient::Delete.
*/
struct DeleteDirectoryOptions
{
@ -536,7 +542,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
using CreateDirectoryOptions = CreatePathOptions;
/**
* @brief Optional parameters for FileClient::UploadFromBuffer and FileClient::UploadFromFile
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileClient::UploadFrom.
*/
struct UploadFileFromOptions
{
@ -550,6 +556,9 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
*/
Storage::Metadata Metadata;
/**
* @brief Options for parallel transfer.
*/
struct
{
/**
@ -574,7 +583,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
using ScheduleFileExpiryOriginType = Blobs::Models::ScheduleBlobExpiryOriginType;
/**
* @brief Optional parameters for FileClient::UploadFromBuffer and FileClient::UploadFromFile
* @brief Optional parameters for #Azure::Storage::Files::DataLake::FileClient::UploadFrom.
*/
struct ScheduleFileDeletionOptions
{

945
sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_options.hpp
View File

File diff suppressed because it is too large Load Diff