KafkaClusterClientCompositeOperations¶
- class oci.managed_kafka.KafkaClusterClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
KafkaClusterClientand offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods:
__init__(client, **kwargs)Creates a new KafkaClusterClientCompositeOperations object
Calls
change_kafka_cluster_compartment()and waits for theWorkRequestto enter the given state(s).Calls
create_kafka_cluster()and waits for theWorkRequestto enter the given state(s).Calls
create_kafka_cluster_config()and waits for theKafkaClusterConfigacted upon to enter the given state(s).Calls
delete_kafka_cluster()and waits for theWorkRequestto enter the given state(s).Calls
delete_kafka_cluster_config()and waits for theKafkaClusterConfigacted upon to enter the given state(s).disable_superuser_and_wait_for_state(...[, ...])Calls
disable_superuser()and waits for theWorkRequestto enter the given state(s).enable_superuser_and_wait_for_state(...[, ...])Calls
enable_superuser()and waits for theWorkRequestto enter the given state(s).install_addon_and_wait_for_state(...[, ...])Calls
install_addon()and waits for theWorkRequestto enter the given state(s).update_addon_and_wait_for_state(...[, ...])Calls
update_addon()and waits for theWorkRequestto enter the given state(s).Calls
update_kafka_cluster()and waits for theWorkRequestto enter the given state(s).Calls
update_kafka_cluster_config()and waits for theKafkaClusterConfigacted upon to enter the given state(s).- __init__(client, **kwargs)¶
Creates a new KafkaClusterClientCompositeOperations object
- Parameters
client (KafkaClusterClient) – The service client which will be wrapped by this object
- change_kafka_cluster_compartment_and_wait_for_state(kafka_cluster_id, change_kafka_cluster_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_kafka_cluster_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
kafka_cluster_id (str) –
(required) The OCID of the KafkaCluster.
change_kafka_cluster_compartment_details (oci.managed_kafka.models.ChangeKafkaClusterCompartmentDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_kafka_cluster_compartment()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_kafka_cluster_and_wait_for_state(create_kafka_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_kafka_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
create_kafka_cluster_details (oci.managed_kafka.models.CreateKafkaClusterDetails) – (required) Details for the new KafkaCluster.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_kafka_cluster()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_kafka_cluster_config_and_wait_for_state(create_kafka_cluster_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_kafka_cluster_config()and waits for theKafkaClusterConfigacted upon to enter the given state(s).- Parameters
create_kafka_cluster_config_details (oci.managed_kafka.models.CreateKafkaClusterConfigDetails) – (required) Details for the new KafkaClusterConfig.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_kafka_cluster_config()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_kafka_cluster_and_wait_for_state(kafka_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_kafka_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
kafka_cluster_id (str) –
(required) The OCID of the KafkaCluster.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_kafka_cluster()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_kafka_cluster_config_and_wait_for_state(kafka_cluster_config_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_kafka_cluster_config()and waits for theKafkaClusterConfigacted upon to enter the given state(s).- Parameters
kafka_cluster_config_id (str) –
(required) The OCID of the KafkaClusterConfig.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_kafka_cluster_config()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- disable_superuser_and_wait_for_state(kafka_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
disable_superuser()and waits for theWorkRequestto enter the given state(s).- Parameters
kafka_cluster_id (str) –
(required) The OCID of the KafkaCluster.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
disable_superuser()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- enable_superuser_and_wait_for_state(kafka_cluster_id, enable_superuser_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
enable_superuser()and waits for theWorkRequestto enter the given state(s).- Parameters
kafka_cluster_id (str) –
(required) The OCID of the KafkaCluster.
enable_superuser_details (oci.managed_kafka.models.EnableSuperuserDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
enable_superuser()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- install_addon_and_wait_for_state(install_addon_details, kafka_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
install_addon()and waits for theWorkRequestto enter the given state(s).- Parameters
install_addon_details (oci.managed_kafka.models.InstallAddonDetails) – (required) Details for the new KafkaClusterAddon.
kafka_cluster_id (str) –
(required) The OCID of the KafkaCluster.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
install_addon()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_addon_and_wait_for_state(update_addon_details, kafka_cluster_id, addon_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_addon()and waits for theWorkRequestto enter the given state(s).- Parameters
update_addon_details (oci.managed_kafka.models.UpdateAddonDetails) – (required) The information to be updated.
kafka_cluster_id (str) –
(required) The OCID of the KafkaCluster.
addon_name (str) – (required) The unique name of the KafkaClusterAddon.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_addon()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_kafka_cluster_and_wait_for_state(kafka_cluster_id, update_kafka_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_kafka_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
kafka_cluster_id (str) –
(required) The OCID of the KafkaCluster.
update_kafka_cluster_details (oci.managed_kafka.models.UpdateKafkaClusterDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_kafka_cluster()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_kafka_cluster_config_and_wait_for_state(kafka_cluster_config_id, update_kafka_cluster_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_kafka_cluster_config()and waits for theKafkaClusterConfigacted upon to enter the given state(s).- Parameters
kafka_cluster_config_id (str) –
(required) The OCID of the KafkaClusterConfig.
update_kafka_cluster_config_details (oci.managed_kafka.models.UpdateKafkaClusterConfigDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_kafka_cluster_config()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait