Stream¶

class oci.streaming.models.Stream(**kwargs)¶

Bases: object

Detailed representation of a stream, including all its partitions.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Stream.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Stream.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Stream.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Stream.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Stream.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Stream.
`compartment_id`	[Required] Gets the compartment_id of this Stream.
`defined_tags`	Gets the defined_tags of this Stream.
`freeform_tags`	Gets the freeform_tags of this Stream.
`id`	[Required] Gets the id of this Stream.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Stream.
`lifecycle_state_details`	Gets the lifecycle_state_details of this Stream.
`messages_endpoint`	[Required] Gets the messages_endpoint of this Stream.
`name`	[Required] Gets the name of this Stream.
`partitions`	[Required] Gets the partitions of this Stream.
`retention_in_hours`	[Required] Gets the retention_in_hours of this Stream.
`stream_pool_id`	[Required] Gets the stream_pool_id of this Stream.
`time_created`	[Required] Gets the time_created of this Stream.

Methods

__init__(**kwargs) Initializes a new Stream object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Stream. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Stream. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Stream. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Stream. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Stream. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Stream. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new Stream object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this Stream.
id (str) – The value to assign to the id property of this Stream.
partitions (int) – The value to assign to the partitions property of this Stream.
retention_in_hours (int) – The value to assign to the retention_in_hours property of this Stream.
compartment_id (str) – The value to assign to the compartment_id property of this Stream.
stream_pool_id (str) – The value to assign to the stream_pool_id property of this Stream.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Stream. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this Stream.
time_created (datetime) – The value to assign to the time_created property of this Stream.
messages_endpoint (str) – The value to assign to the messages_endpoint property of this Stream.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Stream.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Stream.

compartment_id¶

[Required] Gets the compartment_id of this Stream. The OCID of the stream.

Returns:	The compartment_id of this Stream.
Return type:	str

defined_tags¶

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

Example: `{“Operations”: {“CostCenter”: “42”}}’

Returns:	The defined_tags of this Stream.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this Stream. 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: {“Department”: “Finance”}

Returns:	The freeform_tags of this Stream.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Stream. The OCID of the stream.

Returns:	The id of this Stream.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Stream. The current state of the stream.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Stream.
Return type:	str

lifecycle_state_details¶

Gets the lifecycle_state_details of this Stream. Any additional details about the current state of the stream.

Returns:	The lifecycle_state_details of this Stream.
Return type:	str

messages_endpoint¶

[Required] Gets the messages_endpoint of this Stream. 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.

Returns:	The messages_endpoint of this Stream.
Return type:	str

name¶

[Required] Gets the name of this Stream. The name of the stream. Avoid entering confidential information.

Example: TelemetryEvents

Returns:	The name of this Stream.
Return type:	str

partitions¶

[Required] Gets the partitions of this Stream. The number of partitions in the stream.

Returns:	The partitions of this Stream.
Return type:	int

retention_in_hours¶

[Required] Gets the retention_in_hours of this Stream. The retention period of the stream, in hours. This property is read-only.

Returns:	The retention_in_hours of this Stream.
Return type:	int

stream_pool_id¶

[Required] Gets the stream_pool_id of this Stream. The OCID of the stream pool that contains the stream.

Returns:	The stream_pool_id of this Stream.
Return type:	str

time_created¶

[Required] Gets the time_created of this Stream. The date and time the stream was created, expressed in in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:	The time_created of this Stream.
Return type:	datetime