IntegrationInstanceSummary

class oci.integration.models.IntegrationInstanceSummary(**kwargs)

Bases: object

Summary of the Integration Instance.

Attributes:

CONSUMPTION_MODEL_GOV

A constant which can be used with the consumption_model property of a IntegrationInstanceSummary.

CONSUMPTION_MODEL_OIC4_SAAS

A constant which can be used with the consumption_model property of a IntegrationInstanceSummary.

CONSUMPTION_MODEL_UCM

A constant which can be used with the consumption_model property of a IntegrationInstanceSummary.

DATA_RETENTION_PERIOD_MONTHS_1

A constant which can be used with the data_retention_period property of a IntegrationInstanceSummary.

DATA_RETENTION_PERIOD_MONTHS_3

A constant which can be used with the data_retention_period property of a IntegrationInstanceSummary.

DATA_RETENTION_PERIOD_MONTHS_6

A constant which can be used with the data_retention_period property of a IntegrationInstanceSummary.

INTEGRATION_INSTANCE_TYPE_ENTERPRISE

A constant which can be used with the integration_instance_type property of a IntegrationInstanceSummary.

INTEGRATION_INSTANCE_TYPE_ENTERPRISEX

A constant which can be used with the integration_instance_type property of a IntegrationInstanceSummary.

INTEGRATION_INSTANCE_TYPE_HEALTHCARE

A constant which can be used with the integration_instance_type property of a IntegrationInstanceSummary.

INTEGRATION_INSTANCE_TYPE_STANDARD

A constant which can be used with the integration_instance_type property of a IntegrationInstanceSummary.

INTEGRATION_INSTANCE_TYPE_STANDARDX

A constant which can be used with the integration_instance_type property of a IntegrationInstanceSummary.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

SHAPE_DEVELOPMENT

A constant which can be used with the shape property of a IntegrationInstanceSummary.

SHAPE_PRODUCTION

A constant which can be used with the shape property of a IntegrationInstanceSummary.

alternate_custom_endpoints

Gets the alternate_custom_endpoints of this IntegrationInstanceSummary.

compartment_id

[Required] Gets the compartment_id of this IntegrationInstanceSummary.

consumption_model

Gets the consumption_model of this IntegrationInstanceSummary.

custom_endpoint

Gets the custom_endpoint of this IntegrationInstanceSummary.

data_retention_period

Gets the data_retention_period of this IntegrationInstanceSummary.

defined_tags

Gets the defined_tags of this IntegrationInstanceSummary.

display_name

[Required] Gets the display_name of this IntegrationInstanceSummary.

freeform_tags

Gets the freeform_tags of this IntegrationInstanceSummary.

id

[Required] Gets the id of this IntegrationInstanceSummary.

instance_design_time_url

Gets the instance_design_time_url of this IntegrationInstanceSummary.

instance_url

[Required] Gets the instance_url of this IntegrationInstanceSummary.

integration_instance_type

[Required] Gets the integration_instance_type of this IntegrationInstanceSummary.

is_byol

[Required] Gets the is_byol of this IntegrationInstanceSummary.

is_disaster_recovery_enabled

Gets the is_disaster_recovery_enabled of this IntegrationInstanceSummary.

is_file_server_enabled

Gets the is_file_server_enabled of this IntegrationInstanceSummary.

is_visual_builder_enabled

Gets the is_visual_builder_enabled of this IntegrationInstanceSummary.

lifecycle_details

Gets the lifecycle_details of this IntegrationInstanceSummary.

lifecycle_state

Gets the lifecycle_state of this IntegrationInstanceSummary.

log_group_id

Gets the log_group_id of this IntegrationInstanceSummary.

message_packs

[Required] Gets the message_packs of this IntegrationInstanceSummary.

network_endpoint_details

Gets the network_endpoint_details of this IntegrationInstanceSummary.

private_endpoint_outbound_connection

Gets the private_endpoint_outbound_connection of this IntegrationInstanceSummary.

process_automation_log_group_id

Gets the process_automation_log_group_id of this IntegrationInstanceSummary.

security_attributes

Gets the security_attributes of this IntegrationInstanceSummary.

shape

Gets the shape of this IntegrationInstanceSummary.

state_message

Gets the state_message of this IntegrationInstanceSummary.

system_tags

Gets the system_tags of this IntegrationInstanceSummary.

time_created

Gets the time_created of this IntegrationInstanceSummary.

time_updated

Gets the time_updated of this IntegrationInstanceSummary.

Methods:

__init__(**kwargs)

Initializes a new IntegrationInstanceSummary object with values from keyword arguments.

CONSUMPTION_MODEL_GOV = 'GOV'

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

CONSUMPTION_MODEL_UCM = 'UCM'

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SHAPE_DEVELOPMENT = 'DEVELOPMENT'

A constant which can be used with the shape property of a IntegrationInstanceSummary. This constant has a value of “DEVELOPMENT”

SHAPE_PRODUCTION = 'PRODUCTION'

A constant which can be used with the shape property of a IntegrationInstanceSummary. This constant has a value of “PRODUCTION”

