Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace StreamPoolSummary

The summary representation of a stream pool.

Properties

compartmentId

compartmentId: string

Compartment OCID that the pool belongs to.

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: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair that is applied 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. The associated endpoint and subnetId of a private stream pool can be retrieved through the {@link #getStreamPool(GetStreamPoolRequest) getStreamPool} API.

lifecycleState

lifecycleState: LifecycleState

The current state of the stream pool.

name

name: string

The name of the stream pool.

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