java.lang.Object
- com.oracle.bmc.goldengate.model.KafkaConnection.Builder

Enclosing class:: KafkaConnection

public static class KafkaConnection.Builder
extends Object

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`KafkaConnection.Builder`	`bootstrapServers(List<KafkaBootstrapServer> bootstrapServers)`	Kafka bootstrap.
`KafkaConnection`	`build()`
`KafkaConnection.Builder`	`clusterId(String clusterId)`	The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.
`KafkaConnection.Builder`	`clusterPlacementGroupId(String clusterPlacementGroupId)`
`KafkaConnection.Builder`	`compartmentId(String compartmentId)`
`KafkaConnection.Builder`	`consumerProperties(String consumerProperties)`	The base64 encoded content of the consumer.properties file.
`KafkaConnection.Builder`	`copy(KafkaConnection model)`
`KafkaConnection.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)`
`KafkaConnection.Builder`	`description(String description)`
`KafkaConnection.Builder`	`displayName(String displayName)`
`KafkaConnection.Builder`	`doesUseSecretIds(Boolean doesUseSecretIds)`
`KafkaConnection.Builder`	`freeformTags(Map<String,String> freeformTags)`
`KafkaConnection.Builder`	`id(String id)`
`KafkaConnection.Builder`	`ingressIps(List<IngressIpDetails> ingressIps)`
`KafkaConnection.Builder`	`keyId(String keyId)`
`KafkaConnection.Builder`	`keyStorePasswordSecretId(String keyStorePasswordSecretId)`	The OCID of the Secret where the kafka KeyStore password is stored.
`KafkaConnection.Builder`	`keyStoreSecretId(String keyStoreSecretId)`	The OCID of the Secret where the content of the KeyStore file is stored.
`KafkaConnection.Builder`	`lifecycleDetails(String lifecycleDetails)`
`KafkaConnection.Builder`	`lifecycleState(Connection.LifecycleState lifecycleState)`
`KafkaConnection.Builder`	`locks(List<ResourceLock> locks)`
`KafkaConnection.Builder`	`nsgIds(List<String> nsgIds)`
`KafkaConnection.Builder`	`passwordSecretId(String passwordSecretId)`	The OCID of the Secret where the password is stored.
`KafkaConnection.Builder`	`producerProperties(String producerProperties)`	The base64 encoded content of the producer.properties file.
`KafkaConnection.Builder`	`routingMethod(RoutingMethod routingMethod)`
`KafkaConnection.Builder`	`securityAttributes(Map<String,Map<String,Object>> securityAttributes)`
`KafkaConnection.Builder`	`securityProtocol(KafkaConnection.SecurityProtocol securityProtocol)`	Kafka security protocol.
`KafkaConnection.Builder`	`shouldUseResourcePrincipal(Boolean shouldUseResourcePrincipal)`	Specifies that the user intends to authenticate to the instance using a resource principal.
`KafkaConnection.Builder`	`sslKeyPasswordSecretId(String sslKeyPasswordSecretId)`	The OCID of the Secret where the kafka Ssl Key password is stored.
`KafkaConnection.Builder`	`streamPoolId(String streamPoolId)`	The OCID of the stream pool being referenced.
`KafkaConnection.Builder`	`subnetId(String subnetId)`
`KafkaConnection.Builder`	`subscriptionId(String subscriptionId)`
`KafkaConnection.Builder`	`systemTags(Map<String,Map<String,Object>> systemTags)`
`KafkaConnection.Builder`	`technologyType(KafkaConnection.TechnologyType technologyType)`	The Kafka technology type.
`KafkaConnection.Builder`	`timeCreated(Date timeCreated)`
`KafkaConnection.Builder`	`timeUpdated(Date timeUpdated)`
`KafkaConnection.Builder`	`trustStorePasswordSecretId(String trustStorePasswordSecretId)`	The OCID of the Secret where the kafka TrustStore password is stored.
`KafkaConnection.Builder`	`trustStoreSecretId(String trustStoreSecretId)`	The OCID of the Secret where the content of the TrustStore file is stored.
`KafkaConnection.Builder`	`username(String username)`	The username Oracle GoldenGate uses to connect the associated system of the given technology.
`KafkaConnection.Builder`	`vaultId(String vaultId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public KafkaConnection.Builder id(String id)
```
  - displayName
```
public KafkaConnection.Builder displayName(String displayName)
```
  - description
```
public KafkaConnection.Builder description(String description)
```
  - compartmentId
```
public KafkaConnection.Builder compartmentId(String compartmentId)
```
  - freeformTags
```
public KafkaConnection.Builder freeformTags(Map<String,String> freeformTags)
```
  - definedTags
```
public KafkaConnection.Builder definedTags(Map<String,Map<String,Object>> definedTags)
```
  - systemTags
```
public KafkaConnection.Builder systemTags(Map<String,Map<String,Object>> systemTags)
```
  - lifecycleState
```
public KafkaConnection.Builder lifecycleState(Connection.LifecycleState lifecycleState)
```
  - lifecycleDetails
```
public KafkaConnection.Builder lifecycleDetails(String lifecycleDetails)
```
  - timeCreated
```
public KafkaConnection.Builder timeCreated(Date timeCreated)
```
  - timeUpdated
```
public KafkaConnection.Builder timeUpdated(Date timeUpdated)
```
  - locks
```
public KafkaConnection.Builder locks(List<ResourceLock> locks)
```
  - vaultId
```
public KafkaConnection.Builder vaultId(String vaultId)
```
  - keyId
```
public KafkaConnection.Builder keyId(String keyId)
```
  - ingressIps
```
public KafkaConnection.Builder ingressIps(List<IngressIpDetails> ingressIps)
```
  - nsgIds
```
public KafkaConnection.Builder nsgIds(List<String> nsgIds)
```
  - subnetId
```
public KafkaConnection.Builder subnetId(String subnetId)
```
  - routingMethod
```
public KafkaConnection.Builder routingMethod(RoutingMethod routingMethod)
```
  - doesUseSecretIds
```
public KafkaConnection.Builder doesUseSecretIds(Boolean doesUseSecretIds)
```
  - subscriptionId
```
public KafkaConnection.Builder subscriptionId(String subscriptionId)
```
  - clusterPlacementGroupId
```
public KafkaConnection.Builder clusterPlacementGroupId(String clusterPlacementGroupId)
```
  - securityAttributes
```
public KafkaConnection.Builder securityAttributes(Map<String,Map<String,Object>> securityAttributes)
```
  - technologyType
```
public KafkaConnection.Builder technologyType(KafkaConnection.TechnologyType technologyType)
```
    The Kafka technology type.
    
    Parameters:
    
    technologyType - the value to set
    
    Returns:
    
    this builder
  - streamPoolId
```
public KafkaConnection.Builder streamPoolId(String streamPoolId)
```
    The OCID of the stream pool being referenced.
    
    Parameters:
    
    streamPoolId - the value to set
    
    Returns:
    
    this builder
  - clusterId
```
public KafkaConnection.Builder clusterId(String clusterId)
```
    The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.
    
    Parameters:
    
    clusterId - the value to set
    
    Returns:
    
    this builder
  - bootstrapServers
```
public KafkaConnection.Builder bootstrapServers(List<KafkaBootstrapServer> bootstrapServers)
```
    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”
    
    Parameters:
    
    bootstrapServers - the value to set
    
    Returns:
    
    this builder
  - securityProtocol
```
public KafkaConnection.Builder securityProtocol(KafkaConnection.SecurityProtocol securityProtocol)
```
    Kafka security protocol.
    
    Parameters:
    
    securityProtocol - the value to set
    
    Returns:
    
    this builder
  - username
```
public KafkaConnection.Builder username(String username)
```
    The username Oracle GoldenGate uses to connect the associated system of the given technology.
    This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.
    
    Parameters:
    
    username - the value to set
    
    Returns:
    
    this builder
  - passwordSecretId
