Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace StreamPool

The details of a stream pool.

Properties

compartmentId

compartmentId: string

Compartment OCID that the pool belongs to.

customEncryptionKey

customEncryptionKey: CustomEncryptionKey

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}'

Optional endpointFqdn

endpointFqdn: undefined | string

The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the stream pool.

Optional isPrivate

isPrivate: undefined | false | true

True if the stream pool is private, false otherwise. If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.

kafkaSettings

kafkaSettings: KafkaSettings

lifecycleState

lifecycleState: LifecycleState

The current state of the stream pool.

Optional lifecycleStateDetails

lifecycleStateDetails: undefined | string

Any additional details about the current state of the stream.

name

name: string

The name of the stream pool.

Optional privateEndpointSettings

privateEndpointSettings: model.PrivateEndpointSettings

timeCreated

timeCreated: Date

The date and time the stream pool was created, expressed in in RFC 3339 timestamp format.

Example: {@code 2018-04-20T00:00:07.405Z}

Functions

getDeserializedJsonObj

getJsonObj