Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class GoldengateJavaMessageServiceConnectionProperties.
The properties of GoldengateJavaMessageServiceConnection.
Generated from protobuf message google.cloud.oracledatabase.v1.GoldengateJavaMessageServiceConnectionProperties
Namespace
Google \ Cloud \ OracleDatabase \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ password |
string
Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text. |
↳ password_secret_version |
string
Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the associated Java Message Service. Format: projects/{project}/secrets/{secret}/versions/{version}. |
↳ trust_store_password |
string
Optional. Input only. The TrustStore password in plain text. |
↳ trust_store_password_secret_version |
string
Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. |
↳ key_store_password |
string
Optional. Input only. The KeyStore password in plain text. |
↳ key_store_password_secret_version |
string
Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}. |
↳ ssl_key_password |
string
Optional. Input only. The password for the cert inside of the KeyStore in plain text. |
↳ ssl_key_password_secret_version |
string
Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}. |
↳ technology_type |
string
Optional. The technology type of JavaMessageServiceConnection. |
↳ use_jndi |
bool
Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided. |
↳ jndi_connection_factory |
string
Optional. The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory' |
↳ jndi_provider_url |
string
Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000' |
↳ jndi_initial_context_factory |
string
Optional. The implementation of javax.naming.spi.InitialContextFactory interface used to obtain initial naming context. |
↳ jndi_security_principal |
string
Optional. Specifies the identity of the principal (user) to be authenticated. |
↳ jndi_security_credentials_secret |
string
Optional. The password associated to the principal. |
↳ connection_url |
string
Optional. Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676' |
↳ connection_factory |
string
Optional. The Java class implementing javax.jms.ConnectionFactory interface supplied by the JMS provider. |
↳ username |
string
Optional. The username Oracle Goldengate uses to connect to the Java Message Service. |
↳ security_protocol |
int
Optional. Security protocol for Java Message Service. |
↳ authentication_type |
int
Optional. Authentication type for Java Message Service. |
↳ trust_store_file |
string
Optional. The base64 encoded content of the TrustStore file. |
↳ key_store_file |
string
Optional. The base64 encoded content of the KeyStore file. |
getPassword
Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPassword
setPassword
Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the associated Java Message Service. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPasswordSecretVersion
setPasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the associated Java Message Service. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrustStorePassword
Optional. Input only. The TrustStore password in plain text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTrustStorePassword
setTrustStorePassword
Optional. Input only. The TrustStore password in plain text.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrustStorePasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTrustStorePasswordSecretVersion
setTrustStorePasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyStorePassword
Optional. Input only. The KeyStore password in plain text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKeyStorePassword
setKeyStorePassword
Optional. Input only. The KeyStore password in plain text.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyStorePasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKeyStorePasswordSecretVersion
setKeyStorePasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSslKeyPassword
Optional. Input only. The password for the cert inside of the KeyStore in plain text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSslKeyPassword
setSslKeyPassword
Optional. Input only. The password for the cert inside of the KeyStore in plain text.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSslKeyPasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore.
Format: projects/{project}/secrets/{secret}/versions/{version}.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSslKeyPasswordSecretVersion
setSslKeyPasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore.
Format: projects/{project}/secrets/{secret}/versions/{version}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTechnologyType
Optional. The technology type of JavaMessageServiceConnection.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTechnologyType
Optional. The technology type of JavaMessageServiceConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUseJndi
Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setUseJndi
Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJndiConnectionFactory
Optional. The Connection Factory can be looked up using this name.
e.g.: 'ConnectionFactory'
| Returns | |
|---|---|
| Type | Description |
string |
|
setJndiConnectionFactory
Optional. The Connection Factory can be looked up using this name.
e.g.: 'ConnectionFactory'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJndiProviderUrl
Optional. 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 | |
|---|---|
| Type | Description |
string |
|
setJndiProviderUrl
Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJndiInitialContextFactory
Optional. The implementation of javax.naming.spi.InitialContextFactory interface used to obtain initial naming context.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJndiInitialContextFactory
Optional. The implementation of javax.naming.spi.InitialContextFactory interface used to obtain initial naming context.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJndiSecurityPrincipal
Optional. Specifies the identity of the principal (user) to be authenticated.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJndiSecurityPrincipal
Optional. Specifies the identity of the principal (user) to be authenticated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJndiSecurityCredentialsSecret
Optional. The password associated to the principal.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJndiSecurityCredentialsSecret
Optional. The password associated to the principal.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectionUrl
Optional. Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
| Returns | |
|---|---|
| Type | Description |
string |
|
setConnectionUrl
Optional. Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectionFactory
Optional. The Java class implementing javax.jms.ConnectionFactory interface supplied by the JMS provider.
| Returns | |
|---|---|
| Type | Description |
string |
|
setConnectionFactory
Optional. The Java class implementing javax.jms.ConnectionFactory interface supplied by the JMS provider.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsername
Optional. The username Oracle Goldengate uses to connect to the Java Message Service.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUsername
Optional. The username Oracle Goldengate uses to connect to the Java Message Service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecurityProtocol
Optional. Security protocol for Java Message Service.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type JmsSecurityProtocol. |
setSecurityProtocol
Optional. Security protocol for Java Message Service.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type JmsSecurityProtocol. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthenticationType
Optional. Authentication type for Java Message Service.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type JmsAuthenticationType. |
setAuthenticationType
Optional. Authentication type for Java Message Service.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type JmsAuthenticationType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrustStoreFile
Optional. The base64 encoded content of the TrustStore file.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTrustStoreFile
Optional. The base64 encoded content of the TrustStore file.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyStoreFile
Optional. The base64 encoded content of the KeyStore file.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKeyStoreFile
Optional. The base64 encoded content of the KeyStore file.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectionPasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|
getTrustStorePasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|
getKeyStorePasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|
getSslKeyPasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|