IntegrationInstance¶

class oci.integration.models.IntegrationInstance(**kwargs)¶

Bases: object

Description of Integration Instance.

Attributes

`CONSUMPTION_MODEL_GOV`	A constant which can be used with the consumption_model property of a IntegrationInstance.
`CONSUMPTION_MODEL_OIC4_SAAS`	A constant which can be used with the consumption_model property of a IntegrationInstance.
`CONSUMPTION_MODEL_UCM`	A constant which can be used with the consumption_model property of a IntegrationInstance.
`DATA_RETENTION_PERIOD_MONTHS_1`	A constant which can be used with the data_retention_period property of a IntegrationInstance.
`DATA_RETENTION_PERIOD_MONTHS_3`	A constant which can be used with the data_retention_period property of a IntegrationInstance.
`DATA_RETENTION_PERIOD_MONTHS_6`	A constant which can be used with the data_retention_period property of a IntegrationInstance.
`INTEGRATION_INSTANCE_TYPE_ENTERPRISE`	A constant which can be used with the integration_instance_type property of a IntegrationInstance.
`INTEGRATION_INSTANCE_TYPE_ENTERPRISEX`	A constant which can be used with the integration_instance_type property of a IntegrationInstance.
`INTEGRATION_INSTANCE_TYPE_HEALTHCARE`	A constant which can be used with the integration_instance_type property of a IntegrationInstance.
`INTEGRATION_INSTANCE_TYPE_STANDARD`	A constant which can be used with the integration_instance_type property of a IntegrationInstance.
`INTEGRATION_INSTANCE_TYPE_STANDARDX`	A constant which can be used with the integration_instance_type property of a IntegrationInstance.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a IntegrationInstance.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a IntegrationInstance.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a IntegrationInstance.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a IntegrationInstance.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a IntegrationInstance.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a IntegrationInstance.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a IntegrationInstance.
`SHAPE_DEVELOPMENT`	A constant which can be used with the shape property of a IntegrationInstance.
`SHAPE_PRODUCTION`	A constant which can be used with the shape property of a IntegrationInstance.
`alternate_custom_endpoints`	Gets the alternate_custom_endpoints of this IntegrationInstance.
`attachments`	Gets the attachments of this IntegrationInstance.
`compartment_id`	[Required] Gets the compartment_id of this IntegrationInstance.
`consumption_model`	Gets the consumption_model of this IntegrationInstance.
`custom_endpoint`	Gets the custom_endpoint of this IntegrationInstance.
`data_retention_period`	Gets the data_retention_period of this IntegrationInstance.
`defined_tags`	Gets the defined_tags of this IntegrationInstance.
`disaster_recovery_details`	Gets the disaster_recovery_details of this IntegrationInstance.
`display_name`	[Required] Gets the display_name of this IntegrationInstance.
`freeform_tags`	Gets the freeform_tags of this IntegrationInstance.
`id`	[Required] Gets the id of this IntegrationInstance.
`idcs_info`	Gets the idcs_info of this IntegrationInstance.
`instance_design_time_url`	Gets the instance_design_time_url of this IntegrationInstance.
`instance_url`	[Required] Gets the instance_url of this IntegrationInstance.
`integration_instance_type`	[Required] Gets the integration_instance_type of this IntegrationInstance.
`is_byol`	[Required] Gets the is_byol of this IntegrationInstance.
`is_disaster_recovery_enabled`	Gets the is_disaster_recovery_enabled of this IntegrationInstance.
`is_file_server_enabled`	Gets the is_file_server_enabled of this IntegrationInstance.
`is_visual_builder_enabled`	Gets the is_visual_builder_enabled of this IntegrationInstance.
`lifecycle_details`	Gets the lifecycle_details of this IntegrationInstance.
`lifecycle_state`	Gets the lifecycle_state of this IntegrationInstance.
`message_packs`	[Required] Gets the message_packs of this IntegrationInstance.
`network_endpoint_details`	Gets the network_endpoint_details of this IntegrationInstance.
`private_endpoint_outbound_connection`	Gets the private_endpoint_outbound_connection of this IntegrationInstance.
`shape`	Gets the shape of this IntegrationInstance.
`state_message`	Gets the state_message of this IntegrationInstance.
`system_tags`	Gets the system_tags of this IntegrationInstance.
`time_created`	Gets the time_created of this IntegrationInstance.
`time_updated`	Gets the time_updated of this IntegrationInstance.

