Class CloudBackupClient

Inheritance

object

ClientBase

CloudBackupClient

Inherited Members

ClientBase.BaseUrl

ClientBase.CreateHttpRequestMessageAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class CloudBackupClient : ClientBase, ICloudBackupClient

Constructors

CloudBackupClient(ICloudManagerServiceSettings, HttpClient)

Declaration

public CloudBackupClient(ICloudManagerServiceSettings configuration, HttpClient httpClient)

Parameters

ICloudManagerServiceSettings configuration

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

ArchiveAsync(SnapshotRepositoryArchiveRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRepository> ArchiveAsync(SnapshotRepositoryArchiveRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotRepositoryArchiveRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepository>

Implements

ICloudBackupClient.ArchiveAsync(SnapshotRepositoryArchiveRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CleanupAsync(CancellationToken)

Declaration

public virtual Task<SnapshotRepositoryCleanupResult> CleanupAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepositoryCleanupResult>

Implements

ICloudBackupClient.CleanupAsync(CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CloneAsync(SnapshotCustomerCloneRequest, CancellationToken)

Declaration

public virtual Task<Customer> CloneAsync(SnapshotCustomerCloneRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotCustomerCloneRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Customer>

Implements

ICloudBackupClient.CloneAsync(SnapshotCustomerCloneRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CloneRequestAsync(CancellationToken)

Declaration

public virtual Task<SnapshotCustomerCloneRequest> CloneRequestAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotCustomerCloneRequest>

Implements

ICloudBackupClient.CloneRequestAsync(CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CreateRepository2Async(SnapshotRepositoryEnvironmentCreateRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRepository> CreateRepository2Async(SnapshotRepositoryEnvironmentCreateRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotRepositoryEnvironmentCreateRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepository>

Implements

ICloudBackupClient.CreateRepository2Async(SnapshotRepositoryEnvironmentCreateRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CreateRepositoryAsync(SnapshotRepositoryCustomerCreateRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRepository> CreateRepositoryAsync(SnapshotRepositoryCustomerCreateRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotRepositoryCustomerCreateRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepository>

Implements

ICloudBackupClient.CreateRepositoryAsync(SnapshotRepositoryCustomerCreateRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CreateSnapshot2Async(SnapshotEnvironmentCreateRequest, CancellationToken)

Declaration

public virtual Task<SnapshotEnqueueResult> CreateSnapshot2Async(SnapshotEnvironmentCreateRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotEnvironmentCreateRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotEnqueueResult>

Implements

ICloudBackupClient.CreateSnapshot2Async(SnapshotEnvironmentCreateRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CreateSnapshotAsync(SnapshotCustomerCreateRequest, CancellationToken)

Declaration

public virtual Task<SnapshotEnqueueResult> CreateSnapshotAsync(SnapshotCustomerCreateRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotCustomerCreateRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotEnqueueResult>

Implements

ICloudBackupClient.CreateSnapshotAsync(SnapshotCustomerCreateRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

CreateSnapshotWithSecondaryIndicesAsync(SnapshotCustomerAllClustersRequest, CancellationToken)

Declaration

public virtual Task<SnapshotEnqueueResult> CreateSnapshotWithSecondaryIndicesAsync(SnapshotCustomerAllClustersRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotCustomerAllClustersRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotEnqueueResult>

Implements

ICloudBackupClient.CreateSnapshotWithSecondaryIndicesAsync(SnapshotCustomerAllClustersRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

ExportAsync(CustomerExportRequest, TimeSpan?, CancellationToken)

Declaration

public virtual Task<CustomerExportResult> ExportAsync(CustomerExportRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

CustomerExportRequest request

TimeSpan? timeout

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CustomerExportResult>

Implements

ICloudBackupClient.ExportAsync(CustomerExportRequest, TimeSpan?, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

GetGlobalRepositoryStateAsync(CancellationToken)

Declaration

public virtual Task<GlobalSnapshotRepositoryStateResult> GetGlobalRepositoryStateAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GlobalSnapshotRepositoryStateResult>

Implements

ICloudBackupClient.GetGlobalRepositoryStateAsync(CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

GetSnapshotAllClustersAsync(string, CancellationToken)

Declaration

public virtual Task<SnapshotCustomerAllClustersResult> GetSnapshotAllClustersAsync(string tokenId, CancellationToken cancellationToken = default)

Parameters

string tokenId

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotCustomerAllClustersResult>

Implements

ICloudBackupClient.GetSnapshotAllClustersAsync(string, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

ImportAllClustersAsync(CustomerImportAllClustersRequest, CancellationToken)

Declaration

public virtual Task<Customer> ImportAllClustersAsync(CustomerImportAllClustersRequest request, CancellationToken cancellationToken = default)

Parameters

CustomerImportAllClustersRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Customer>

Implements

ICloudBackupClient.ImportAllClustersAsync(CustomerImportAllClustersRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

ImportAsync(CustomerImportRequest, CancellationToken)

Declaration

public virtual Task<Customer> ImportAsync(CustomerImportRequest request, CancellationToken cancellationToken = default)

Parameters

CustomerImportRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Customer>

Implements

ICloudBackupClient.ImportAsync(CustomerImportRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<CloudBackupClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

HttpResponseMessage response

IReadOnlyDictionary<string, IEnumerable<string>> headers

CancellationToken cancellationToken

Returns

Task<CloudBackupClient.ObjectResponseResult<T>>

Type Parameters

T

RestoreAsync(SnapshotCustomerRestoreRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRestore> RestoreAsync(SnapshotCustomerRestoreRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotCustomerRestoreRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRestore>

Implements

ICloudBackupClient.RestoreAsync(SnapshotCustomerRestoreRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

RestoreIndicesAsync(RestoreSnapshotIndicesRequest, CancellationToken)

Declaration

public virtual Task<RestoreSnapshotIndices> RestoreIndicesAsync(RestoreSnapshotIndicesRequest request, CancellationToken cancellationToken = default)

Parameters

RestoreSnapshotIndicesRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<RestoreSnapshotIndices>

Implements

ICloudBackupClient.RestoreIndicesAsync(RestoreSnapshotIndicesRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

Search2Async(SnapshotRepositorySearchByNameRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRepository> Search2Async(SnapshotRepositorySearchByNameRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotRepositorySearchByNameRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepository>

Implements

ICloudBackupClient.Search2Async(SnapshotRepositorySearchByNameRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

SearchAsync(SnapshotEnvironmentSearchRequest, CancellationToken)

Declaration

public virtual Task<SnapshotEnvironmentSearchResult> SearchAsync(SnapshotEnvironmentSearchRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotEnvironmentSearchRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotEnvironmentSearchResult>

Implements

ICloudBackupClient.SearchAsync(SnapshotEnvironmentSearchRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

SearchEnvironmentRepositoriesAsync(SnapshotRepositoryEnvironmentSearchRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRepositorySearchResult> SearchEnvironmentRepositoriesAsync(SnapshotRepositoryEnvironmentSearchRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotRepositoryEnvironmentSearchRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepositorySearchResult>

Implements

ICloudBackupClient.SearchEnvironmentRepositoriesAsync(SnapshotRepositoryEnvironmentSearchRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

SearchRepositoriesAsync(SnapshotRepositoryCustomerSearchRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRepositorySearchResult> SearchRepositoriesAsync(SnapshotRepositoryCustomerSearchRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotRepositoryCustomerSearchRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepositorySearchResult>

Implements

ICloudBackupClient.SearchRepositoriesAsync(SnapshotRepositoryCustomerSearchRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

SearchSnapshotsAsync(SnapshotCustomerSearchRequest, CancellationToken)

Declaration

public virtual Task<SnapshotCustomerSearchResult> SearchSnapshotsAsync(SnapshotCustomerSearchRequest request, CancellationToken cancellationToken = default)

Parameters

SnapshotCustomerSearchRequest request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotCustomerSearchResult>

Implements

ICloudBackupClient.SearchSnapshotsAsync(SnapshotCustomerSearchRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found

SetExternalMetadataAsync(SnapshotRepositoryMetadataUpdateRequest, CancellationToken)

Declaration

public virtual Task<SnapshotRepository> SetExternalMetadataAsync(SnapshotRepositoryMetadataUpdateRequest updateRequest, CancellationToken cancellationToken = default)

Parameters

SnapshotRepositoryMetadataUpdateRequest updateRequest

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<SnapshotRepository>

Implements

ICloudBackupClient.SetExternalMetadataAsync(SnapshotRepositoryMetadataUpdateRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkException Entity not found

PictureparkNotFoundException Entity not found