StreamPool

class oci.streaming.models.StreamPool(**kwargs)

Bases: object

The details of a stream pool.

Attributes

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

Methods

__init__(**kwargs) Initializes a new StreamPool object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a StreamPool. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a StreamPool. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a StreamPool. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a StreamPool. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a StreamPool. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a StreamPool. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new StreamPool 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 StreamPool.
  • compartment_id (str) – The value to assign to the compartment_id property of this StreamPool.
  • name (str) – The value to assign to the name property of this StreamPool.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this StreamPool. 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 StreamPool.
  • time_created (datetime) – The value to assign to the time_created property of this StreamPool.
  • kafka_settings (KafkaSettings) – The value to assign to the kafka_settings property of this StreamPool.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this StreamPool.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this StreamPool.
compartment_id

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

Returns:The compartment_id of this StreamPool.
Return type:str
defined_tags

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

Gets the freeform_tags of this StreamPool. 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 StreamPool.
Return type:dict(str, str)
id

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

Returns:The id of this StreamPool.
Return type:str
kafka_settings

[Required] Gets the kafka_settings of this StreamPool.

Returns:The kafka_settings of this StreamPool.
Return type:KafkaSettings
lifecycle_state

[Required] Gets the lifecycle_state of this StreamPool. 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 StreamPool.
Return type:str
lifecycle_state_details

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

Returns:The lifecycle_state_details of this StreamPool.
Return type:str
name

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

Returns:The name of this StreamPool.
Return type:str
time_created

[Required] Gets the time_created of this StreamPool. 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 StreamPool.
Return type:datetime