Class TaskuraiLocksClient

A TaskuraiLocksClient provides access to the Taskurai State api.

Assembly: Taskurai.dll

Declaration

public class TaskuraiLocksClient : TaskuraiBaseClient

Inheritance: System.Object -> Taskurai.TaskuraiBaseClient

Methods

AcquireLock(LockInput, CancellationToken)

Acquire a new distributed lock.

Required scope: Data/Buildby.Taskurai/locks/create.

Declaration

public virtual LockResponse AcquireLock(LockInput input, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.LockResponse: Taskurai.Models.LockResponse

Parameters

Type	Name	Description
Taskurai.Models.LockInput	input	Taskurai.Models.LockInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

AcquireLock(string, string, TimeSpan, TimeSpan, bool, ILogger, CancellationToken)

Acquire a distributed lock.

Required scope: Data/Buildby.Taskurai/locks/create.

Declaration

public TaskuraiDistributedLock AcquireLock(string lockId, string owner, TimeSpan ttl, TimeSpan timeout, bool skipIsolationMode = false, ILogger log = null, CancellationToken cancellationToken = default)

Returns

Taskurai.TaskuraiDistributedLock: Taskurai.TaskuraiDistributedLock

Parameters

Type	Name	Description
System.String	lockId	Lock id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.String	owner	Owner of the lock.
System.TimeSpan	ttl	Lock lease time-to-live.
System.TimeSpan	timeout	Timeout, waiting to acquire lock.
System.Boolean	skipIsolationMode	Skip isolation mode (defaults to global isolation mode).
Microsoft.Extensions.Logging.ILogger	log	Microsoft.Extensions.Logging.ILogger
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

AcquireLockAsync(LockInput, CancellationToken)

Acquire a new distributed lock.

Required scope: Data/Buildby.Taskurai/locks/create.

Declaration

public virtual Task<LockResponse> AcquireLockAsync(LockInput input, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.LockResponse>: Taskurai.Models.LockResponse

Parameters

Type	Name	Description
Taskurai.Models.LockInput	input	Taskurai.Models.LockInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

AcquireLockAsync(string, string, TimeSpan, TimeSpan, bool, ILogger, CancellationToken)

Acquire a distributed lock.

Required scope: Data/Buildby.Taskurai/locks/create.

Declaration

public Task<TaskuraiDistributedLock> AcquireLockAsync(string lockId, string owner, TimeSpan ttl, TimeSpan timeout, bool skipIsolationMode = false, ILogger log = null, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.TaskuraiDistributedLock>: Taskurai.TaskuraiDistributedLock

Parameters

Type	Name	Description
System.String	lockId	Lock id (only alphanumeric characters, dot, underscore and hyphens are allowed).
System.String	owner	Owner of the lock.
System.TimeSpan	ttl	Lock lease time-to-live.
System.TimeSpan	timeout	Timeout, waiting to acquire lock.
System.Boolean	skipIsolationMode	Skip isolation mode (defaults to global isolation mode).
Microsoft.Extensions.Logging.ILogger	log	Microsoft.Extensions.Logging.ILogger
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

LookupLock(LockLookupInput, CancellationToken)

Lookup a distributed lock.

Required scope: Data/Buildby.Taskurai/locks/read.

Declaration

public virtual LockResponse LookupLock(LockLookupInput input, CancellationToken cancellationToken = default)

Returns

Taskurai.Models.LockResponse: Taskurai.Models.LockResponse

Parameters

Type	Name	Description
Taskurai.Models.LockLookupInput	input	Taskurai.Models.LockLookupInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

LookupLockAsync(LockLookupInput, CancellationToken)

Lookup a distributed lock.

Required scope: Data/Buildby.Taskurai/locks/read.

Declaration

public virtual Task<LockResponse> LookupLockAsync(LockLookupInput input, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task<Taskurai.Models.LockResponse>: Taskurai.Models.LockResponse

Parameters

Type	Name	Description
Taskurai.Models.LockLookupInput	input	Taskurai.Models.LockLookupInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ReleaseLock(LockReleaseInput, CancellationToken)

Delete a lock entry.

Required scope: Data/Buildby.Taskurai/locks/delete.

Declaration

public virtual void ReleaseLock(LockReleaseInput input, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Taskurai.Models.LockReleaseInput	input	Taskurai.Models.LockReleaseInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.

ReleaseLockAsync(LockReleaseInput, CancellationToken)

Delete a lock entry.

Required scope: Data/Buildby.Taskurai/locks/delete.

Declaration

public virtual Task ReleaseLockAsync(LockReleaseInput input, CancellationToken cancellationToken = default)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name	Description
Taskurai.Models.LockReleaseInput	input	Taskurai.Models.LockReleaseInput.
System.Threading.CancellationToken	cancellationToken	System.Threading.CancellationToken

Exceptions

Azure.RequestFailedException
Throws if request fails.