PublicConnectivityAddon

class oci.managed_kafka.models.PublicConnectivityAddon(**kwargs)

Bases: KafkaClusterAddon

The data that represents a Public Connectivity Addon

Attributes:

ADDON_TYPE_PUBLICCONNECTIVITY

A constant which can be used with the addon_type property of a KafkaClusterAddon.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a KafkaClusterAddon.

addon_type

[Required] Gets the addon_type of this KafkaClusterAddon.

authentication_mechanism

[Required] Gets the authentication_mechanism of this PublicConnectivityAddon.

bootstrap_url

[Required] Gets the bootstrap_url of this PublicConnectivityAddon.

description

Gets the description of this KafkaClusterAddon.

lifecycle_state

[Required] Gets the lifecycle_state of this KafkaClusterAddon.

name

[Required] Gets the name of this KafkaClusterAddon.

network_cidrs

[Required] Gets the network_cidrs of this PublicConnectivityAddon.

time_created

Gets the time_created of this KafkaClusterAddon.

time_updated

Gets the time_updated of this KafkaClusterAddon.

Methods:

__init__(**kwargs)

Initializes a new PublicConnectivityAddon 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 PublicConnectivityAddon object with values from keyword arguments. The default value of the addon_type attribute of this class is PUBLICCONNECTIVITY and it should not be changed. 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 PublicConnectivityAddon.

  • description (str) – The value to assign to the description property of this PublicConnectivityAddon.

  • addon_type (str) – The value to assign to the addon_type property of this PublicConnectivityAddon. Allowed values for this property are: “PUBLICCONNECTIVITY”

  • time_created (datetime) – The value to assign to the time_created property of this PublicConnectivityAddon.

  • time_updated (datetime) – The value to assign to the time_updated property of this PublicConnectivityAddon.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PublicConnectivityAddon. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • authentication_mechanism (str) – The value to assign to the authentication_mechanism property of this PublicConnectivityAddon.

  • bootstrap_url (str) – The value to assign to the bootstrap_url property of this PublicConnectivityAddon.

  • network_cidrs (list[str]) – The value to assign to the network_cidrs property of this PublicConnectivityAddon.

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 authentication_mechanism

[Required] Gets the authentication_mechanism of this PublicConnectivityAddon. Authentication mechanism.

Returns

The authentication_mechanism of this PublicConnectivityAddon.

Return type

str

property bootstrap_url

[Required] Gets the bootstrap_url of this PublicConnectivityAddon. The bootstrap url of the kafka cluster.

Returns

The bootstrap_url of this PublicConnectivityAddon.

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 network_cidrs

[Required] Gets the network_cidrs of this PublicConnectivityAddon. A list of CIDR ranges for ingress/egress traffic.

Returns

The network_cidrs of this PublicConnectivityAddon.

Return type

list[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