ContainerEngineClientCompositeOperations¶
- class oci.container_engine.ContainerEngineClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
ContainerEngineClientand 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 ContainerEngineClientCompositeOperations object
Calls
cluster_migrate_to_native_vcn()and waits for theWorkRequestto enter the given state(s).Calls
complete_credential_rotation()and waits for theWorkRequestto enter the given state(s).create_cluster_and_wait_for_state(...[, ...])Calls
create_cluster()and waits for theWorkRequestto enter the given state(s).create_node_pool_and_wait_for_state(...[, ...])Calls
create_node_pool()and waits for theWorkRequestto enter the given state(s).Calls
create_virtual_node_pool()and waits for theWorkRequestto enter the given state(s).Calls
create_workload_mapping()and waits for theWorkloadMappingacted upon to enter the given state(s).delete_cluster_and_wait_for_state(cluster_id)Calls
delete_cluster()and waits for theWorkRequestto enter the given state(s).delete_node_and_wait_for_state(node_pool_id, ...)Calls
delete_node()and waits for theWorkRequestto enter the given state(s).delete_node_pool_and_wait_for_state(node_pool_id)Calls
delete_node_pool()and waits for theWorkRequestto enter the given state(s).Calls
delete_virtual_node_pool()and waits for theWorkRequestto enter the given state(s).disable_addon_and_wait_for_state(cluster_id, ...)Calls
disable_addon()and waits for theWorkRequestto enter the given state(s).install_addon_and_wait_for_state(cluster_id, ...)Calls
install_addon()and waits for theWorkRequestto enter the given state(s).Calls
reboot_cluster_node()and waits for theWorkRequestto enter the given state(s).Calls
replace_boot_volume_cluster_node()and waits for theWorkRequestto enter the given state(s).rollback_public_api_endpoint_decommission_and_wait_for_state(...)Calls
rollback_public_api_endpoint_decommission()and waits for theWorkRequestto enter the given state(s).Calls
start_credential_rotation()and waits for theWorkRequestto enter the given state(s).start_public_api_endpoint_decommission_and_wait_for_state(...)Calls
start_public_api_endpoint_decommission()and waits for theWorkRequestto enter the given state(s).update_addon_and_wait_for_state(cluster_id, ...)Calls
update_addon()and waits for theWorkRequestto enter the given state(s).update_cluster_and_wait_for_state(...[, ...])Calls
update_cluster()and waits for theWorkRequestto enter the given state(s).Calls
update_cluster_endpoint_config()and waits for theWorkRequestto enter the given state(s).update_node_pool_and_wait_for_state(...[, ...])Calls
update_node_pool()and waits for theWorkRequestto enter the given state(s).Calls
update_virtual_node_pool()and waits for theWorkRequestto enter the given state(s).Calls
update_workload_mapping()and waits for theWorkloadMappingacted upon to enter the given state(s).- __init__(client, **kwargs)¶
Creates a new ContainerEngineClientCompositeOperations object
- Parameters
client (ContainerEngineClient) – The service client which will be wrapped by this object
- cluster_migrate_to_native_vcn_and_wait_for_state(cluster_id, cluster_migrate_to_native_vcn_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
cluster_migrate_to_native_vcn()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
cluster_migrate_to_native_vcn_details (oci.container_engine.models.ClusterMigrateToNativeVcnDetails) – (required) The details for the cluster’s migration to native VCN.
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
cluster_migrate_to_native_vcn()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
- complete_credential_rotation_and_wait_for_state(cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
complete_credential_rotation()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
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
complete_credential_rotation()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_cluster_and_wait_for_state(create_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
create_cluster_details (oci.container_engine.models.CreateClusterDetails) – (required) The details of the cluster to create.
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_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_node_pool_and_wait_for_state(create_node_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_node_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
create_node_pool_details (oci.container_engine.models.CreateNodePoolDetails) – (required) The details of the node pool to create.
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_node_pool()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_virtual_node_pool_and_wait_for_state(create_virtual_node_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_virtual_node_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
create_virtual_node_pool_details (oci.container_engine.models.CreateVirtualNodePoolDetails) – (required) The details of the virtual node pool to create.
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_virtual_node_pool()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_workload_mapping_and_wait_for_state(cluster_id, create_workload_mapping_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_workload_mapping()and waits for theWorkloadMappingacted upon to enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
create_workload_mapping_details (oci.container_engine.models.CreateWorkloadMappingDetails) – (required) The details of the workloadMapping to be create.
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_workload_mapping()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_cluster_and_wait_for_state(cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
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_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_node_and_wait_for_state(node_pool_id, node_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_node()and waits for theWorkRequestto enter the given state(s).- Parameters
node_pool_id (str) – (required) The OCID of the node pool.
node_id (str) – (required) The OCID of the compute instance.
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_node()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_node_pool_and_wait_for_state(node_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_node_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
node_pool_id (str) – (required) The OCID of the node pool.
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_node_pool()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_virtual_node_pool_and_wait_for_state(virtual_node_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_virtual_node_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
virtual_node_pool_id (str) – (required) The OCID of the virtual node pool.
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_virtual_node_pool()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_addon_and_wait_for_state(cluster_id, addon_name, is_remove_existing_add_on, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
disable_addon()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
addon_name (str) – (required) The name of the addon.
is_remove_existing_add_on (bool) – (required) Whether existing addon resources should be deleted or not. True would remove the underlying resources completely.
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_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
- install_addon_and_wait_for_state(cluster_id, install_addon_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
install_addon()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
install_addon_details (oci.container_engine.models.InstallAddonDetails) – (required) The details of the addon to be installed.
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
- reboot_cluster_node_and_wait_for_state(cluster_id, node_id, reboot_cluster_node_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
reboot_cluster_node()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
node_id (str) – (required) The OCID of the compute instance.
reboot_cluster_node_details (oci.container_engine.models.RebootClusterNodeDetails) – (required) The fields to reboot a node.
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
reboot_cluster_node()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
- replace_boot_volume_cluster_node_and_wait_for_state(cluster_id, node_id, replace_boot_volume_cluster_node_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
replace_boot_volume_cluster_node()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
node_id (str) – (required) The OCID of the compute instance.
replace_boot_volume_cluster_node_details (oci.container_engine.models.ReplaceBootVolumeClusterNodeDetails) – (required) The fields to replace boot volume of a node.
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
replace_boot_volume_cluster_node()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
- rollback_public_api_endpoint_decommission_and_wait_for_state(cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
rollback_public_api_endpoint_decommission()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
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
rollback_public_api_endpoint_decommission()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
- start_credential_rotation_and_wait_for_state(cluster_id, start_credential_rotation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
start_credential_rotation()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
start_credential_rotation_details (oci.container_engine.models.StartCredentialRotationDetails) – (required) The details for a kubernetes cluster to start credential rotation.
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
start_credential_rotation()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
- start_public_api_endpoint_decommission_and_wait_for_state(cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
start_public_api_endpoint_decommission()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
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
start_public_api_endpoint_decommission()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(cluster_id, addon_name, update_addon_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_addon()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
addon_name (str) – (required) The name of the addon.
update_addon_details (oci.container_engine.models.UpdateAddonDetails) – (required) The details of the addon 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_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_cluster_and_wait_for_state(cluster_id, update_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_cluster()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
update_cluster_details (oci.container_engine.models.UpdateClusterDetails) – (required) The details of the cluster to update.
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_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_cluster_endpoint_config_and_wait_for_state(cluster_id, update_cluster_endpoint_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_cluster_endpoint_config()and waits for theWorkRequestto enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
update_cluster_endpoint_config_details (oci.container_engine.models.UpdateClusterEndpointConfigDetails) – (required) The details of the cluster’s endpoint to update.
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_cluster_endpoint_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
- update_node_pool_and_wait_for_state(node_pool_id, update_node_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_node_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
node_pool_id (str) – (required) The OCID of the node pool.
update_node_pool_details (oci.container_engine.models.UpdateNodePoolDetails) – (required) The fields to update in a node pool.
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_node_pool()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_virtual_node_pool_and_wait_for_state(virtual_node_pool_id, update_virtual_node_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_virtual_node_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
virtual_node_pool_id (str) – (required) The OCID of the virtual node pool.
update_virtual_node_pool_details (oci.container_engine.models.UpdateVirtualNodePoolDetails) – (required) The fields to update in a virtual node pool.
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_virtual_node_pool()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_workload_mapping_and_wait_for_state(cluster_id, workload_mapping_id, update_workload_mapping_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_workload_mapping()and waits for theWorkloadMappingacted upon to enter the given state(s).- Parameters
cluster_id (str) – (required) The OCID of the cluster.
workload_mapping_id (str) – (required) The OCID of the workloadMapping.
update_workload_mapping_details (oci.container_engine.models.UpdateWorkloadMappingDetails) – (required) The details of the workloadMapping 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_workload_mapping()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