Class PipelineRun
Description of PipelineRun.
Inherited Members
Namespace: Oci.DatascienceService.Models
Assembly: OCI.DotNetSDK.Datascience.dll
Syntax
public class PipelineRun
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment where you want to create the pipeline run. |
Remarks
Required
ConfigurationDetails
Declaration
[JsonProperty(PropertyName = "configurationDetails")]
public PipelineConfigurationDetails ConfigurationDetails { get; set; }
Property Value
Type | Description |
---|---|
PipelineConfigurationDetails |
ConfigurationOverrideDetails
Declaration
[JsonProperty(PropertyName = "configurationOverrideDetails")]
public PipelineConfigurationDetails ConfigurationOverrideDetails { get; set; }
Property Value
Type | Description |
---|---|
PipelineConfigurationDetails |
CreatedBy
Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the user who created the pipeline run. |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations": {"CostCenter": "42"}} |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly display name for the resource. |
Remarks
Required
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"} |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the pipeline run. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
string | A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PipelineRunLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
PipelineRunLifecycleState? | The current state of the pipeline run. |
Remarks
Required
LogConfigurationOverrideDetails
Declaration
[JsonProperty(PropertyName = "logConfigurationOverrideDetails")]
public PipelineLogConfigurationDetails LogConfigurationOverrideDetails { get; set; }
Property Value
Type | Description |
---|---|
PipelineLogConfigurationDetails |
LogDetails
Declaration
[JsonProperty(PropertyName = "logDetails")]
public PipelineRunLogDetails LogDetails { get; set; }
Property Value
Type | Description |
---|---|
PipelineRunLogDetails |
PipelineId
Declaration
[Required(ErrorMessage = "PipelineId is required.")]
[JsonProperty(PropertyName = "pipelineId")]
public string PipelineId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the pipeline. |
Remarks
Required
ProjectId
Declaration
[Required(ErrorMessage = "ProjectId is required.")]
[JsonProperty(PropertyName = "projectId")]
public string ProjectId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the project to associate the pipeline run with. |
Remarks
Required
StepOverrideDetails
Declaration
[JsonProperty(PropertyName = "stepOverrideDetails")]
public List<PipelineStepOverrideDetails> StepOverrideDetails { get; set; }
Property Value
Type | Description |
---|---|
List<PipelineStepOverrideDetails> | Array of step override details. Only Step Configuration is allowed to be overridden. |
StepRuns
Declaration
[Required(ErrorMessage = "StepRuns is required.")]
[JsonProperty(PropertyName = "stepRuns")]
public List<PipelineStepRun> StepRuns { get; set; }
Property Value
Type | Description |
---|---|
List<PipelineStepRun> | Array of StepRun object for each step. |
Remarks
Required
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
TimeAccepted
Declaration
[Required(ErrorMessage = "TimeAccepted is required.")]
[JsonProperty(PropertyName = "timeAccepted")]
public DateTime? TimeAccepted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the pipeline run was accepted in the timestamp format defined by RFC3339. |
Remarks
Required
TimeFinished
Declaration
[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the pipeline run request was finished in the timestamp format defined by RFC3339. |
TimeStarted
Declaration
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the pipeline run request was started in the timestamp format defined by RFC3339. |
TimeUpdated
Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the pipeline run was updated in the timestamp format defined by RFC3339. |