Class CustomerClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class CustomerClient : ClientBase, ICustomerClientConstructors
CustomerClient(ICloudManagerServiceSettings, HttpClient)
Declaration
public CustomerClient(ICloudManagerServiceSettings configuration, HttpClient httpClient)Parameters
| ICloudManagerServiceSettings configuration |
| HttpClient httpClient |
Properties
JsonSerializerSettings
Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }Property Value
| JsonSerializerSettings |
ReadResponseAsString
Methods
AddMetadataLanguageAsync(string, CustomerMetadataLanguageCreateRequest, TimeSpan?, CancellationToken)
Declaration
public virtual Task<EnvironmentProcess> AddMetadataLanguageAsync(string alias, CustomerMetadataLanguageCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
| string alias |
| CustomerMetadataLanguageCreateRequest request |
| TimeSpan? timeout |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<EnvironmentProcess> |
Implements
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 |
ChangeStorageSiloAsync(string, ChangeStorageSiloRequest, CancellationToken)
Declaration
public virtual Task<BusinessProcess> ChangeStorageSiloAsync(string alias, ChangeStorageSiloRequest request, CancellationToken cancellationToken = default)Parameters
| string alias |
| ChangeStorageSiloRequest request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<BusinessProcess> |
Implements
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 |
ClearCacheSiloAsync(string, CancellationToken)
Declaration
public virtual Task ClearCacheSiloAsync(string alias, CancellationToken cancellationToken = default)Parameters
| string alias |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Implements
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 |
CreateAsync(CustomerCreateRequest, CancellationToken)
Declaration
public virtual Task<CustomerConfiguration> CreateAsync(CustomerCreateRequest request, CancellationToken cancellationToken = default)Parameters
| CustomerCreateRequest request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<CustomerConfiguration> |
Implements
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 |
DeleteAsync(string, CancellationToken)
Declaration
public virtual Task DeleteAsync(string id, CancellationToken cancellationToken = default)Parameters
| string id |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Implements
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 |
DeleteWithOptionsAsync(string, CustomerDeleteRequest, CancellationToken)
Declaration
public virtual Task DeleteWithOptionsAsync(string id, CustomerDeleteRequest request, CancellationToken cancellationToken = default)Parameters
| string id |
| CustomerDeleteRequest request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Implements
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 |
GetAsync(string, CancellationToken)
Declaration
public virtual Task<CustomerConfiguration> GetAsync(string id, CancellationToken cancellationToken = default)Parameters
| string id |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<CustomerConfiguration> |
Implements
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 |
GetAvailableMetadataLanguagesAsync(string, CancellationToken)
Declaration
public virtual Task<ICollection<string>> GetAvailableMetadataLanguagesAsync(string alias, CancellationToken cancellationToken = default)Parameters
| string alias |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<ICollection<string>> |
Implements
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 |
GetCreateRequestAsync(CancellationToken)
Declaration
public virtual Task<CustomerCreateRequest> GetCreateRequestAsync(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<CustomerCreateRequest> |
Implements
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 |
GetHostConfigurationAsync(string, CancellationToken)
Declaration
public virtual Task<CustomerHostConfiguration> GetHostConfigurationAsync(string alias, CancellationToken cancellationToken = default)Parameters
| string alias |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<CustomerHostConfiguration> |
Implements
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 |
GetIndicesAsync(string, bool, CancellationToken)
Declaration
public virtual Task<ICollection<Index>> GetIndicesAsync(string alias, bool onlyForReshard, CancellationToken cancellationToken = default)Parameters
| string alias |
| bool onlyForReshard |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<ICollection<Index>> |
Implements
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 |
GetUsersAsync(string, CancellationToken)
Declaration
public virtual Task<ICollection<UserWithRoles>> GetUsersAsync(string alias, CancellationToken cancellationToken = default)Parameters
| string alias |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<ICollection<UserWithRoles>> |
Implements
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 |
InvalidateAsync(string, CancellationToken)
Declaration
public virtual Task InvalidateAsync(string alias, CancellationToken cancellationToken = default)Parameters
| string alias |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Implements
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 |
ListAsync(CancellationToken)
Declaration
public virtual Task<CustomerSearchResult> ListAsync(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<CustomerSearchResult> |
Implements
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<CustomerClient.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<CustomerClient.ObjectResponseResult<T>> |
Type Parameters
| T |
ReindexAsync(string, SearchIndexReindexShardsRequest, CancellationToken)
Declaration
public virtual Task<Index> ReindexAsync(string alias, SearchIndexReindexShardsRequest request, CancellationToken cancellationToken = default)Parameters
| string alias |
| SearchIndexReindexShardsRequest request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<Index> |
Implements
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 |
ReshardElasticIndicesAsync(string, CustomerReshardRequest, TimeSpan?, CancellationToken)
Declaration
public virtual Task<EnvironmentProcess> ReshardElasticIndicesAsync(string alias, CustomerReshardRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
| string alias |
| CustomerReshardRequest request |
| TimeSpan? timeout |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<EnvironmentProcess> |
Implements
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 |
RestoreAsync(string, CancellationToken)
Declaration
public virtual Task RestoreAsync(string alias, CancellationToken cancellationToken = default)Parameters
| string alias |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Implements
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(CustomerSearchRequest, CancellationToken)
Declaration
public virtual Task<CustomerSearchResult> SearchAsync(CustomerSearchRequest request, CancellationToken cancellationToken = default)Parameters
| CustomerSearchRequest request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<CustomerSearchResult> |
Implements
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 |
SetAnonymousAccessAsync(string, bool, CancellationToken)
Declaration
public virtual Task<UserWithRoles> SetAnonymousAccessAsync(string alias, bool enabled, CancellationToken cancellationToken = default)Parameters
| string alias |
| bool enabled |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<UserWithRoles> |
Implements
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 |
UpdateAsync(CustomerUpdateRequest, CancellationToken)
Declaration
public virtual Task<CustomerConfiguration> UpdateAsync(CustomerUpdateRequest request, CancellationToken cancellationToken = default)Parameters
| CustomerUpdateRequest request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<CustomerConfiguration> |
Implements
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 |
UpdateBoostValuesAsync(string, CustomerBoostValuesUpdateRequest, TimeSpan?, CancellationToken)
Declaration
public virtual Task<EnvironmentProcess> UpdateBoostValuesAsync(string alias, CustomerBoostValuesUpdateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
| string alias |
| CustomerBoostValuesUpdateRequest request |
| TimeSpan? timeout |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<EnvironmentProcess> |
Implements
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 |
UpdateHostConfigurationAsync(string, CustomerHostConfigurationWriteRequest, CancellationToken)
Declaration
public virtual Task<CustomerHostConfigurationEditable> UpdateHostConfigurationAsync(string alias, CustomerHostConfigurationWriteRequest request, CancellationToken cancellationToken = default)Parameters
| string alias |
| CustomerHostConfigurationWriteRequest request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<CustomerHostConfigurationEditable> |
Implements
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 |