Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class GoldengateKafkaConnectionProperties.
The properties of GoldengateKafkaConnection.
Generated from protobuf message google.cloud.oracledatabase.v1.GoldengateKafkaConnectionProperties
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 for Kafka basic/SASL auth in plain text. |
↳ password_secret_version |
string
Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for Kafka basic/SASL auth. 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 KafkaConnection. |
↳ stream_pool_id |
string
Optional. The OCID of the stream pool being referenced. |
↳ cluster_id |
string
Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka. |
↳ bootstrap_servers |
array<KafkaBootstrapServer>
Optional. Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092" |
↳ security_protocol |
int
Optional. Security Type for Kafka. |
↳ username |
string
Optional. The username Oracle Goldengate uses to connect the associated system of the given technology. |
↳ 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. |
↳ consumer_properties_file |
string
Optional. The base64 encoded content of the consumer.properties file. |
↳ producer_properties_file |
string
Optional. The base64 encoded content of the producer.properties file. |
↳ use_resource_principal |
bool
Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections. |
getPassword
Optional. Input only. The password for Kafka basic/SASL auth in plain text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPassword
setPassword
Optional. Input only. The password for Kafka basic/SASL auth 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 for Kafka basic/SASL auth. 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 for Kafka basic/SASL auth. 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 KafkaConnection.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTechnologyType
Optional. The technology type of KafkaConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStreamPoolId
Optional. The OCID of the stream pool being referenced.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStreamPoolId
Optional. The OCID of the stream pool being referenced.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClusterId
Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClusterId
Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBootstrapServers
Optional. Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<KafkaBootstrapServer> |
|
setBootstrapServers
Optional. Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: "server1.example.com:9092,server2.example.com:9092"
| Parameter | |
|---|---|
| Name | Description |
var |
array<KafkaBootstrapServer>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecurityProtocol
Optional. Security Type for Kafka.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type KafkaSecurityProtocol. |
setSecurityProtocol
Optional. Security Type for Kafka.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type KafkaSecurityProtocol. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsername
Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUsername
Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 |
|
getConsumerPropertiesFile
Optional. The base64 encoded content of the consumer.properties file.
| Returns | |
|---|---|
| Type | Description |
string |
|
setConsumerPropertiesFile
Optional. The base64 encoded content of the consumer.properties file.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProducerPropertiesFile
Optional. The base64 encoded content of the producer.properties file.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProducerPropertiesFile
Optional. The base64 encoded content of the producer.properties file.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUseResourcePrincipal
Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setUseResourcePrincipal
Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectionPasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|
getTrustStorePasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|
getKeyStorePasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|
getSslKeyPasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|