Interface IOneComputePlatformClient

Defines the client interface to the One Compute Platform.

Inherited Members

IJobSchedulingClient.SubmitJobAsync(Job, CancellationToken)

IJobSchedulingClient.SubmitJob(Job)

IJobSchedulingClient.CancelJobAsync(String)

IJobSchedulingClient.CancelJob(String)

IJobSchedulingClient.GetJobsAsync()

IJobSchedulingClient.GetJobs()

IJobSchedulingClient.GetJobStatusAsync(String)

IJobSchedulingClient.GetJobStatus(String)

IJobSchedulingClient.GetWorkItemInfoAsync(String)

IJobSchedulingClient.GetWorkItemInfo(String)

IJobSchedulingClient.GetJobPropertiesAsync()

IJobSchedulingClient.GetJobPropertiesInSegmentsAsync(String)

IJobSchedulingClient.GetJobProperties()

IJobSchedulingClient.GetJobPropertiesInSegments(String)

IJobSchedulingClient.GetJobPropertiesAsync(String)

IJobSchedulingClient.GetJobProperties(String)

IJobSchedulingClient.GetWorkItemPropertiesAsync(String)

IJobSchedulingClient.GetWorkItemProperties(String)

IJobSchedulingClient.GetWorkItemPropertiesAsync(String, String)

IJobSchedulingClient.GetWorkItemProperties(String, String)

IJobSchedulingClient.GetWorkItemInfoAsync(String, String)

IJobSchedulingClient.GetWorkItemInfo(String, String)

IJobSchedulingClient.GetWorkItemResultsAsync(String)

IJobSchedulingClient.GetWorkItemResults(String)

IJobSchedulingClient.GetWorkItemResultAsync(String, String)

IJobSchedulingClient.GetWorkItemResult(String, String)

Namespace: DNVGL.One.Compute.Core.PlatformClient

Assembly: DNVGL.One.Compute.Core.dll

Syntax

public interface IOneComputePlatformClient : IJobSchedulingClient

Methods

CreateBlobUris(String, IEnumerable<String>)

Creates the BLOB uris for the given blobs.

Declaration

IEnumerable<Uri> CreateBlobUris(string containerName, IEnumerable<string> blobPaths)

Parameters

Type	Name	Description
System.String	containerName	Name of the container.
IEnumerable<System.String>	blobPaths	The BLOB paths.

Returns

Type	Description
IEnumerable<Uri>	A set of URIs for the blobPaths.

CreateBlobUrisAsync(String, IEnumerable<String>)

Creates the BLOB uris for the given blobs.

Declaration

Task<IEnumerable<Uri>> CreateBlobUrisAsync(string containerName, IEnumerable<string> blobPaths)

Parameters

Type	Name	Description
System.String	containerName	Name of the container.
IEnumerable<System.String>	blobPaths	The BLOB paths.

Returns

Type	Description
Task<IEnumerable<Uri>>	A set of URIs for the blobPaths.

DeleteJob(String)

Deletes a job.

Declaration

void DeleteJob(string jobId)

Parameters

Type	Name	Description
System.String	jobId	The job id.

DeleteJobAsync(String)

Deletes a job.

Declaration

Task DeleteJobAsync(string jobId)

Parameters

Type	Name	Description
System.String	jobId	The job id.

Returns

Type	Description
Task	The delete task.

Remarks

The returned task ends when the job has been deleted with the backend services.

GetContainers()

Gets the containers the user has access to.

Declaration

IEnumerable<string> GetContainers()

Returns

Type	Description
IEnumerable<System.String>	Names of containers the user has access to.

GetContainersAsync()

Gets the containers the user has access to.

Declaration

Task<IEnumerable<string>> GetContainersAsync()

Returns

Type	Description
Task<IEnumerable<System.String>>	Names of containers the user has access to.

GetContainerUri(String, Nullable<Int32>)

Gets the container URI to the given container.

Declaration

Uri GetContainerUri(string containerName, int? days = null)

Parameters

