KafkaClusterSummary¶
- class oci.managed_kafka.models.KafkaClusterSummary(**kwargs)¶
Bases:
objectSummary information about a KafkaCluster.
Methods:
__init__(**kwargs)Initializes a new KafkaClusterSummary object with values from keyword arguments.
Attributes:
[Required] Gets the access_subnets of this KafkaClusterSummary.
[Required] Gets the broker_shape of this KafkaClusterSummary.
[Required] Gets the cluster_config_id of this KafkaClusterSummary.
[Required] Gets the cluster_config_version of this KafkaClusterSummary.
[Required] Gets the cluster_type of this KafkaClusterSummary.
[Required] Gets the compartment_id of this KafkaClusterSummary.
Gets the coordination_type of this KafkaClusterSummary.
[Required] Gets the defined_tags of this KafkaClusterSummary.
[Required] Gets the display_name of this KafkaClusterSummary.
[Required] Gets the freeform_tags of this KafkaClusterSummary.
[Required] Gets the id of this KafkaClusterSummary.
[Required] Gets the kafka_version of this KafkaClusterSummary.
Gets the lifecycle_details of this KafkaClusterSummary.
[Required] Gets the lifecycle_state of this KafkaClusterSummary.
Gets the system_tags of this KafkaClusterSummary.
[Required] Gets the time_created of this KafkaClusterSummary.
Gets the time_updated of this KafkaClusterSummary.
- __init__(**kwargs)¶
Initializes a new KafkaClusterSummary 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 KafkaClusterSummary.
display_name (str) – The value to assign to the display_name property of this KafkaClusterSummary.
compartment_id (str) – The value to assign to the compartment_id property of this KafkaClusterSummary.
time_created (datetime) – The value to assign to the time_created property of this KafkaClusterSummary.
time_updated (datetime) – The value to assign to the time_updated property of this KafkaClusterSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this KafkaClusterSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this KafkaClusterSummary.
access_subnets (list[oci.managed_kafka.models.SubnetSet]) – The value to assign to the access_subnets property of this KafkaClusterSummary.
kafka_version (str) – The value to assign to the kafka_version property of this KafkaClusterSummary.
cluster_type (str) – The value to assign to the cluster_type property of this KafkaClusterSummary.
broker_shape (oci.managed_kafka.models.BrokerShape) – The value to assign to the broker_shape property of this KafkaClusterSummary.
cluster_config_id (str) – The value to assign to the cluster_config_id property of this KafkaClusterSummary.
cluster_config_version (int) – The value to assign to the cluster_config_version property of this KafkaClusterSummary.
coordination_type (str) – The value to assign to the coordination_type property of this KafkaClusterSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KafkaClusterSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KafkaClusterSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this KafkaClusterSummary.
- property access_subnets¶
[Required] Gets the access_subnets of this KafkaClusterSummary. Subnets where broker/coordinator VNICs will be created.
- Returns
The access_subnets of this KafkaClusterSummary.
- Return type
- property broker_shape¶
[Required] Gets the broker_shape of this KafkaClusterSummary.
- Returns
The broker_shape of this KafkaClusterSummary.
- Return type
- property cluster_config_id¶
[Required] Gets the cluster_config_id of this KafkaClusterSummary. The OCID of Kafka Cluster configuration object
- Returns
The cluster_config_id of this KafkaClusterSummary.
- Return type
str
- property cluster_config_version¶
[Required] Gets the cluster_config_version of this KafkaClusterSummary. The version of configuration object
- Returns
The cluster_config_version of this KafkaClusterSummary.
- Return type
int
- property cluster_type¶
[Required] Gets the cluster_type of this KafkaClusterSummary. Type of the cluster to spin up. DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on single node PRODUCTION - Minimum allowed broker count is 3
- Returns
The cluster_type of this KafkaClusterSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this KafkaClusterSummary. The OCID of the compartment.
- Returns
The compartment_id of this KafkaClusterSummary.
- Return type
str
- property coordination_type¶
Gets the coordination_type of this KafkaClusterSummary. Kafka coordination type. Set of available types depends on Kafka version
- Returns
The coordination_type of this KafkaClusterSummary.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this KafkaClusterSummary. 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 KafkaClusterSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this KafkaClusterSummary. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The display_name of this KafkaClusterSummary.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this KafkaClusterSummary. 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 KafkaClusterSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this KafkaClusterSummary. The OCID of the KafkaCluster.
- Returns
The id of this KafkaClusterSummary.
- Return type
str
- property kafka_version¶
[Required] Gets the kafka_version of this KafkaClusterSummary. Version of Kafka to use to spin up the cluster
- Returns
The kafka_version of this KafkaClusterSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this KafkaClusterSummary. A message that describes the current state of the KafkaCluster 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 KafkaClusterSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this KafkaClusterSummary. The current state of the KafkaCluster.
- Returns
The lifecycle_state of this KafkaClusterSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this KafkaClusterSummary. 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 KafkaClusterSummary.
- Return type
dict(str, dict(str, object))