Show / Hide Table of Contents

Class TaskRun

The information about a task run.

Inheritance
object
TaskRun
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DataintegrationService.Models
Assembly: OCI.DotNetSDK.Dataintegration.dll
Syntax
public class TaskRun

Properties

AuthMode

Declaration
[JsonProperty(PropertyName = "authMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TaskRun.AuthModeEnum? AuthMode { get; set; }
Property Value
Type Description
TaskRun.AuthModeEnum?

The autorization mode for when the task was executed.

BytesProcessed

Declaration
[JsonProperty(PropertyName = "bytesProcessed")]
public long? BytesProcessed { get; set; }
Property Value
Type Description
long?

The number of bytes processed in the task run.

ConfigProvider

Declaration
[JsonProperty(PropertyName = "configProvider")]
public ConfigProvider ConfigProvider { get; set; }
Property Value
Type Description
ConfigProvider

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Detailed description for the object.

EndTimeMillis

Declaration
[JsonProperty(PropertyName = "endTimeMillis")]
public long? EndTimeMillis { get; set; }
Property Value
Type Description
long?

The end time.

ErrorMessage

Declaration
[JsonProperty(PropertyName = "errorMessage")]
public string ErrorMessage { get; set; }
Property Value
Type Description
string

Contains an error message if status is ERROR.

ExecutionErrors

Declaration
[JsonProperty(PropertyName = "executionErrors")]
public List<string> ExecutionErrors { get; set; }
Property Value
Type Description
List<string>

An array of execution errors from the run.

ExpectedDuration

Declaration
[JsonProperty(PropertyName = "expectedDuration")]
public double ExpectedDuration { get; set; }
Property Value
Type Description
double

The expected duration for the task run.

ExpectedDurationUnit

Declaration
[JsonProperty(PropertyName = "expectedDurationUnit")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TaskRun.ExpectedDurationUnitEnum? ExpectedDurationUnit { get; set; }
Property Value
Type Description
TaskRun.ExpectedDurationUnitEnum?

The expected duration unit of measure.

ExternalId

Declaration
[JsonProperty(PropertyName = "externalId")]
public string ExternalId { get; set; }
Property Value
Type Description
string

The external identifier for the task run.

Identifier

Declaration
[JsonProperty(PropertyName = "identifier")]
public string Identifier { get; set; }
Property Value
Type Description
string

Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified.

IsLogProcessingInProgress

Declaration
[JsonProperty(PropertyName = "isLogProcessingInProgress")]
public bool? IsLogProcessingInProgress { get; set; }
Property Value
Type Description
bool?

This field tells the user if there is any logs being fetched in backend for failure. Applicable only for failed pipeline tasks.

Key

Declaration
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type Description
string

The key of the object.

KeyMap

Declaration
[JsonProperty(PropertyName = "keyMap")]
public Dictionary<string, string> KeyMap { get; set; }
Property Value
Type Description
Dictionary<string, string>

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

LastUpdated

Declaration
[JsonProperty(PropertyName = "lastUpdated")]
public long? LastUpdated { get; set; }
Property Value
Type Description
long?

The date and time the object was last updated.

Metadata

Declaration
[JsonProperty(PropertyName = "metadata")]
public ObjectMetadata Metadata { get; set; }
Property Value
Type Description
ObjectMetadata

Metrics

Declaration
[JsonProperty(PropertyName = "metrics")]
public Dictionary<string, float> Metrics { get; set; }
Property Value
Type Description
Dictionary<string, float>

A map of metrics for the run.

ModelType

Declaration
[JsonProperty(PropertyName = "modelType")]
public string ModelType { get; set; }
Property Value
Type Description
string

The type of the object.

ModelVersion

Declaration
[JsonProperty(PropertyName = "modelVersion")]
public string ModelVersion { get; set; }
Property Value
Type Description
string

The model version of an object.

Name

Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

ObjectStatus

Declaration
[JsonProperty(PropertyName = "objectStatus")]
public int? ObjectStatus { get; set; }
Property Value
Type Description
int?

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

ObjectVersion

Declaration
[JsonProperty(PropertyName = "objectVersion")]
public int? ObjectVersion { get; set; }
Property Value
Type Description
int?

The version of the object that is used to track changes in the object instance.

OpcRequestId

Declaration
[JsonProperty(PropertyName = "opcRequestId")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

The OPC request ID of execution of the task run.

Outputs

Declaration
[JsonProperty(PropertyName = "outputs")]
public Dictionary<string, ParameterValue> Outputs { get; set; }
Property Value
Type Description
Dictionary<string, ParameterValue>

A map of the outputs of the run.

ParentRef

Declaration
[JsonProperty(PropertyName = "parentRef")]
public ParentReference ParentRef { get; set; }
Property Value
Type Description
ParentReference

RecordsWritten

Declaration
[JsonProperty(PropertyName = "recordsWritten")]
public long? RecordsWritten { get; set; }
Property Value
Type Description
long?

The number of records processed in the task run.

RetryAttempt

Declaration
[JsonProperty(PropertyName = "retryAttempt")]
public int? RetryAttempt { get; set; }
Property Value
Type Description
int?

Holds the particular attempt number.

StartTimeMillis

Declaration
[JsonProperty(PropertyName = "startTimeMillis")]
public long? StartTimeMillis { get; set; }
Property Value
Type Description
long?

The start time.

Status

Declaration
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TaskRun.StatusEnum? Status { get; set; }
Property Value
Type Description
TaskRun.StatusEnum?

The status of the task run.

TaskKey

Declaration
[JsonProperty(PropertyName = "taskKey")]
public string TaskKey { get; set; }
Property Value
Type Description
string

Task Key of the task for which TaskRun is being created. If not specified, the AggregatorKey in RegistryMetadata will be assumed to be the TaskKey

TaskSchedule

Declaration
[JsonProperty(PropertyName = "taskSchedule")]
public TaskSchedule TaskSchedule { get; set; }
Property Value
Type Description
TaskSchedule

TaskType

Declaration
[JsonProperty(PropertyName = "taskType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TaskRun.TaskTypeEnum? TaskType { get; set; }
Property Value
Type Description
TaskRun.TaskTypeEnum?

The type of task run.

TerminationErrors

Declaration
[JsonProperty(PropertyName = "terminationErrors")]
public List<string> TerminationErrors { get; set; }
Property Value
Type Description
List<string>

An array of termination errors from the run.

In this article
Back to top