Methods

__init__(**kwargs) Initializes a new IntegrationInstance object with values from keyword arguments.

CONSUMPTION_MODEL_GOV = 'GOV'¶: A constant which can be used with the consumption_model property of a IntegrationInstance. This constant has a value of “GOV”

CONSUMPTION_MODEL_OIC4_SAAS = 'OIC4SAAS'¶: A constant which can be used with the consumption_model property of a IntegrationInstance. This constant has a value of “OIC4SAAS”

CONSUMPTION_MODEL_UCM = 'UCM'¶: A constant which can be used with the consumption_model property of a IntegrationInstance. This constant has a value of “UCM”

DATA_RETENTION_PERIOD_MONTHS_1 = 'MONTHS_1'¶: A constant which can be used with the data_retention_period property of a IntegrationInstance. This constant has a value of “MONTHS_1”

DATA_RETENTION_PERIOD_MONTHS_3 = 'MONTHS_3'¶: A constant which can be used with the data_retention_period property of a IntegrationInstance. This constant has a value of “MONTHS_3”

DATA_RETENTION_PERIOD_MONTHS_6 = 'MONTHS_6'¶: A constant which can be used with the data_retention_period property of a IntegrationInstance. This constant has a value of “MONTHS_6”

INTEGRATION_INSTANCE_TYPE_ENTERPRISE = 'ENTERPRISE'¶: A constant which can be used with the integration_instance_type property of a IntegrationInstance. This constant has a value of “ENTERPRISE”

INTEGRATION_INSTANCE_TYPE_ENTERPRISEX = 'ENTERPRISEX'¶: A constant which can be used with the integration_instance_type property of a IntegrationInstance. This constant has a value of “ENTERPRISEX”

INTEGRATION_INSTANCE_TYPE_HEALTHCARE = 'HEALTHCARE'¶: A constant which can be used with the integration_instance_type property of a IntegrationInstance. This constant has a value of “HEALTHCARE”

INTEGRATION_INSTANCE_TYPE_STANDARD = 'STANDARD'¶: A constant which can be used with the integration_instance_type property of a IntegrationInstance. This constant has a value of “STANDARD”

INTEGRATION_INSTANCE_TYPE_STANDARDX = 'STANDARDX'¶: A constant which can be used with the integration_instance_type property of a IntegrationInstance. This constant has a value of “STANDARDX”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a IntegrationInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a IntegrationInstance. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a IntegrationInstance. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a IntegrationInstance. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a IntegrationInstance. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a IntegrationInstance. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a IntegrationInstance. This constant has a value of “UPDATING”

SHAPE_DEVELOPMENT = 'DEVELOPMENT'¶: A constant which can be used with the shape property of a IntegrationInstance. This constant has a value of “DEVELOPMENT”

SHAPE_PRODUCTION = 'PRODUCTION'¶: A constant which can be used with the shape property of a IntegrationInstance. This constant has a value of “PRODUCTION”

__init__(**kwargs)¶

