Pipeline

class oci.golden_gate.models.Pipeline(**kwargs)

Bases: object

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

Attributes:

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE

A constant which can be used with the license_model property of a Pipeline.

LICENSE_MODEL_LICENSE_INCLUDED

A constant which can be used with the license_model property of a Pipeline.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Pipeline.

LIFECYCLE_SUB_STATE_MOVING

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_PAUSED

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_PAUSE_FAILED

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_PAUSING

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_RUNNING

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_STARTING

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_START_FAILED

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_STOPPED

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_STOPPING

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

LIFECYCLE_SUB_STATE_STOP_FAILED

A constant which can be used with the lifecycle_sub_state property of a Pipeline.

RECIPE_TYPE_ZERO_ETL

A constant which can be used with the recipe_type property of a Pipeline.

compartment_id

[Required] Gets the compartment_id of this Pipeline.

cpu_core_count

[Required] Gets the cpu_core_count of this Pipeline.

defined_tags

Gets the defined_tags of this Pipeline.

description

Gets the description of this Pipeline.

display_name

[Required] Gets the display_name of this Pipeline.

freeform_tags

Gets the freeform_tags of this Pipeline.

id

[Required] Gets the id of this Pipeline.

ingress_ips

Gets the ingress_ips of this Pipeline.

is_auto_scaling_enabled

[Required] Gets the is_auto_scaling_enabled of this Pipeline.

license_model

[Required] Gets the license_model of this Pipeline.

lifecycle_details

Gets the lifecycle_details of this Pipeline.

lifecycle_state

[Required] Gets the lifecycle_state of this Pipeline.

lifecycle_sub_state

Gets the lifecycle_sub_state of this Pipeline.

locks

Gets the locks of this Pipeline.

pipeline_diagnostic_data

Gets the pipeline_diagnostic_data of this Pipeline.

recipe_type

[Required] Gets the recipe_type of this Pipeline.

source_connection_details

[Required] Gets the source_connection_details of this Pipeline.

subnet_id

Gets the subnet_id of this Pipeline.

system_tags

Gets the system_tags of this Pipeline.

target_connection_details

[Required] Gets the target_connection_details of this Pipeline.

time_created

[Required] Gets the time_created of this Pipeline.

time_updated

[Required] Gets the time_updated of this Pipeline.

Methods:

__init__(**kwargs)

Initializes a new Pipeline object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'

A constant which can be used with the license_model property of a Pipeline. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'

A constant which can be used with the license_model property of a Pipeline. This constant has a value of “LICENSE_INCLUDED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “UPDATING”

LIFECYCLE_SUB_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “MOVING”

LIFECYCLE_SUB_STATE_PAUSED = 'PAUSED'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “PAUSED”

LIFECYCLE_SUB_STATE_PAUSE_FAILED = 'PAUSE_FAILED'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “PAUSE_FAILED”

LIFECYCLE_SUB_STATE_PAUSING = 'PAUSING'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “PAUSING”

LIFECYCLE_SUB_STATE_RUNNING = 'RUNNING'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “RUNNING”

LIFECYCLE_SUB_STATE_STARTING = 'STARTING'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “STARTING”

LIFECYCLE_SUB_STATE_START_FAILED = 'START_FAILED'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “START_FAILED”

LIFECYCLE_SUB_STATE_STOPPED = 'STOPPED'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “STOPPED”

LIFECYCLE_SUB_STATE_STOPPING = 'STOPPING'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “STOPPING”

LIFECYCLE_SUB_STATE_STOP_FAILED = 'STOP_FAILED'

A constant which can be used with the lifecycle_sub_state property of a Pipeline. This constant has a value of “STOP_FAILED”

RECIPE_TYPE_ZERO_ETL = 'ZERO_ETL'

A constant which can be used with the recipe_type property of a Pipeline. This constant has a value of “ZERO_ETL”

__init__(**kwargs)

