Class Pipeline

A Pipeline to orchestrate and execute machine learning workflows.

Inheritance

object

Pipeline

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatascienceService.Models

Assembly: OCI.DotNetSDK.Datascience.dll

Syntax

public class Pipeline

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.

Remarks

Required

ConfigurationDetails

Declaration

[JsonProperty(PropertyName = "configurationDetails")]
public PipelineConfigurationDetails ConfigurationDetails { 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.

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"}}

Description

Declaration

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

Property Value

Type	Description
string	A short description of the pipeline.

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.

Remarks

Required

InfrastructureConfigurationDetails

Declaration

[JsonProperty(PropertyName = "infrastructureConfigurationDetails")]
public PipelineInfrastructureConfigurationDetails InfrastructureConfigurationDetails { get; set; }

Property Value

Type	Description
PipelineInfrastructureConfigurationDetails

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 PipelineLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
PipelineLifecycleState?	The current state of the pipeline.

Remarks

Required

LogConfigurationDetails

Declaration

[JsonProperty(PropertyName = "logConfigurationDetails")]
public PipelineLogConfigurationDetails LogConfigurationDetails { get; set; }

Property Value

Type	Description
PipelineLogConfigurationDetails

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

Remarks

Required

StepDetails

Declaration

[Required(ErrorMessage = "StepDetails is required.")]
[JsonProperty(PropertyName = "stepDetails")]
public List<PipelineStepDetails> StepDetails { get; set; }

Property Value

Type	Description
List<PipelineStepDetails>	Array of step details for each step.

Remarks

Required

StorageMountConfigurationDetailsList

Declaration

[JsonProperty(PropertyName = "storageMountConfigurationDetailsList")]
public List<StorageMountConfigurationDetails> StorageMountConfigurationDetailsList { get; set; }

Property Value

Type	Description
List<StorageMountConfigurationDetails>	The storage mount details to mount to the instance running the pipeline step.

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"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the resource was updated in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z