JavaMessageServiceConnectionSummary¶

class oci.golden_gate.models.JavaMessageServiceConnectionSummary(**kwargs)¶

Bases: oci.golden_gate.models.connection_summary.ConnectionSummary

Summary of the Java Message Service Connection.

Attributes

`CONNECTION_TYPE_AMAZON_KINESIS`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_REDSHIFT`	str(object=’’) -> str
`CONNECTION_TYPE_AMAZON_S3`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS`	str(object=’’) -> str
`CONNECTION_TYPE_DB2`	str(object=’’) -> str
`CONNECTION_TYPE_ELASTICSEARCH`	str(object=’’) -> str
`CONNECTION_TYPE_GENERIC`	str(object=’’) -> str
`CONNECTION_TYPE_GOLDENGATE`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_BIGQUERY`	str(object=’’) -> str
`CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_HDFS`	str(object=’’) -> str
`CONNECTION_TYPE_JAVA_MESSAGE_SERVICE`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA`	str(object=’’) -> str
`CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY`	str(object=’’) -> str
`CONNECTION_TYPE_MICROSOFT_SQLSERVER`	str(object=’’) -> str
`CONNECTION_TYPE_MONGODB`	str(object=’’) -> str
`CONNECTION_TYPE_MYSQL`	str(object=’’) -> str
`CONNECTION_TYPE_OCI_OBJECT_STORAGE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE`	str(object=’’) -> str
`CONNECTION_TYPE_ORACLE_NOSQL`	str(object=’’) -> str
`CONNECTION_TYPE_POSTGRESQL`	str(object=’’) -> str
`CONNECTION_TYPE_REDIS`	str(object=’’) -> str
`CONNECTION_TYPE_SNOWFLAKE`	str(object=’’) -> str
`ROUTING_METHOD_DEDICATED_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT`	str(object=’’) -> str
`ROUTING_METHOD_SHARED_SERVICE_ENDPOINT`	str(object=’’) -> str
`authentication_type`	Gets the authentication_type of this JavaMessageServiceConnectionSummary.
`compartment_id`	[Required] Gets the compartment_id of this ConnectionSummary.
`connection_factory`	Gets the connection_factory of this JavaMessageServiceConnectionSummary.
`connection_type`	[Required] Gets the connection_type of this ConnectionSummary.
`connection_url`	Gets the connection_url of this JavaMessageServiceConnectionSummary.
`defined_tags`	Gets the defined_tags of this ConnectionSummary.
`description`	Gets the description of this ConnectionSummary.
`display_name`	[Required] Gets the display_name of this ConnectionSummary.
`freeform_tags`	Gets the freeform_tags of this ConnectionSummary.
`id`	[Required] Gets the id of this ConnectionSummary.
`ingress_ips`	Gets the ingress_ips of this ConnectionSummary.
`jndi_connection_factory`	Gets the jndi_connection_factory of this JavaMessageServiceConnectionSummary.
`jndi_initial_context_factory`	Gets the jndi_initial_context_factory of this JavaMessageServiceConnectionSummary.
`jndi_provider_url`	Gets the jndi_provider_url of this JavaMessageServiceConnectionSummary.
`jndi_security_principal`	Gets the jndi_security_principal of this JavaMessageServiceConnectionSummary.
`key_id`	Gets the key_id of this ConnectionSummary.
`lifecycle_details`	Gets the lifecycle_details of this ConnectionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ConnectionSummary.
`locks`	Gets the locks of this ConnectionSummary.
`nsg_ids`	Gets the nsg_ids of this ConnectionSummary.
`private_ip`	Gets the private_ip of this JavaMessageServiceConnectionSummary.
`routing_method`	Gets the routing_method of this ConnectionSummary.
`security_protocol`	Gets the security_protocol of this JavaMessageServiceConnectionSummary.
`should_use_jndi`	[Required] Gets the should_use_jndi of this JavaMessageServiceConnectionSummary.
`subnet_id`	Gets the subnet_id of this ConnectionSummary.
`system_tags`	Gets the system_tags of this ConnectionSummary.
`technology_type`	[Required] Gets the technology_type of this JavaMessageServiceConnectionSummary.
`time_created`	[Required] Gets the time_created of this ConnectionSummary.
`time_updated`	[Required] Gets the time_updated of this ConnectionSummary.
`username`	Gets the username of this JavaMessageServiceConnectionSummary.
`vault_id`	Gets the vault_id of this ConnectionSummary.

