Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace KafkaSchemaRegistryConnection

Represents the metadata of a Kafka (e.g. Confluent) Schema Registry Connection.

Properties

authenticationType

authenticationType: AuthenticationType

Used authentication mechanism to access Schema Registry.

compartmentId

compartmentId: string

The OCID of the compartment being referenced.

Const connectionType

connectionType: string = "KAFKA_SCHEMA_REGISTRY"

Optional definedTags

definedTags: undefined | object

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional description

description: undefined | string

Metadata about this specific object.

displayName

displayName: string

An object's Display Name.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {@code {\"bar-key\": \"value\"}}

id

id: string

The OCID of the connection being referenced.

Optional ingressIps

ingressIps: Array<IngressIpDetails>

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.

Optional keyId

keyId: undefined | string

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.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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.

lifecycleState

lifecycleState: LifecycleState

Possible lifecycle states for connection.

Optional nsgIds

nsgIds: Array<string>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Optional privateIp

privateIp: undefined | string

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.

Optional routingMethod

routingMethod: model.RoutingMethod

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.

Optional subnetId

subnetId: undefined | string

The OCID of the target subnet of the dedicated connection.

Optional systemTags

systemTags: undefined | object

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: {@code {orcl-cloud: {free-tier-retain: true}}}

technologyType

technologyType: TechnologyType

The Kafka (e.g. Confluent) Schema Registry technology type.

timeCreated

timeCreated: Date

The time the resource was created. The format is defined by RFC3339, such as {@code 2016-08-25T21:10:29.600Z}.

timeUpdated

timeUpdated: Date

The time the resource was last updated. The format is defined by RFC3339, such as {@code 2016-08-25T21:10:29.600Z}.

url

url: string

Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'

Optional username

username: undefined | string

The username to access Schema Registry using basic authentation. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.

Optional vaultId

vaultId: undefined | string

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.

Methods

getDeserializedJsonObj

getJsonObj