KafkaClusterSummary¶

class oci.managed_kafka.models.KafkaClusterSummary(**kwargs)¶

Bases: object

Summary information about a KafkaCluster.

Methods

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

Attributes

`access_subnets`	[Required] Gets the access_subnets of this KafkaClusterSummary.
`broker_shape`	[Required] Gets the broker_shape of this KafkaClusterSummary.
`cluster_config_id`	[Required] Gets the cluster_config_id of this KafkaClusterSummary.
`cluster_config_version`	[Required] Gets the cluster_config_version of this KafkaClusterSummary.
`cluster_type`	[Required] Gets the cluster_type of this KafkaClusterSummary.
`compartment_id`	[Required] Gets the compartment_id of this KafkaClusterSummary.
`coordination_type`	Gets the coordination_type of this KafkaClusterSummary.
`defined_tags`	[Required] Gets the defined_tags of this KafkaClusterSummary.
`display_name`	[Required] Gets the display_name of this KafkaClusterSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this KafkaClusterSummary.
`id`	[Required] Gets the id of this KafkaClusterSummary.
`kafka_version`	[Required] Gets the kafka_version of this KafkaClusterSummary.
`lifecycle_details`	Gets the lifecycle_details of this KafkaClusterSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this KafkaClusterSummary.
`system_tags`	Gets the system_tags of this KafkaClusterSummary.
`time_created`	[Required] Gets the time_created of this KafkaClusterSummary.
`time_updated`	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.

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:	list[oci.managed_kafka.models.SubnetSet]

broker_shape¶

[Required] Gets the broker_shape of this KafkaClusterSummary.

Returns:	The broker_shape of this KafkaClusterSummary.
Return type:	oci.managed_kafka.models.BrokerShape

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

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

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

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

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

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))

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

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)

id¶

[Required] Gets the id of this KafkaClusterSummary. The OCID of the KafkaCluster.

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

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

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

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

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))

time_created¶

[Required] Gets the time_created of this KafkaClusterSummary. The date and time the KafkaCluster was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this KafkaClusterSummary. The date and time the KafkaCluster was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this KafkaClusterSummary.
Return type:	datetime