Show / Hide Table of Contents

Class Pipeline

Represents the metadata details of a pipeline in the same compartment.

Inheritance
object
Pipeline
ZeroEtlPipeline
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GoldengateService.Models
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
[JsonConverter(typeof(PipelineModelConverter))]
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 being referenced.

Remarks

Required

CpuCoreCount

Declaration
[Required(ErrorMessage = "CpuCoreCount is required.")]
[JsonProperty(PropertyName = "cpuCoreCount")]
public int? CpuCoreCount { get; set; }
Property Value
Type Description
int?

The Minimum number of OCPUs to be made available for this Deployment.

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

Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: {"foo-namespace": {"bar-key": "value"}}

Description

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

Metadata about this specific object.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

An object's Display Name.

Remarks

Required

FreeformTags

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

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: {"bar-key": "value"}

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. This option applies when retrieving a pipeline.

Remarks

Required

IsAutoScalingEnabled

Declaration
[Required(ErrorMessage = "IsAutoScalingEnabled is required.")]
[JsonProperty(PropertyName = "isAutoScalingEnabled")]
public bool? IsAutoScalingEnabled { get; set; }
Property Value
Type Description
bool?

Indicates if auto scaling is enabled for the Deployment's CPU core count.

Remarks

Required

LicenseModel

Declaration
[Required(ErrorMessage = "LicenseModel is required.")]
[JsonProperty(PropertyName = "licenseModel")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LicenseModel? LicenseModel { get; set; }
Property Value
Type Description
LicenseModel?

The Oracle license model that applies to a Deployment.

Remarks

Required

LifecycleDetails

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

Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Pipeline.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Pipeline.LifecycleStateEnum?

Lifecycle state of the pipeline.

Remarks

Required

LifecycleSubState

Declaration
[JsonProperty(PropertyName = "lifecycleSubState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PipelineLifecycleSubState? LifecycleSubState { get; set; }
Property Value
Type Description
PipelineLifecycleSubState?

Possible lifecycle substates when retrieving a pipeline.

Locks

Declaration
[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }
Property Value
Type Description
List<ResourceLock>

Locks associated with this resource.

PipelineDiagnosticData

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

SourceConnectionDetails

Declaration
[Required(ErrorMessage = "SourceConnectionDetails is required.")]
[JsonProperty(PropertyName = "sourceConnectionDetails")]
public SourcePipelineConnectionDetails SourceConnectionDetails { get; set; }
Property Value
Type Description
SourcePipelineConnectionDetails
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>>

The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: {orcl-cloud: {free-tier-retain: true}}

TargetConnectionDetails

Declaration
[Required(ErrorMessage = "TargetConnectionDetails is required.")]
[JsonProperty(PropertyName = "targetConnectionDetails")]
public TargetPipelineConnectionDetails TargetConnectionDetails { get; set; }
Property Value
Type Description
TargetPipelineConnectionDetails
Remarks

Required

TimeCreated

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

The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Remarks

Required

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Remarks

Required

In this article
Back to top