__init__(**kwargs)

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

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

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

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

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

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

  • state_message (str) – The value to assign to the state_message property of this IntegrationInstanceSummary.

  • is_byol (bool) – The value to assign to the is_byol property of this IntegrationInstanceSummary.

  • instance_url (str) – The value to assign to the instance_url property of this IntegrationInstanceSummary.

  • instance_design_time_url (str) – The value to assign to the instance_design_time_url property of this IntegrationInstanceSummary.

  • message_packs (int) – The value to assign to the message_packs property of this IntegrationInstanceSummary.

  • is_file_server_enabled (bool) – The value to assign to the is_file_server_enabled property of this IntegrationInstanceSummary.

  • is_visual_builder_enabled (bool) – The value to assign to the is_visual_builder_enabled property of this IntegrationInstanceSummary.

  • custom_endpoint (oci.integration.models.CustomEndpointDetails) – The value to assign to the custom_endpoint property of this IntegrationInstanceSummary.

  • alternate_custom_endpoints (list[oci.integration.models.CustomEndpointDetails]) – The value to assign to the alternate_custom_endpoints property of this IntegrationInstanceSummary.

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

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

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

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

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

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

  • is_disaster_recovery_enabled (bool) – The value to assign to the is_disaster_recovery_enabled property of this IntegrationInstanceSummary.

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

  • log_group_id (str) – The value to assign to the log_group_id property of this IntegrationInstanceSummary.

  • process_automation_log_group_id (str) – The value to assign to the process_automation_log_group_id property of this IntegrationInstanceSummary.

property alternate_custom_endpoints

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

Returns

The alternate_custom_endpoints of this IntegrationInstanceSummary.

Return type

list[oci.integration.models.CustomEndpointDetails]

property compartment_id

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

Returns

The compartment_id of this IntegrationInstanceSummary.

Return type

str

property consumption_model

Gets the consumption_model of this IntegrationInstanceSummary. 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 IntegrationInstanceSummary.

Return type

str

property custom_endpoint

Gets the custom_endpoint of this IntegrationInstanceSummary.

Returns

The custom_endpoint of this IntegrationInstanceSummary.

Return type

oci.integration.models.CustomEndpointDetails

property data_retention_period

Gets the data_retention_period of this IntegrationInstanceSummary. 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 IntegrationInstanceSummary.

Return type

str

property defined_tags

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

Returns

The defined_tags of this IntegrationInstanceSummary.

Return type

dict(str, dict(str, object))

property display_name

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

Returns

The display_name of this IntegrationInstanceSummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this IntegrationInstanceSummary.

Return type

str

property instance_design_time_url

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

Returns

The instance_design_time_url of this IntegrationInstanceSummary.

Return type

str

property instance_url

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

Returns

The instance_url of this IntegrationInstanceSummary.

Return type

str

property integration_instance_type

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

Return type

str

property is_byol

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

Returns

The is_byol of this IntegrationInstanceSummary.

Return type

bool

property is_disaster_recovery_enabled

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

Returns

The is_disaster_recovery_enabled of this IntegrationInstanceSummary.

Return type

bool

property is_file_server_enabled

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

Returns

The is_file_server_enabled of this IntegrationInstanceSummary.

Return type

bool

property is_visual_builder_enabled

Gets the is_visual_builder_enabled of this IntegrationInstanceSummary. Visual Builder is enabled or not.

Returns

The is_visual_builder_enabled of this IntegrationInstanceSummary.

Return type

bool

property lifecycle_details

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

Returns

The lifecycle_details of this IntegrationInstanceSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this IntegrationInstanceSummary. 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 IntegrationInstanceSummary.

Return type

str

property log_group_id

Gets the log_group_id of this IntegrationInstanceSummary. OCID of LogAnalytics LogGroup, enabled for given integration instance

Returns

The log_group_id of this IntegrationInstanceSummary.

Return type

str

property message_packs

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

Returns

The message_packs of this IntegrationInstanceSummary.

Return type

int

property network_endpoint_details

Gets the network_endpoint_details of this IntegrationInstanceSummary.

Returns

The network_endpoint_details of this IntegrationInstanceSummary.

Return type

oci.integration.models.NetworkEndpointDetails

property private_endpoint_outbound_connection

Gets the private_endpoint_outbound_connection of this IntegrationInstanceSummary.

Returns

The private_endpoint_outbound_connection of this IntegrationInstanceSummary.

Return type

oci.integration.models.OutboundConnection

property process_automation_log_group_id

Gets the process_automation_log_group_id of this IntegrationInstanceSummary. OCID of LogAnalytics LogGroup, enabled for given Process Automation attached to integration instance.

Returns

The process_automation_log_group_id of this IntegrationInstanceSummary.

Return type

str

property security_attributes

Gets the security_attributes of this IntegrationInstanceSummary. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns

The security_attributes of this IntegrationInstanceSummary.

Return type

dict(str, dict(str, object))

property shape

Gets the shape of this IntegrationInstanceSummary. 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 IntegrationInstanceSummary.

Return type

str

property state_message

Gets the state_message of this IntegrationInstanceSummary. 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 IntegrationInstanceSummary.

Return type

str

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this IntegrationInstanceSummary. The time the the Integration Instance was created. An RFC3339 formatted datetime string.

Returns

The time_created of this IntegrationInstanceSummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this IntegrationInstanceSummary.

Return type

datetime