StreamPoolSummary¶

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

Bases: object

The summary representation of a stream pool.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a StreamPoolSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a StreamPoolSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a StreamPoolSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a StreamPoolSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a StreamPoolSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a StreamPoolSummary.
`compartment_id`	[Required] Gets the compartment_id of this StreamPoolSummary.
`defined_tags`	Gets the defined_tags of this StreamPoolSummary.
`freeform_tags`	Gets the freeform_tags of this StreamPoolSummary.
`id`	[Required] Gets the id of this StreamPoolSummary.
`is_private`	Gets the is_private of this StreamPoolSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this StreamPoolSummary.
`name`	[Required] Gets the name of this StreamPoolSummary.
`time_created`	[Required] Gets the time_created of this StreamPoolSummary.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this StreamPoolSummary.
compartment_id (str) – The value to assign to the compartment_id property of this StreamPoolSummary.
name (str) – The value to assign to the name property of this StreamPoolSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this StreamPoolSummary. 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’.
time_created (datetime) – The value to assign to the time_created property of this StreamPoolSummary.
is_private (bool) – The value to assign to the is_private property of this StreamPoolSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this StreamPoolSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this StreamPoolSummary.

compartment_id¶

[Required] Gets the compartment_id of this StreamPoolSummary. Compartment OCID that the pool belongs to.

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

defined_tags¶

Gets the defined_tags of this StreamPoolSummary. 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 StreamPoolSummary.
Return type:	dict(str, dict(str, object))

freeform_tags¶

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

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

id¶

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

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

is_private¶

Gets the is_private of this StreamPoolSummary. True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the get_stream_pool() API.

Returns:	The is_private of this StreamPoolSummary.
Return type:	bool

lifecycle_state¶

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

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 StreamPoolSummary.
Return type:	str

name¶

[Required] Gets the name of this StreamPoolSummary. The name of the stream pool.

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

time_created¶

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

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

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