Initializes a new Pipeline object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • recipe_type (str) – The value to assign to the recipe_type property of this Pipeline. Allowed values for this property are: “ZERO_ETL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • id (str) – The value to assign to the id property of this Pipeline.

  • display_name (str) – The value to assign to the display_name property of this Pipeline.

  • description (str) – The value to assign to the description property of this Pipeline.

  • compartment_id (str) – The value to assign to the compartment_id property of this Pipeline.

  • license_model (str) – The value to assign to the license_model property of this Pipeline. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • cpu_core_count (int) – The value to assign to the cpu_core_count property of this Pipeline.

  • is_auto_scaling_enabled (bool) – The value to assign to the is_auto_scaling_enabled property of this Pipeline.

  • source_connection_details (oci.golden_gate.models.SourcePipelineConnectionDetails) – The value to assign to the source_connection_details property of this Pipeline.

  • target_connection_details (oci.golden_gate.models.TargetPipelineConnectionDetails) – The value to assign to the target_connection_details property of this Pipeline.

  • pipeline_diagnostic_data (oci.golden_gate.models.PipelineDiagnosticData) – The value to assign to the pipeline_diagnostic_data property of this Pipeline.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Pipeline.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Pipeline.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Pipeline.

  • locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this Pipeline.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Pipeline. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_sub_state (str) – The value to assign to the lifecycle_sub_state property of this Pipeline. Allowed values for this property are: “STARTING”, “STOPPING”, “STOPPED”, “MOVING”, “RUNNING”, “PAUSING”, “PAUSED”, “START_FAILED”, “STOP_FAILED”, “PAUSE_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Pipeline.

  • time_created (datetime) – The value to assign to the time_created property of this Pipeline.

  • time_updated (datetime) – The value to assign to the time_updated property of this Pipeline.

  • subnet_id (str) – The value to assign to the subnet_id property of this Pipeline.

  • ingress_ips (list[oci.golden_gate.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this Pipeline.

property compartment_id

[Required] Gets the compartment_id of this Pipeline. The OCID of the compartment being referenced.

Returns

The compartment_id of this Pipeline.

Return type

str

property cpu_core_count

[Required] Gets the cpu_core_count of this Pipeline. The Minimum number of OCPUs to be made available for this Deployment.

Returns

The cpu_core_count of this Pipeline.

Return type

int

property defined_tags

Gets the defined_tags of this Pipeline. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this Pipeline.

Return type

dict(str, dict(str, object))

property description

Gets the description of this Pipeline. Metadata about this specific object.

Returns

The description of this Pipeline.

Return type

str

property display_name

[Required] Gets the display_name of this Pipeline. An object’s Display Name.

Returns

The display_name of this Pipeline.

Return type

str

property freeform_tags

Gets the freeform_tags of this Pipeline. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns

The freeform_tags of this Pipeline.

Return type

dict(str, str)

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property id

[Required] Gets the id of this Pipeline. The OCID of the pipeline. This option applies when retrieving a pipeline.

Returns

The id of this Pipeline.

Return type

str

property ingress_ips

Gets the ingress_ips of this Pipeline. List of ingress IP addresses from where the GoldenGate deployment connects to this connection’s privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

Returns

The ingress_ips of this Pipeline.

Return type

list[oci.golden_gate.models.IngressIpDetails]

property is_auto_scaling_enabled

[Required] Gets the is_auto_scaling_enabled of this Pipeline. Indicates if auto scaling is enabled for the Deployment’s CPU core count.

Returns

The is_auto_scaling_enabled of this Pipeline.

Return type

bool

property license_model

[Required] Gets the license_model of this Pipeline. The Oracle license model that applies to a Deployment.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The license_model of this Pipeline.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Pipeline. 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.

Returns

The lifecycle_details of this Pipeline.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Pipeline. Lifecycle state of the pipeline.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Pipeline.

Return type

str

property lifecycle_sub_state

Gets the lifecycle_sub_state of this Pipeline. Possible lifecycle substates when retrieving a pipeline.

Allowed values for this property are: “STARTING”, “STOPPING”, “STOPPED”, “MOVING”, “RUNNING”, “PAUSING”, “PAUSED”, “START_FAILED”, “STOP_FAILED”, “PAUSE_FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_sub_state of this Pipeline.

Return type

str

property locks

Gets the locks of this Pipeline. Locks associated with this resource.

Returns

The locks of this Pipeline.

Return type

list[oci.golden_gate.models.ResourceLock]

property pipeline_diagnostic_data

Gets the pipeline_diagnostic_data of this Pipeline.

Returns

The pipeline_diagnostic_data of this Pipeline.

Return type

oci.golden_gate.models.PipelineDiagnosticData

property recipe_type

[Required] Gets the recipe_type of this Pipeline. The type of the recipe

Allowed values for this property are: “ZERO_ETL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The recipe_type of this Pipeline.

Return type

str

property source_connection_details

[Required] Gets the source_connection_details of this Pipeline.

Returns

The source_connection_details of this Pipeline.

Return type

oci.golden_gate.models.SourcePipelineConnectionDetails

property subnet_id

Gets the subnet_id of this Pipeline. The OCID of the subnet of the pipeline’s private endpoint. The subnet must be a private subnet.

Returns

The subnet_id of this Pipeline.

Return type

str

property system_tags

Gets the system_tags of this Pipeline. 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}}

Returns

The system_tags of this Pipeline.

Return type

dict(str, dict(str, object))

property target_connection_details

[Required] Gets the target_connection_details of this Pipeline.

Returns

The target_connection_details of this Pipeline.

Return type

oci.golden_gate.models.TargetPipelineConnectionDetails

property time_created

[Required] Gets the time_created of this Pipeline. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns

The time_created of this Pipeline.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this Pipeline. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns

The time_updated of this Pipeline.

Return type

datetime