Class MaintenanceClient

Inheritance

object

ClientBase

MaintenanceClient

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 MaintenanceClient : ClientBase, IMaintenanceClient

Constructors

MaintenanceClient(ICloudManagerServiceSettings, HttpClient)

Declaration

public MaintenanceClient(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

AddStatisticsEventsAsync(string, AddContentEventsRequest, TimeSpan?, CancellationToken)

Declaration

public virtual Task<BusinessProcess> AddStatisticsEventsAsync(string id, AddContentEventsRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

string id

AddContentEventsRequest request

TimeSpan? timeout

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

Returns

Task<BusinessProcess>

Implements

IMaintenanceClient.AddStatisticsEventsAsync(string, AddContentEventsRequest, 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

ApplySlowLogSettingsAsync(CancellationToken)

Declaration

public virtual Task ApplySlowLogSettingsAsync(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

Implements

IMaintenanceClient.ApplySlowLogSettingsAsync(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

CreateRelatedItemsAsync(string, CreateRelatedItemsByQueryRequest, TimeSpan?, CancellationToken)

Declaration

public virtual Task<BusinessProcess> CreateRelatedItemsAsync(string id, CreateRelatedItemsByQueryRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

string id

CreateRelatedItemsByQueryRequest request

TimeSpan? timeout

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

Returns

Task<BusinessProcess>

Implements

IMaintenanceClient.CreateRelatedItemsAsync(string, CreateRelatedItemsByQueryRequest, 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

MarkAllDisplayPatternsForRerenderingAsync(string, CancellationToken)

Declaration

public virtual Task MarkAllDisplayPatternsForRerenderingAsync(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

IMaintenanceClient.MarkAllDisplayPatternsForRerenderingAsync(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

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

Declaration

protected virtual Task<MaintenanceClient.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<MaintenanceClient.ObjectResponseResult<T>>

Type Parameters

T

RecalculateFileInformationAsync(string, RecalculateFileInformationRequest, TimeSpan?, CancellationToken)

Declaration

public virtual Task<BusinessProcess> RecalculateFileInformationAsync(string id, RecalculateFileInformationRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

string id

RecalculateFileInformationRequest request

TimeSpan? timeout

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

Returns

Task<BusinessProcess>

Implements

IMaintenanceClient.RecalculateFileInformationAsync(string, RecalculateFileInformationRequest, 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

ResetRetryAttemptsAsync(string, OutputResetRetryAttemptsRequest, TimeSpan?, CancellationToken)

Resets retry attempt counters.

Declaration

public virtual Task<BusinessProcess> ResetRetryAttemptsAsync(string id, OutputResetRetryAttemptsRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

string id CustomerId

OutputResetRetryAttemptsRequest request Request containing options to filter which outputs should be reset.

TimeSpan? timeout Timeout to wait for completion, operation will continue regardless.

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

Returns

Task<BusinessProcess> Business process tracking the resetting

Implements

IMaintenanceClient.ResetRetryAttemptsAsync(string, OutputResetRetryAttemptsRequest, TimeSpan?, CancellationToken)

Remarks

Resets retry attempt counters on failed (optionally also completed) outputs and they will be subsequently picked up for re-rendering.
The number the counters are reset to is determined by a global configuration value.

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

TouchSchemasAsync(string, TouchSchemasRequest, TimeSpan?, CancellationToken)

Declaration

public virtual Task<BusinessProcess> TouchSchemasAsync(string id, TouchSchemasRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

string id

TouchSchemasRequest request

TimeSpan? timeout

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

Returns

Task<BusinessProcess>

Implements

IMaintenanceClient.TouchSchemasAsync(string, TouchSchemasRequest, 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

UpdateOutdatedMetadataAsync(string, TimeSpan?, CancellationToken)

Declaration

public virtual Task<BusinessProcess> UpdateOutdatedMetadataAsync(string id, TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

string id

TimeSpan? timeout

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

Returns

Task<BusinessProcess>

Implements

IMaintenanceClient.UpdateOutdatedMetadataAsync(string, 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