Initializes a new IntegrationInstance object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this IntegrationInstance.
display_name (str) – The value to assign to the display_name property of this IntegrationInstance.
compartment_id (str) – The value to assign to the compartment_id property of this IntegrationInstance.
integration_instance_type (str) – The value to assign to the integration_instance_type property of this IntegrationInstance. Allowed values for this property are: “STANDARD”, “ENTERPRISE”, “STANDARDX”, “ENTERPRISEX”, “HEALTHCARE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this IntegrationInstance.
time_updated (datetime) – The value to assign to the time_updated property of this IntegrationInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IntegrationInstance. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “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 IntegrationInstance.
state_message (str) – The value to assign to the state_message property of this IntegrationInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this IntegrationInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this IntegrationInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this IntegrationInstance.
is_byol (bool) – The value to assign to the is_byol property of this IntegrationInstance.
instance_url (str) – The value to assign to the instance_url property of this IntegrationInstance.
instance_design_time_url (str) – The value to assign to the instance_design_time_url property of this IntegrationInstance.
message_packs (int) – The value to assign to the message_packs property of this IntegrationInstance.
is_file_server_enabled (bool) – The value to assign to the is_file_server_enabled property of this IntegrationInstance.
is_visual_builder_enabled (bool) – The value to assign to the is_visual_builder_enabled property of this IntegrationInstance.
custom_endpoint (oci.integration.models.CustomEndpointDetails) – The value to assign to the custom_endpoint property of this IntegrationInstance.
alternate_custom_endpoints (list[oci.integration.models.CustomEndpointDetails]) – The value to assign to the alternate_custom_endpoints property of this IntegrationInstance.
consumption_model (str) – The value to assign to the consumption_model property of this IntegrationInstance. Allowed values for this property are: “UCM”, “GOV”, “OIC4SAAS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
network_endpoint_details (oci.integration.models.NetworkEndpointDetails) – The value to assign to the network_endpoint_details property of this IntegrationInstance.
idcs_info (oci.integration.models.IdcsInfoDetails) – The value to assign to the idcs_info property of this IntegrationInstance.
attachments (list[oci.integration.models.AttachmentDetails]) – The value to assign to the attachments property of this IntegrationInstance.
shape (str) – The value to assign to the shape property of this IntegrationInstance. Allowed values for this property are: “DEVELOPMENT”, “PRODUCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
private_endpoint_outbound_connection (oci.integration.models.OutboundConnection) – The value to assign to the private_endpoint_outbound_connection property of this IntegrationInstance.
is_disaster_recovery_enabled (bool) – The value to assign to the is_disaster_recovery_enabled property of this IntegrationInstance.
disaster_recovery_details (oci.integration.models.DisasterRecoveryDetails) – The value to assign to the disaster_recovery_details property of this IntegrationInstance.
data_retention_period (str) – The value to assign to the data_retention_period property of this IntegrationInstance. Allowed values for this property are: “MONTHS_1”, “MONTHS_3”, “MONTHS_6”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

alternate_custom_endpoints¶

Gets the alternate_custom_endpoints of this IntegrationInstance. A list of alternate custom endpoints used for the integration instance URL.

Returns:	The alternate_custom_endpoints of this IntegrationInstance.
Return type:	list[oci.integration.models.CustomEndpointDetails]

attachments¶

Gets the attachments of this IntegrationInstance. A list of associated attachments to other services

Returns:	The attachments of this IntegrationInstance.
Return type:	list[oci.integration.models.AttachmentDetails]

compartment_id¶

[Required] Gets the compartment_id of this IntegrationInstance. Compartment Identifier.

Returns:	The compartment_id of this IntegrationInstance.
Return type:	str

consumption_model¶

Gets the consumption_model of this IntegrationInstance. The entitlement used for billing purposes.

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

Returns:	The consumption_model of this IntegrationInstance.
Return type:	str

custom_endpoint¶

Gets the custom_endpoint of this IntegrationInstance.

Returns:	The custom_endpoint of this IntegrationInstance.
Return type:	oci.integration.models.CustomEndpointDetails

data_retention_period¶

Gets the data_retention_period of this IntegrationInstance. Data retention period set for given integration instance

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

Returns:	The data_retention_period of this IntegrationInstance.
Return type:	str

