Interface IJobPropertiesService

Service for storing and retrieving application properties for a job.

Namespace: DNVGL.One.Compute.Core.JobProperties

Assembly: DNVGL.One.Compute.Core.dll

Syntax

public interface IJobPropertiesService

Methods

View Source

DeleteJobPropertiesAsync(string)

Deletes the job and work item properties for the given job.

Declaration

Task DeleteJobPropertiesAsync(string jobId)

Parameters

Type	Name	Description
string	jobId	The job identifier.

Returns

Type	Description
Task	Asynchronous Task.

View Source

GetJobPropertiesAsync(string)

Gets the properties for a given job.

Declaration

Task<JobProperties> GetJobPropertiesAsync(string jobId)

Parameters

Type	Name	Description
string	jobId	The job identifier.

Returns

Type	Description
Task<JobProperties>	Properties for the job.

View Source

GetJobPropertiesForUserAsync(string)

Gets the job properties for all jobs of the given user.

Declaration

Task<IEnumerable<JobProperties>> GetJobPropertiesForUserAsync(string userId)

Parameters

Type	Name	Description
string	userId	The user identifier.

Returns

Type	Description
Task<IEnumerable<JobProperties>>	The job properties of the user's jobs.

View Source

GetJobPropertiesForUserInSegmentsAsync(string, object)

Gets the job properties of jobs in segments for the specified given user and continuation token.

Declaration

Task<(IEnumerable<JobProperties> JobProperties, object ContinuationToken)> GetJobPropertiesForUserInSegmentsAsync(string userId, object continuationToken = null)

Parameters

Type	Name	Description
string	userId	The user identifier.
object	continuationToken	An object representing a continuation token from the server when the operation returns a partial result.

Returns

Type	Description
Task<(IEnumerable<JobProperties> JobProperties, object ContinuationToken)>	A tuple consists of IEnumerable<T> where T is JobProperties and continuation token.

View Source

GetJobPropertiesUsingTableFilterAsync(string)

Gets the job properties for all jobs that matches the specified table filter criteria.

Declaration

Task<IEnumerable<JobProperties>> GetJobPropertiesUsingTableFilterAsync(string tableFilter)

Parameters

Type	Name	Description
string	tableFilter	The table filter.

Returns

Type	Description
Task<IEnumerable<JobProperties>>	An instance of IEnumerable<T> where T is JobProperties.

View Source

GetJobPropertiesUsingTableFilterInSegmentsAsync(string, object)

Gets the job properties for all jobs in segments based on the specified table filter criteria and continuation token.

Declaration

Task<(IEnumerable<JobProperties> JobProperties, object ContinuationToken)> GetJobPropertiesUsingTableFilterInSegmentsAsync(string tableFilter, object continuationToken = null)

Parameters

Type	Name	Description
string	tableFilter	The table filter.
object	continuationToken	An object representing a continuation token from the server when the operation returns a partial result.

Returns

Type	Description
Task<(IEnumerable<JobProperties> JobProperties, object ContinuationToken)>	A tuple consists of IEnumerable<T> where T is JobProperties and continuation token.

View Source

GetWorkItemProperties(string)

Gets the properties for all work items in the job.

Declaration

Task<IEnumerable<WorkItemProperties>> GetWorkItemProperties(string jobId)

Parameters

Type	Name	Description
string	jobId	The job identifier.

Returns

Type	Description
Task<IEnumerable<WorkItemProperties>>	A collection of WorkItemProperties.

View Source

GetWorkItemProperties(string, string)

Gets the properties for a specified work item in the given job.

Declaration

Task<WorkItemProperties> GetWorkItemProperties(string jobId, string workItemId)

Parameters

Type	Name	Description
string	jobId	The job identifier.
string	workItemId	The work item identifier.

Returns

Type	Description
Task<WorkItemProperties>	WorkItemProperties for the given `workItemId`.

View Source

SaveJobPropertiesAsync(Job)

Saves the job properties.

Declaration

Task SaveJobPropertiesAsync(Job job)

Parameters

Type	Name	Description
Job	job	The job.

Returns

Type	Description
Task	Asynchronous Task.

View Source

SaveWorkItemProperties(WorkItem)

Saves the work item properties.

Declaration

Task SaveWorkItemProperties(WorkItem workItem)

Parameters

Type	Name	Description
WorkItem	workItem	The work item.

Returns

Type	Description
Task	Asynchronous Task.

View Source

UpdateJobPropertiesAsync(JobProperties)

Updates the job properties.

Declaration

Task UpdateJobPropertiesAsync(JobProperties jobProperties)

Parameters

Type	Name	Description
JobProperties	jobProperties	The JobProperties.

Returns

Type	Description
Task	Asynchronous Task.