KafkaClusterConfigSummary¶
- class oci.managed_kafka.models.KafkaClusterConfigSummary(**kwargs)¶
Bases:
objectSummary information about a KafkaClusterConfig.
Methods:
__init__(**kwargs)Initializes a new KafkaClusterConfigSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this KafkaClusterConfigSummary.
[Required] Gets the defined_tags of this KafkaClusterConfigSummary.
[Required] Gets the display_name of this KafkaClusterConfigSummary.
[Required] Gets the freeform_tags of this KafkaClusterConfigSummary.
[Required] Gets the id of this KafkaClusterConfigSummary.
Gets the lifecycle_details of this KafkaClusterConfigSummary.
[Required] Gets the lifecycle_state of this KafkaClusterConfigSummary.
Gets the system_tags of this KafkaClusterConfigSummary.
[Required] Gets the time_created of this KafkaClusterConfigSummary.
Gets the time_updated of this KafkaClusterConfigSummary.
- __init__(**kwargs)¶
Initializes a new KafkaClusterConfigSummary 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 KafkaClusterConfigSummary.
display_name (str) – The value to assign to the display_name property of this KafkaClusterConfigSummary.
compartment_id (str) – The value to assign to the compartment_id property of this KafkaClusterConfigSummary.
time_created (datetime) – The value to assign to the time_created property of this KafkaClusterConfigSummary.
time_updated (datetime) – The value to assign to the time_updated property of this KafkaClusterConfigSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this KafkaClusterConfigSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this KafkaClusterConfigSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KafkaClusterConfigSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KafkaClusterConfigSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this KafkaClusterConfigSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this KafkaClusterConfigSummary. The OCID of the compartment.
- Returns
The compartment_id of this KafkaClusterConfigSummary.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this KafkaClusterConfigSummary. 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 KafkaClusterConfigSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this KafkaClusterConfigSummary. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The display_name of this KafkaClusterConfigSummary.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this KafkaClusterConfigSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this KafkaClusterConfigSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this KafkaClusterConfigSummary. The OCID of the KafkaClusterConfig.
- Returns
The id of this KafkaClusterConfigSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this KafkaClusterConfigSummary. A message that describes the current state of the KafkaClusterConfig in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- Returns
The lifecycle_details of this KafkaClusterConfigSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this KafkaClusterConfigSummary. The current state of the KafkaClusterConfig.
- Returns
The lifecycle_state of this KafkaClusterConfigSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this KafkaClusterConfigSummary. System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this KafkaClusterConfigSummary.
- Return type
dict(str, dict(str, object))