KafkaClusterConfig¶

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

Bases: object

A shared configuration object used by 0 or more kafka clusters.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a KafkaClusterConfig.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a KafkaClusterConfig.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a KafkaClusterConfig.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a KafkaClusterConfig.
`compartment_id`	[Required] Gets the compartment_id of this KafkaClusterConfig.
`defined_tags`	[Required] Gets the defined_tags of this KafkaClusterConfig.
`display_name`	[Required] Gets the display_name of this KafkaClusterConfig.
`freeform_tags`	[Required] Gets the freeform_tags of this KafkaClusterConfig.
`id`	[Required] Gets the id of this KafkaClusterConfig.
`latest_config`	[Required] Gets the latest_config of this KafkaClusterConfig.
`lifecycle_details`	Gets the lifecycle_details of this KafkaClusterConfig.
`lifecycle_state`	[Required] Gets the lifecycle_state of this KafkaClusterConfig.
`system_tags`	Gets the system_tags of this KafkaClusterConfig.
`time_created`	[Required] Gets the time_created of this KafkaClusterConfig.
`time_updated`	Gets the time_updated of this KafkaClusterConfig.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a KafkaClusterConfig. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a KafkaClusterConfig. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a KafkaClusterConfig. This constant has a value of “DELETED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a KafkaClusterConfig. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new KafkaClusterConfig 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 KafkaClusterConfig.
display_name (str) – The value to assign to the display_name property of this KafkaClusterConfig.
compartment_id (str) – The value to assign to the compartment_id property of this KafkaClusterConfig.
time_created (datetime) – The value to assign to the time_created property of this KafkaClusterConfig.
time_updated (datetime) – The value to assign to the time_updated property of this KafkaClusterConfig.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this KafkaClusterConfig. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this KafkaClusterConfig.
latest_config (oci.managed_kafka.models.KafkaClusterConfigVersion) – The value to assign to the latest_config property of this KafkaClusterConfig.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KafkaClusterConfig.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KafkaClusterConfig.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this KafkaClusterConfig.

compartment_id¶

[Required] Gets the compartment_id of this KafkaClusterConfig. The OCID of the compartment.

Returns:	The compartment_id of this KafkaClusterConfig.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this KafkaClusterConfig. 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 KafkaClusterConfig.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this KafkaClusterConfig. A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:	The display_name of this KafkaClusterConfig.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this KafkaClusterConfig. 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 KafkaClusterConfig.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this KafkaClusterConfig. The OCID of the KafkaClusterConfig.

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

latest_config¶

[Required] Gets the latest_config of this KafkaClusterConfig.

Returns:	The latest_config of this KafkaClusterConfig.
Return type:	oci.managed_kafka.models.KafkaClusterConfigVersion

lifecycle_details¶

Gets the lifecycle_details of this KafkaClusterConfig. 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 KafkaClusterConfig.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this KafkaClusterConfig. The current state of the KafkaClusterConfig.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this KafkaClusterConfig.
Return type:	str

system_tags¶

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

time_created¶

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

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

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

time_updated¶

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

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

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