KafkaClusterAddon¶
- class oci.managed_kafka.models.KafkaClusterAddon(**kwargs)¶
Bases:
objectThe base data object to represent a KafkaClusterAddon.
Attributes:
A constant which can be used with the addon_type property of a KafkaClusterAddon.
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.
[Required] Gets the addon_type of this KafkaClusterAddon.
Gets the description of this KafkaClusterAddon.
[Required] Gets the lifecycle_state of this KafkaClusterAddon.
[Required] Gets the name of this KafkaClusterAddon.
Gets the time_created of this KafkaClusterAddon.
Gets the time_updated of this KafkaClusterAddon.
Methods:
__init__(**kwargs)Initializes a new KafkaClusterAddon object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- ADDON_TYPE_PUBLICCONNECTIVITY = 'PUBLICCONNECTIVITY'¶
A constant which can be used with the addon_type property of a KafkaClusterAddon. This constant has a value of “PUBLICCONNECTIVITY”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a KafkaClusterAddon. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new KafkaClusterAddon object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 KafkaClusterAddon.
description (str) – The value to assign to the description property of this KafkaClusterAddon.
addon_type (str) – The value to assign to the addon_type property of this KafkaClusterAddon. Allowed values for this property are: “PUBLICCONNECTIVITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this KafkaClusterAddon.
time_updated (datetime) – The value to assign to the time_updated property of this KafkaClusterAddon.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this KafkaClusterAddon. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- property addon_type¶
[Required] Gets the addon_type of this KafkaClusterAddon. The type of addon
Allowed values for this property are: “PUBLICCONNECTIVITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The addon_type of this KafkaClusterAddon.
- Return type
str
- property description¶
Gets the description of this KafkaClusterAddon. Description of the add on
- Returns
The description of this KafkaClusterAddon.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this KafkaClusterAddon. The current state of the KafkaCluster.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this KafkaClusterAddon.
- Return type
str
- property name¶
[Required] Gets the name of this KafkaClusterAddon. A unique user-friendly name.
- Returns
The name of this KafkaClusterAddon.
- Return type
str
- property time_created¶
Gets the time_created of this KafkaClusterAddon. The time the addon was created.
- Returns
The time_created of this KafkaClusterAddon.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this KafkaClusterAddon. The time the addon was updated.
- Returns
The time_updated of this KafkaClusterAddon.
- Return type
datetime