Show / Hide Table of Contents

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

GetJobPropertiesAsync(String)

Gets the properties for a given job.

Declaration
Task<JobProperties> GetJobPropertiesAsync(string jobId)
Parameters
Type Name Description
System.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
System.String userId

The user identifier.

Returns
Type Description
Task<IEnumerable<JobProperties>>

The job properties of the user's jobs.

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
System.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
System.String jobId

The job identifier.

System.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 .

  • View Source
Back to top Copyright © DNV GL AS. All rights reserved.