CreateStreamDetails¶
- class oci.streaming.models.CreateStreamDetails(**kwargs)¶
Bases:
objectObject used to create a stream.
Methods:
__init__(**kwargs)Initializes a new CreateStreamDetails object with values from keyword arguments.
Attributes:
Gets the compartment_id of this CreateStreamDetails.
Gets the defined_tags of this CreateStreamDetails.
Gets the freeform_tags of this CreateStreamDetails.
[Required] Gets the name of this CreateStreamDetails.
[Required] Gets the partitions of this CreateStreamDetails.
Gets the retention_in_hours of this CreateStreamDetails.
Gets the stream_pool_id of this CreateStreamDetails.
- __init__(**kwargs)¶
Initializes a new CreateStreamDetails 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 CreateStreamDetails.
partitions (int) – The value to assign to the partitions property of this CreateStreamDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateStreamDetails.
stream_pool_id (str) – The value to assign to the stream_pool_id property of this CreateStreamDetails.
retention_in_hours (int) – The value to assign to the retention_in_hours property of this CreateStreamDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateStreamDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateStreamDetails.
- property compartment_id¶
Gets the compartment_id of this CreateStreamDetails. The OCID of the compartment that contains the stream.
- Returns
The compartment_id of this CreateStreamDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateStreamDetails. 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 CreateStreamDetails.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this CreateStreamDetails. 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 CreateStreamDetails.
- Return type
dict(str, str)
- property name¶
[Required] Gets the name of this CreateStreamDetails. The name of the stream. Avoid entering confidential information.
Example: TelemetryEvents
- Returns
The name of this CreateStreamDetails.
- Return type
str
- property partitions¶
[Required] Gets the partitions of this CreateStreamDetails. The number of partitions in the stream.
- Returns
The partitions of this CreateStreamDetails.
- Return type
int
- property retention_in_hours¶
Gets the retention_in_hours of this CreateStreamDetails. 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.
- Returns
The retention_in_hours of this CreateStreamDetails.
- Return type
int
- property stream_pool_id¶
Gets the stream_pool_id of this CreateStreamDetails. The OCID of the stream pool that contains the stream.
- Returns
The stream_pool_id of this CreateStreamDetails.
- Return type
str