PipelineSummary

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

Bases: object

Summary details of the pipeline.

Attributes:

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE

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

LICENSE_MODEL_LICENSE_INCLUDED

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

LIFECYCLE_SUB_STATE_MOVING

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

LIFECYCLE_SUB_STATE_PAUSED

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

LIFECYCLE_SUB_STATE_PAUSE_FAILED

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

LIFECYCLE_SUB_STATE_PAUSING

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

LIFECYCLE_SUB_STATE_RUNNING

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

LIFECYCLE_SUB_STATE_STARTING

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

LIFECYCLE_SUB_STATE_START_FAILED

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

LIFECYCLE_SUB_STATE_STOPPED

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

LIFECYCLE_SUB_STATE_STOPPING

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

LIFECYCLE_SUB_STATE_STOP_FAILED

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

RECIPE_TYPE_ZERO_ETL

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

compartment_id

[Required] Gets the compartment_id of this PipelineSummary.

cpu_core_count

[Required] Gets the cpu_core_count of this PipelineSummary.

defined_tags

Gets the defined_tags of this PipelineSummary.

description

Gets the description of this PipelineSummary.

display_name

[Required] Gets the display_name of this PipelineSummary.

freeform_tags

Gets the freeform_tags of this PipelineSummary.

id

[Required] Gets the id of this PipelineSummary.

is_auto_scaling_enabled

[Required] Gets the is_auto_scaling_enabled of this PipelineSummary.

license_model

[Required] Gets the license_model of this PipelineSummary.

lifecycle_details

Gets the lifecycle_details of this PipelineSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this PipelineSummary.

lifecycle_sub_state

Gets the lifecycle_sub_state of this PipelineSummary.

locks

Gets the locks of this PipelineSummary.

recipe_type

[Required] Gets the recipe_type of this PipelineSummary.

source_connection_details

[Required] Gets the source_connection_details of this PipelineSummary.

subnet_id

Gets the subnet_id of this PipelineSummary.

system_tags

Gets the system_tags of this PipelineSummary.

target_connection_details

[Required] Gets the target_connection_details of this PipelineSummary.

time_created

[Required] Gets the time_created of this PipelineSummary.

time_updated

[Required] Gets the time_updated of this PipelineSummary.

Methods:

__init__(**kwargs)

Initializes a new PipelineSummary 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 PipelineSummary. 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 PipelineSummary. This constant has a value of “LICENSE_INCLUDED”

LIFECYCLE_SUB_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_sub_state property of a PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. 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 PipelineSummary. This constant has a value of “ZERO_ETL”

__init__(**kwargs)

Initializes a new PipelineSummary 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 PipelineSummary. 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 PipelineSummary.

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

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

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

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

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

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

  • license_model (str) – The value to assign to the license_model property of this PipelineSummary. 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 PipelineSummary.

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PipelineSummary.

  • lifecycle_sub_state (str) – The value to assign to the lifecycle_sub_state property of this PipelineSummary. 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 PipelineSummary.

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

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

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

property compartment_id

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

Returns

The compartment_id of this PipelineSummary.

Return type

str

property cpu_core_count

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

Returns

The cpu_core_count of this PipelineSummary.

Return type

int

property defined_tags

Gets the defined_tags of this PipelineSummary. 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 PipelineSummary.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this PipelineSummary.

Return type

str

property display_name

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

Returns

The display_name of this PipelineSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this PipelineSummary. 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 PipelineSummary.

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 PipelineSummary. The OCID of the pipeline. This option applies when retrieving a pipeline.

Returns

The id of this PipelineSummary.

Return type

str

property is_auto_scaling_enabled

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

Returns

The is_auto_scaling_enabled of this PipelineSummary.

Return type

bool

property license_model

[Required] Gets the license_model of this PipelineSummary. 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 PipelineSummary.

Return type

str

property lifecycle_details

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

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this PipelineSummary. Lifecycle state for the pipeline summary.

Returns

The lifecycle_state of this PipelineSummary.

Return type

str

property lifecycle_sub_state

Gets the lifecycle_sub_state of this PipelineSummary. 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 PipelineSummary.

Return type

str

property locks

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

Returns

The locks of this PipelineSummary.

Return type

list[oci.golden_gate.models.ResourceLock]

property recipe_type

[Required] Gets the recipe_type of this PipelineSummary. 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 PipelineSummary.

Return type

str

property source_connection_details

[Required] Gets the source_connection_details of this PipelineSummary.

Returns

The source_connection_details of this PipelineSummary.

Return type

oci.golden_gate.models.SourcePipelineConnectionDetails

property subnet_id

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

Returns

The subnet_id of this PipelineSummary.

Return type

str

property system_tags

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

Return type

dict(str, dict(str, object))

property target_connection_details

[Required] Gets the target_connection_details of this PipelineSummary.

Returns

The target_connection_details of this PipelineSummary.

Return type

oci.golden_gate.models.TargetPipelineConnectionDetails

property time_created

[Required] Gets the time_created of this PipelineSummary. 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 PipelineSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this PipelineSummary. 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 PipelineSummary.

Return type

datetime