# Interface GoldengateDb2ConnectionPropertiesOrBuilder (0.42.0)

0.42.0 (latest) 0.40.0 0.37.0 0.36.0 0.34.0 0.32.0 0.31.0 0.29.0 0.27.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.19.0 0.17.0 0.16.0 0.13.0 0.12.0 0.11.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

    public interface GoldengateDb2ConnectionPropertiesOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getAdditionalAttributes(int index)

    public abstract NameValuePair getAdditionalAttributes(int index)

Optional. An array of name-value pair attribute entries.
Used as additional parameters in connection string.

`
repeated .google.cloud.oracledatabase.v1.NameValuePair additional_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.NameValuePair` |   |

### getAdditionalAttributesCount()

    public abstract int getAdditionalAttributesCount()

Optional. An array of name-value pair attribute entries.
Used as additional parameters in connection string.

`
repeated .google.cloud.oracledatabase.v1.NameValuePair additional_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getAdditionalAttributesList()

    public abstract List<NameValuePair> getAdditionalAttributesList()

Optional. An array of name-value pair attribute entries.
Used as additional parameters in connection string.

`
repeated .google.cloud.oracledatabase.v1.NameValuePair additional_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.NameValuePair>` |   |

### getAdditionalAttributesOrBuilder(int index)

    public abstract NameValuePairOrBuilder getAdditionalAttributesOrBuilder(int index)

Optional. An array of name-value pair attribute entries.
Used as additional parameters in connection string.

`
repeated .google.cloud.oracledatabase.v1.NameValuePair additional_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.NameValuePairOrBuilder` |   |

### getAdditionalAttributesOrBuilderList()

    public abstract List<? extends NameValuePairOrBuilder> getAdditionalAttributesOrBuilderList()

Optional. An array of name-value pair attribute entries.
Used as additional parameters in connection string.

`
repeated .google.cloud.oracledatabase.v1.NameValuePair additional_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.oracledatabase.v1.NameValuePairOrBuilder>` |   |

### getConnectionPasswordOptionsCase()

    public abstract GoldengateDb2ConnectionProperties.ConnectionPasswordOptionsCase getConnectionPasswordOptionsCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.GoldengateDb2ConnectionProperties.ConnectionPasswordOptionsCase` |   |

### getDatabase()

    public abstract String getDatabase()

Optional. The name of the database.

`string database = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The database. |

### getDatabaseBytes()

    public abstract ByteString getDatabaseBytes()

Optional. The name of the database.

`string database = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for database. |

### getHost()

    public abstract String getHost()

Optional. The name or address of a host.

`string host = 2 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The host. |

### getHostBytes()

    public abstract ByteString getHostBytes()

Optional. The name or address of a host.

`string host = 2 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for host. |

### getPassword()

    public abstract String getPassword()

Optional. Input only. The password Oracle Goldengate uses for Db2
connection in plain text.

`
string password = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The password. |

### getPasswordBytes()

    public abstract ByteString getPasswordBytes()

Optional. Input only. The password Oracle Goldengate uses for Db2
connection in plain text.

`
string password = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for password. |

### getPasswordSecretVersion()

    public abstract String getPasswordSecretVersion()

Optional. Input only. The resource name of a secret version in Secret
Manager which contains the password Oracle Goldengate uses for Db2
connection. Format:
projects/{project}/secrets/{secret}/versions/{version}.

`
string password_secret_version = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The passwordSecretVersion. |

### getPasswordSecretVersionBytes()

    public abstract ByteString getPasswordSecretVersionBytes()

Optional. Input only. The resource name of a secret version in Secret
Manager which contains the password Oracle Goldengate uses for Db2
connection. Format:
projects/{project}/secrets/{secret}/versions/{version}.

`
string password_secret_version = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for passwordSecretVersion. |

### getPort()

    public abstract int getPort()

Optional. The port of an endpoint usually specified for a connection.

`int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The port. |

### getSecurityProtocol()

    public abstract GoldengateDb2ConnectionProperties.Db2SecurityProtocol getSecurityProtocol()

Optional. Security protocol for the DB2 database.

`
.google.cloud.oracledatabase.v1.GoldengateDb2ConnectionProperties.Db2SecurityProtocol security_protocol = 6 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-oracledatabase/latest/com.google.cloud.oracledatabase.v1.GoldengateDb2ConnectionProperties.Db2SecurityProtocol` | The securityProtocol. |

### getSecurityProtocolValue()

    public abstract int getSecurityProtocolValue()

Optional. Security protocol for the DB2 database.

`
.google.cloud.oracledatabase.v1.GoldengateDb2ConnectionProperties.Db2SecurityProtocol security_protocol = 6 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for securityProtocol. |

### getSslClientKeystashFile()

    public abstract String getSslClientKeystashFile()

Optional. The keystash file which contains the encrypted password to
the key database file. Not supported for IBM Db2 for i.

`string ssl_client_keystash_file = 10 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The sslClientKeystashFile. |

### getSslClientKeystashFileBytes()

    public abstract ByteString getSslClientKeystashFileBytes()

Optional. The keystash file which contains the encrypted password to
the key database file. Not supported for IBM Db2 for i.

`string ssl_client_keystash_file = 10 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for sslClientKeystashFile. |

### getSslClientKeystoredbFile()

    public abstract String getSslClientKeystoredbFile()

Optional. The keystore file created at the client containing the
server certificate / CA root certificate. Not supported for IBM Db2 for i.

`string ssl_client_keystoredb_file = 9 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The sslClientKeystoredbFile. |

### getSslClientKeystoredbFileBytes()

    public abstract ByteString getSslClientKeystoredbFileBytes()

Optional. The keystore file created at the client containing the
server certificate / CA root certificate. Not supported for IBM Db2 for i.

`string ssl_client_keystoredb_file = 9 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for sslClientKeystoredbFile. |

### getSslServerCertificateFile()

    public abstract String getSslServerCertificateFile()

Optional. The file which contains the self-signed server certificate
/ Certificate Authority (CA) certificate.

`string ssl_server_certificate_file = 11 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The sslServerCertificateFile. |

### getSslServerCertificateFileBytes()

    public abstract ByteString getSslServerCertificateFileBytes()

Optional. The file which contains the self-signed server certificate
/ Certificate Authority (CA) certificate.

`string ssl_server_certificate_file = 11 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for sslServerCertificateFile. |

### getTechnologyType()

    public abstract String getTechnologyType()

Optional. The technology type of Db2Connection.

`string technology_type = 1 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The technologyType. |

### getTechnologyTypeBytes()

    public abstract ByteString getTechnologyTypeBytes()

Optional. The technology type of Db2Connection.

`string technology_type = 1 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for technologyType. |

### getUsername()

    public abstract String getUsername()

Optional. The username Oracle Goldengate uses to connect to the DB2
database.

`string username = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The username. |

### getUsernameBytes()

    public abstract ByteString getUsernameBytes()

Optional. The username Oracle Goldengate uses to connect to the DB2
database.

`string username = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for username. |

### hasPassword()

    public abstract boolean hasPassword()

Optional. Input only. The password Oracle Goldengate uses for Db2
connection in plain text.

`
string password = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the password field is set. |

### hasPasswordSecretVersion()

    public abstract boolean hasPasswordSecretVersion()

Optional. Input only. The resource name of a secret version in Secret
Manager which contains the password Oracle Goldengate uses for Db2
connection. Format:
projects/{project}/secrets/{secret}/versions/{version}.

`
string password_secret_version = 13 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the passwordSecretVersion field is set. |