Methods

`__init__`(**kwargs)	Initializes a new JavaMessageServiceConnectionSummary 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.

CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'¶

CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'¶

CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'¶

CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'¶

CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'¶

CONNECTION_TYPE_DB2 = 'DB2'¶

CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'¶

CONNECTION_TYPE_GENERIC = 'GENERIC'¶

CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'¶

CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'¶

CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'¶

CONNECTION_TYPE_HDFS = 'HDFS'¶

CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'¶

CONNECTION_TYPE_KAFKA = 'KAFKA'¶

CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'¶

CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'¶

CONNECTION_TYPE_MONGODB = 'MONGODB'¶

CONNECTION_TYPE_MYSQL = 'MYSQL'¶

CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶

CONNECTION_TYPE_ORACLE = 'ORACLE'¶

CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'¶

CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'¶

CONNECTION_TYPE_REDIS = 'REDIS'¶

CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'¶

ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'¶

ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'¶

ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'¶

__init__(**kwargs)¶

Initializes a new JavaMessageServiceConnectionSummary object with values from keyword arguments. The default value of the connection_type attribute of this class is JAVA_MESSAGE_SERVICE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

connection_type (str) – The value to assign to the connection_type property of this JavaMessageServiceConnectionSummary. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”
id (str) – The value to assign to the id property of this JavaMessageServiceConnectionSummary.
display_name (str) – The value to assign to the display_name property of this JavaMessageServiceConnectionSummary.
description (str) – The value to assign to the description property of this JavaMessageServiceConnectionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this JavaMessageServiceConnectionSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this JavaMessageServiceConnectionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this JavaMessageServiceConnectionSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this JavaMessageServiceConnectionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this JavaMessageServiceConnectionSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this JavaMessageServiceConnectionSummary.
time_created (datetime) – The value to assign to the time_created property of this JavaMessageServiceConnectionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this JavaMessageServiceConnectionSummary.
vault_id (str) – The value to assign to the vault_id property of this JavaMessageServiceConnectionSummary.
key_id (str) – The value to assign to the key_id property of this JavaMessageServiceConnectionSummary.
ingress_ips (list[oci.golden_gate.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this JavaMessageServiceConnectionSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this JavaMessageServiceConnectionSummary.
subnet_id (str) – The value to assign to the subnet_id property of this JavaMessageServiceConnectionSummary.
routing_method (str) – The value to assign to the routing_method property of this JavaMessageServiceConnectionSummary. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this JavaMessageServiceConnectionSummary.
technology_type (str) – The value to assign to the technology_type property of this JavaMessageServiceConnectionSummary.
should_use_jndi (bool) – The value to assign to the should_use_jndi property of this JavaMessageServiceConnectionSummary.
jndi_connection_factory (str) – The value to assign to the jndi_connection_factory property of this JavaMessageServiceConnectionSummary.
jndi_provider_url (str) – The value to assign to the jndi_provider_url property of this JavaMessageServiceConnectionSummary.
jndi_initial_context_factory (str) – The value to assign to the jndi_initial_context_factory property of this JavaMessageServiceConnectionSummary.
jndi_security_principal (str) – The value to assign to the jndi_security_principal property of this JavaMessageServiceConnectionSummary.
connection_url (str) – The value to assign to the connection_url property of this JavaMessageServiceConnectionSummary.
connection_factory (str) – The value to assign to the connection_factory property of this JavaMessageServiceConnectionSummary.
security_protocol (str) – The value to assign to the security_protocol property of this JavaMessageServiceConnectionSummary.
authentication_type (str) – The value to assign to the authentication_type property of this JavaMessageServiceConnectionSummary.
username (str) – The value to assign to the username property of this JavaMessageServiceConnectionSummary.
private_ip (str) – The value to assign to the private_ip property of this JavaMessageServiceConnectionSummary.

authentication_type¶

Gets the authentication_type of this JavaMessageServiceConnectionSummary. Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.

Returns:	The authentication_type of this JavaMessageServiceConnectionSummary.
Return type:	str

compartment_id¶

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

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

connection_factory¶

Gets the connection_factory of this JavaMessageServiceConnectionSummary. The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: ‘com.stc.jmsjca.core.JConnectionFactoryXA’

Returns:	The connection_factory of this JavaMessageServiceConnectionSummary.
Return type:	str

connection_type¶

[Required] Gets the connection_type of this ConnectionSummary. The connection type.

Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The connection_type of this ConnectionSummary.
Return type:	str

connection_url¶

Gets the connection_url of this JavaMessageServiceConnectionSummary. Connectin URL of the Java Message Service, specifying the protocol, host, and port. e.g.: ‘mq://myjms.host.domain:7676’

Returns:	The connection_url of this JavaMessageServiceConnectionSummary.
Return type:	str

defined_tags¶

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

description¶

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

Returns:	The description of this ConnectionSummary.
Return type:	str

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ConnectionSummary. The OCID of the connection being referenced.

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

ingress_ips¶

Gets the ingress_ips of this ConnectionSummary. 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 ConnectionSummary.
Return type:	list[oci.golden_gate.models.IngressIpDetails]

jndi_connection_factory¶

Gets the jndi_connection_factory of this JavaMessageServiceConnectionSummary. The Connection Factory can be looked up using this name. e.g.: ‘ConnectionFactory’

Returns:	The jndi_connection_factory of this JavaMessageServiceConnectionSummary.
Return type:	str

jndi_initial_context_factory¶

Gets the jndi_initial_context_factory of this JavaMessageServiceConnectionSummary. The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: ‘org.apache.activemq.jndi.ActiveMQInitialContextFactory’

Returns:	The jndi_initial_context_factory of this JavaMessageServiceConnectionSummary.
Return type:	str

jndi_provider_url¶

Gets the jndi_provider_url of this JavaMessageServiceConnectionSummary. The URL that Java Message Service will use to contact the JNDI provider. e.g.: ‘tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000’

Returns:	The jndi_provider_url of this JavaMessageServiceConnectionSummary.
Return type:	str

jndi_security_principal¶

Gets the jndi_security_principal of this JavaMessageServiceConnectionSummary. Specifies the identity of the principal (user) to be authenticated. e.g.: ‘admin2’

Returns:	The jndi_security_principal of this JavaMessageServiceConnectionSummary.
Return type:	str

key_id¶

Gets the key_id of this ConnectionSummary. Refers to the customer’s master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Returns:	The key_id of this ConnectionSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ConnectionSummary. 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 ConnectionSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ConnectionSummary. Possible lifecycle states for connection.

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

locks¶

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

Returns:	The locks of this ConnectionSummary.
Return type:	list[oci.golden_gate.models.ResourceLock]

nsg_ids¶

Gets the nsg_ids of this ConnectionSummary. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:	The nsg_ids of this ConnectionSummary.
Return type:	list[str]

private_ip¶

Gets the private_ip of this JavaMessageServiceConnectionSummary. Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection’s endpoint in the customer’s VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:	The private_ip of this JavaMessageServiceConnectionSummary.
Return type:	str

routing_method¶

Gets the routing_method of this ConnectionSummary. Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

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

Returns:	The routing_method of this ConnectionSummary.
Return type:	str

security_protocol¶

Gets the security_protocol of this JavaMessageServiceConnectionSummary. Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.

Returns:	The security_protocol of this JavaMessageServiceConnectionSummary.
Return type:	str

should_use_jndi¶

[Required] Gets the should_use_jndi of this JavaMessageServiceConnectionSummary. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

Returns:	The should_use_jndi of this JavaMessageServiceConnectionSummary.
Return type:	bool

subnet_id¶

Gets the subnet_id of this ConnectionSummary. The OCID of the target subnet of the dedicated connection.

Returns:	The subnet_id of this ConnectionSummary.
Return type:	str

system_tags¶

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

technology_type¶

[Required] Gets the technology_type of this JavaMessageServiceConnectionSummary. The Java Message Service technology type.

Returns:	The technology_type of this JavaMessageServiceConnectionSummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this ConnectionSummary. 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 ConnectionSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ConnectionSummary. 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 ConnectionSummary.
Return type:	datetime

username¶

Gets the username of this JavaMessageServiceConnectionSummary. The username Oracle GoldenGate uses to connect to the Java Message Service. This username must already exist and be available by the Java Message Service to be connected to.

Returns:	The username of this JavaMessageServiceConnectionSummary.
Return type:	str

vault_id¶

Gets the vault_id of this ConnectionSummary. Refers to the customer’s vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Returns:	The vault_id of this ConnectionSummary.
Return type:	str