Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Stream

Detailed representation of a stream, including all its partitions.

Properties

compartmentId

compartmentId: string

The OCID of the stream.

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 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.

lifecycleState

lifecycleState: LifecycleState

The current state of the stream.

Optional lifecycleStateDetails

lifecycleStateDetails: undefined | string

Any additional details about the current state of the stream.

messagesEndpoint

messagesEndpoint: string

The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.

name

name: string

The name of the stream. Avoid entering confidential information.

Example: {@code TelemetryEvents}

partitions

partitions: number

The number of partitions in the stream. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

retentionInHours

retentionInHours: number

The retention period of the stream, in hours. This property is read-only. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

streamPoolId

streamPoolId: string

The OCID of the stream pool that contains the stream.

timeCreated

timeCreated: Date

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

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

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Stream): object

getJsonObj

  • getJsonObj(obj: Stream): object