Type	Name	Description
System.String	containerName	Name of the container.
System.Nullable<System.Int32>	days	Number of days until the container (shared access signature) URI expires.

Returns

Type	Description
Uri	URI to the container including shared access signature, null if the container is not found.

GetContainerUriAsync(String, Nullable<Int32>)

Gets the container URI to the given container.

Declaration

Task<Uri> GetContainerUriAsync(string containerName, int? days = null)

Parameters

Type	Name	Description
System.String	containerName	Name of the container.
System.Nullable<System.Int32>	days	Number of days until the container (shared access signature) URI expires.

Returns

Type	Description
Task<Uri>	URI to the container including shared access signature, null if the container is not found.

GetContainerUriReadOnly(String, Nullable<Int32>)

Gets the container URI to the given container, with read-only access permissions only.

Declaration

Uri GetContainerUriReadOnly(string containerName, int? days = null)

Parameters

Type	Name	Description
System.String	containerName	Name of the container.
System.Nullable<System.Int32>	days	Number of days until the container (shared access signature) URI expires.

Returns

Type	Description
Uri	Read-only URI to the container including shared access signature, null if the container is not found.

GetContainerUriReadOnlyAsync(String, Nullable<Int32>)

Gets the container URI to the given container, with read-only access permissions only.

Declaration

Task<Uri> GetContainerUriReadOnlyAsync(string containerName, int? days = null)

Parameters

Type	Name	Description
System.String	containerName	Name of the container.
System.Nullable<System.Int32>	days	Number of days until the container (shared access signature) URI expires.

Returns

Type	Description
Task<Uri>	Read-only URI to the container including shared access signature, null if the container is not found.

GetWorkItemStorageContainerUri(String, String, String)

Gets the work item storage container URI with access (SAS) token.

Declaration

Uri GetWorkItemStorageContainerUri(string jobId, string workUnitId, string containerName)

Parameters

Type	Name	Description
System.String	jobId	The job identifier.
System.String	workUnitId	The work unit identifier.
System.String	containerName	Name of the container.

Returns

Type	Description
Uri	A container URI with a valid SAS token.

GetWorkItemStorageContainerUriAsync(String, String, String)

Gets the work item storage container URI with access (SAS) token.

Declaration

Task<Uri> GetWorkItemStorageContainerUriAsync(string jobId, string workUnitId, string containerName)

Parameters

Type	Name	Description
System.String	jobId	The job identifier.
System.String	workUnitId	The work unit identifier.
System.String	containerName	Name of the container.

Returns

Type	Description
Task<Uri>	A container URI with a valid SAS token.

GetWorkItemStorageInfo(String, String)

Gets storage information for all work items in the given job.

Declaration

IEnumerable<WorkItemStorageInfo> GetWorkItemStorageInfo(string jobId, string containerName)

Parameters

Type	Name	Description
System.String	jobId	The job identifier.
System.String	containerName	Name of the container.

Returns

Type	Description
IEnumerable<WorkItemStorageInfo>	A collection of WorkItemStorageInfo, one for each work unit in the job, containing container URIs with a valid SAS tokens.

Remarks

The returned storage information contains storage container URIs, with access (SAS) token to access the storage container that contains the result files from the work item. Only work items that have uploaded results to Result Lake will be listed.

GetWorkItemStorageInfoAsync(String, String)

Gets storage information for all work items in the given job.

Declaration

Task<IEnumerable<WorkItemStorageInfo>> GetWorkItemStorageInfoAsync(string jobId, string containerName)

Parameters

Type	Name	Description
System.String	jobId	The job identifier.
System.String	containerName	Name of the container.

Returns

Type	Description
Task<IEnumerable<WorkItemStorageInfo>>	A collection of WorkItemStorageInfo, one for each work unit in the job, containing container URIs with a valid SAS tokens.

Remarks

The returned storage information contains storage container URIs, with access (SAS) token to access the storage container that contains the result files from the work item. Only work items that have uploaded results to Result Lake will be listed.