Class PipelineSummary
The pipeline summary type contains the audit summary information and the definition of the pipeline.
Inheritance
PipelineSummary
Assembly: OCI.DotNetSDK.Dataintegration.dll
Syntax
public class PipelineSummary
Properties
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type |
Description |
string |
Detailed description for the object.
|
FlowConfigValues
Declaration
[JsonProperty(PropertyName = "flowConfigValues")]
public ConfigValues FlowConfigValues { get; set; }
Property Value
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.
|
Key
Declaration
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type |
Description |
string |
Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create.
|
Declaration
[JsonProperty(PropertyName = "metadata")]
public ObjectMetadata Metadata { get; set; }
Property Value
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 |
This is a version number that is used by the service to upgrade objects if needed through releases of the service.
|
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.
|
Nodes
Declaration
[JsonProperty(PropertyName = "nodes")]
public List<FlowNode> Nodes { get; set; }
Property Value
Type |
Description |
List<FlowNode> |
A list of nodes attached to the pipeline.
|
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? |
This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.
|
Parameters
Declaration
[JsonProperty(PropertyName = "parameters")]
public List<Parameter> Parameters { get; set; }
Property Value
Type |
Description |
List<Parameter> |
A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.
|
ParentRef
Declaration
[JsonProperty(PropertyName = "parentRef")]
public ParentReference ParentRef { get; set; }
Property Value
Variables
Declaration
[JsonProperty(PropertyName = "variables")]
public List<Variable> Variables { get; set; }
Property Value
Type |
Description |
List<Variable> |
The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline.
|