Class BusinessRuleClient

Inheritance

object

ClientBase

BusinessRuleClient

Inherited Members

ClientBase.BaseUrl

ClientBase.CustomerAlias

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 BusinessRuleClient : ClientBase, IBusinessRuleClient

Constructors

BusinessRuleClient(IPictureparkServiceSettings, HttpClient)

Declaration

public BusinessRuleClient(IPictureparkServiceSettings configuration, HttpClient httpClient)

Parameters

IPictureparkServiceSettings configuration

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

GetConfigurationAsync(CancellationToken)

Get the current business rule configuration

Declaration

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

BusinessRuleConfiguration

Implements

IBusinessRuleClient.GetConfigurationAsync(CancellationToken)

Exceptions

ApiException

A server side error occurred.

PictureparkValidationException

Validation exception

PictureparkForbiddenException

Forbidden

PictureparkNotFoundException

Entity not found

PictureparkConflictException

Version conflict

PictureparkTooManyRequestsException

Too many requests

PictureparkException

Internal server error

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

Declaration

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

Type Parameters

RunScheduleAsync(BusinessRuleSchedule, CancellationToken)

Runs the supplied business rule schedule immediately.
Allows for testing of schedules.

Declaration

public virtual Task<BusinessProcess> RunScheduleAsync(BusinessRuleSchedule schedule, CancellationToken cancellationToken = default)

Parameters

BusinessRuleSchedule schedule

BusinessRuleSchedule

CancellationToken cancellationToken

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

Returns

Task<BusinessProcess>

BusinessProcess of the metadata operation triggered by the schedule.

Implements

IBusinessRuleClient.RunScheduleAsync(BusinessRuleSchedule, CancellationToken)

Exceptions

ApiException

A server side error occurred.

PictureparkValidationException

Validation exception

PictureparkForbiddenException

Forbidden

PictureparkNotFoundException

Entity not found

PictureparkConflictException

Version conflict

PictureparkTooManyRequestsException

Too many requests

PictureparkException

Internal server error

SearchTracesAsync(BusinessRuleTraceLogSearchRequest, CancellationToken)

Searches for trace logs produces by business rule execution.

Declaration

public virtual Task<BusinessRuleTraceLogSearchResult> SearchTracesAsync(BusinessRuleTraceLogSearchRequest request, CancellationToken cancellationToken = default)

Parameters

BusinessRuleTraceLogSearchRequest request

Request

CancellationToken cancellationToken

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

Returns

Task<BusinessRuleTraceLogSearchResult>

Holds results of trace log search.

Implements

IBusinessRuleClient.SearchTracesAsync(BusinessRuleTraceLogSearchRequest, CancellationToken)

Exceptions

ApiException

A server side error occurred.

PictureparkValidationException

Validation exception

PictureparkForbiddenException

Forbidden

PictureparkNotFoundException

Entity not found

PictureparkConflictException

Version conflict

PictureparkTooManyRequestsException

Too many requests

PictureparkException

Internal server error

UpdateConfigurationAsync(BusinessRuleConfigurationUpdateRequest, CancellationToken)

Updates the business rule configuration.

Declaration

public virtual Task<BusinessProcess> UpdateConfigurationAsync(BusinessRuleConfigurationUpdateRequest request, CancellationToken cancellationToken = default)