```
public KafkaConnection.Builder passwordSecretId(String passwordSecretId)
```
    The OCID of the Secret where the password is stored.
    The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, ‘password’ field must not be provided.
    
    Parameters:
    
    passwordSecretId - the value to set
    
    Returns:
    
    this builder
  - trustStoreSecretId
```
public KafkaConnection.Builder trustStoreSecretId(String trustStoreSecretId)
```
    The OCID of the Secret where the content of the TrustStore file is stored.
    Note: When provided, ‘trustStore’ field must not be provided.
    
    Parameters:
    
    trustStoreSecretId - the value to set
    
    Returns:
    
    this builder
  - trustStorePasswordSecretId
```
public KafkaConnection.Builder trustStorePasswordSecretId(String trustStorePasswordSecretId)
```
    The OCID of the Secret where the kafka TrustStore password is stored.
    Note: When provided, ‘trustStorePassword’ field must not be provided.
    
    Parameters:
    
    trustStorePasswordSecretId - the value to set
    
    Returns:
    
    this builder
  - keyStoreSecretId
```
public KafkaConnection.Builder keyStoreSecretId(String keyStoreSecretId)
```
    The OCID of the Secret where the content of the KeyStore file is stored.
    Note: When provided, ‘keyStore’ field must not be provided.
    
    Parameters:
    
    keyStoreSecretId - the value to set
    
    Returns:
    
    this builder
  - keyStorePasswordSecretId
```
public KafkaConnection.Builder keyStorePasswordSecretId(String keyStorePasswordSecretId)
```
    The OCID of the Secret where the kafka KeyStore password is stored.
    Note: When provided, ‘keyStorePassword’ field must not be provided.
    
    Parameters:
    
    keyStorePasswordSecretId - the value to set
    
    Returns:
    
    this builder
  - sslKeyPasswordSecretId
```
public KafkaConnection.Builder sslKeyPasswordSecretId(String sslKeyPasswordSecretId)
```
    The OCID of the Secret where the kafka Ssl Key password is stored.
    Note: When provided, ‘sslKeyPassword’ field must not be provided.
    
    Parameters:
    
    sslKeyPasswordSecretId - the value to set
    
    Returns:
    
    this builder
  - consumerProperties
```
public KafkaConnection.Builder consumerProperties(String consumerProperties)
```
    The base64 encoded content of the consumer.properties file.
    
    Parameters:
    
    consumerProperties - the value to set
    
    Returns:
    
    this builder
  - producerProperties
```
public KafkaConnection.Builder producerProperties(String producerProperties)
```
    The base64 encoded content of the producer.properties file.
    
    Parameters:
    
    producerProperties - the value to set
    
    Returns:
    
    this builder
  - shouldUseResourcePrincipal
```
public KafkaConnection.Builder shouldUseResourcePrincipal(Boolean shouldUseResourcePrincipal)
```
    Specifies that the user intends to authenticate to the instance using a resource principal.
    Applicable only for OCI Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, ‘username’/‘password’/‘passwordSecretId’ fields must not be provided. Default: false
    
    Parameters:
    
    shouldUseResourcePrincipal - the value to set
    
    Returns:
    
    this builder
  - build
```
public KafkaConnection build()
```
  - copy
```
public KafkaConnection.Builder copy(KafkaConnection model)
```

Class KafkaConnection.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

displayName

description

compartmentId

freeformTags

definedTags

systemTags

lifecycleState

lifecycleDetails

timeCreated

timeUpdated

locks

vaultId

keyId

ingressIps

nsgIds

subnetId

routingMethod

doesUseSecretIds

subscriptionId

clusterPlacementGroupId

securityAttributes

technologyType

streamPoolId

clusterId

bootstrapServers

securityProtocol

username

passwordSecretId

trustStoreSecretId

trustStorePasswordSecretId

keyStoreSecretId

keyStorePasswordSecretId

sslKeyPasswordSecretId

consumerProperties

producerProperties

shouldUseResourcePrincipal

build

copy