defined_tags¶

Gets the defined_tags of this IntegrationInstance. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this IntegrationInstance.
Return type:	dict(str, dict(str, object))

disaster_recovery_details¶

Gets the disaster_recovery_details of this IntegrationInstance.

Returns:	The disaster_recovery_details of this IntegrationInstance.
Return type:	oci.integration.models.DisasterRecoveryDetails

display_name¶

[Required] Gets the display_name of this IntegrationInstance. Integration Instance Identifier, can be renamed.

Returns:	The display_name of this IntegrationInstance.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this IntegrationInstance. 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 IntegrationInstance.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this IntegrationInstance. Unique identifier that is immutable on creation.

Returns:	The id of this IntegrationInstance.
Return type:	str

idcs_info¶

Gets the idcs_info of this IntegrationInstance.

Returns:	The idcs_info of this IntegrationInstance.
Return type:	oci.integration.models.IdcsInfoDetails

instance_design_time_url¶

Gets the instance_design_time_url of this IntegrationInstance. The Integration Instance Design Time URL

Returns:	The instance_design_time_url of this IntegrationInstance.
Return type:	str

instance_url¶

[Required] Gets the instance_url of this IntegrationInstance. The Integration Instance URL.

Returns:	The instance_url of this IntegrationInstance.
Return type:	str

integration_instance_type¶

[Required] Gets the integration_instance_type of this IntegrationInstance. Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX

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

Returns:	The integration_instance_type of this IntegrationInstance.
Return type:	str

is_byol¶

[Required] Gets the is_byol of this IntegrationInstance. Bring your own license.

Returns:	The is_byol of this IntegrationInstance.
Return type:	bool

is_disaster_recovery_enabled¶

Gets the is_disaster_recovery_enabled of this IntegrationInstance. Is Disaster Recovery enabled for the integrationInstance

Returns:	The is_disaster_recovery_enabled of this IntegrationInstance.
Return type:	bool

is_file_server_enabled¶

Gets the is_file_server_enabled of this IntegrationInstance. The file server is enabled or not.

Returns:	The is_file_server_enabled of this IntegrationInstance.
Return type:	bool

is_visual_builder_enabled¶

Gets the is_visual_builder_enabled of this IntegrationInstance. VisualBuilder is enabled or not.

Returns:	The is_visual_builder_enabled of this IntegrationInstance.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this IntegrationInstance. Additional details of lifecycleState or substates

Returns:	The lifecycle_details of this IntegrationInstance.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this IntegrationInstance. The current state of the integration instance.

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

Returns:	The lifecycle_state of this IntegrationInstance.
Return type:	str

message_packs¶

[Required] Gets the message_packs of this IntegrationInstance. The number of configured message packs (if any)

Returns:	The message_packs of this IntegrationInstance.
Return type:	int

network_endpoint_details¶

Gets the network_endpoint_details of this IntegrationInstance.

Returns:	The network_endpoint_details of this IntegrationInstance.
Return type:	oci.integration.models.NetworkEndpointDetails

private_endpoint_outbound_connection¶

Gets the private_endpoint_outbound_connection of this IntegrationInstance.

Returns:	The private_endpoint_outbound_connection of this IntegrationInstance.
Return type:	oci.integration.models.OutboundConnection

shape¶

Gets the shape of this IntegrationInstance. Shape

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

Returns:	The shape of this IntegrationInstance.
Return type:	str

state_message¶

Gets the state_message of this IntegrationInstance. An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:	The state_message of this IntegrationInstance.
Return type:	str

system_tags¶

Gets the system_tags of this IntegrationInstance. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this IntegrationInstance.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this IntegrationInstance. The time the the IntegrationInstance was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this IntegrationInstance.
Return type:	datetime

time_updated¶

Gets the time_updated of this IntegrationInstance. The time the IntegrationInstance was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this IntegrationInstance.
Return type:	datetime