Skip to content

streaming.oracle.com/v1beta1

Back to API Reference

APIVersion: streaming.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

Package Support Latest release Resources
Streaming preview v2.0.0-alpha Stream

Resources

Kind Scope Sample Packages
Stream Namespaced Sample Streaming (v2.0.0-alpha)

Stream

Manage OCI Streaming streams.

  • Plural: streams
  • Scope: Namespaced
  • APIVersion: streaming.oracle.com/v1beta1
  • Sample: Sample (config/samples/streaming_v1beta1_stream.yaml)
  • Packages: Streaming (v2.0.0-alpha)

Spec

StreamSpec defines the desired state of Stream.

Field Description Type Required Default Enum
compartmentId The OCID of the compartment that contains the stream. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
name The name of the stream. Avoid entering confidential information. Example: TelemetryEvents string Yes - -
partitions The number of partitions in the stream. integer Yes - -
retentionInHours The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days). If not specified, the stream will have a retention period of 24 hours. integer No - -
streamPoolId The OCID of the stream pool that contains the stream. string No - -

Status

StreamStatus defines the observed state of Stream.

Field Description Type Required Default Enum
compartmentId The OCID of the stream. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}' |map[string, map[string, string]]` No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID of the stream. string No - -
lifecycleState The current state of the stream. string No - -
lifecycleStateDetails Any additional details about the current state of the stream. string No - -
messagesEndpoint 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. string No - -
name The name of the stream. Avoid entering confidential information. Example: TelemetryEvents string No - -
partitions The number of partitions in the stream. integer No - -
retentionInHours The retention period of the stream, in hours. This property is read-only. integer No - -
status - object Yes - -
streamPoolId The OCID of the stream pool that contains the stream. string No - -
timeCreated The date and time the stream was created, expressed in in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: 2018-04-20T00:00:07.405Z string No - -

Status.status

Back to Stream status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Stream status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Stream status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Stream status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -