BaseinfraClientCompositeOperations¶
- class oci.datacc.BaseinfraClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
BaseinfraClientand 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 BaseinfraClientCompositeOperations object
Calls
activate_infrastructure()and waits for theWorkRequestto enter the given state(s).Calls
change_infrastructure_compartment()and waits for theWorkRequestto enter the given state(s).change_vm_cluster_network_compartment_and_wait_for_state(...)Calls
change_vm_cluster_network_compartment()and waits for theWorkRequestto enter the given state(s).Calls
change_vm_instance_compartment()and waits for theWorkRequestto enter the given state(s).Calls
create_infrastructure()and waits for theWorkRequestto enter the given state(s).Calls
create_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).create_vm_instance_and_wait_for_state(...[, ...])Calls
create_vm_instance()and waits for theWorkRequestto enter the given state(s).Calls
delete_infrastructure()and waits for theWorkRequestto enter the given state(s).Calls
delete_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).delete_vm_instance_and_wait_for_state(...[, ...])Calls
delete_vm_instance()and waits for theWorkRequestto enter the given state(s).generate_recommended_vm_cluster_network_and_wait_for_state(...)Calls
generate_recommended_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).Calls
migrate_vm_instance()and waits for theWorkRequestto enter the given state(s).Calls
reschedule_maintenance_run()and waits for theWorkRequestto enter the given state(s).Calls
restart_vm_instance()and waits for theWorkRequestto enter the given state(s).Calls
scale_infrastructure_storage()and waits for theWorkRequestto enter the given state(s).scale_vm_instance_and_wait_for_state(...[, ...])Calls
scale_vm_instance()and waits for theWorkRequestto enter the given state(s).start_vm_instance_and_wait_for_state(...[, ...])Calls
start_vm_instance()and waits for theWorkRequestto enter the given state(s).stop_vm_instance_and_wait_for_state(...[, ...])Calls
stop_vm_instance()and waits for theWorkRequestto enter the given state(s).Calls
update_infrastructure()and waits for theWorkRequestto enter the given state(s).Calls
update_maintenance_run()and waits for theWorkRequestto enter the given state(s).Calls
update_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).update_vm_instance_and_wait_for_state(...[, ...])Calls
update_vm_instance()and waits for theWorkRequestto enter the given state(s).Calls
validate_infrastructure()and waits for theWorkRequestto enter the given state(s).Calls
validate_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new BaseinfraClientCompositeOperations object
- Parameters
client (BaseinfraClient) – The service client which will be wrapped by this object
- activate_infrastructure_and_wait_for_state(activate_infrastructure_details, infrastructure_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
activate_infrastructure()and waits for theWorkRequestto enter the given state(s).- Parameters
activate_infrastructure_details (oci.datacc.models.ActivateInfrastructureDetails) – (required) The activation details for the Database Infrastructure.
infrastructure_id (str) –
(required) The OCID of the Database Infrastructure.
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
activate_infrastructure()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
- change_infrastructure_compartment_and_wait_for_state(infrastructure_id, change_infrastructure_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_infrastructure_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
infrastructure_id (str) –
(required) The OCID of the Database Infrastructure.
change_infrastructure_compartment_details (oci.datacc.models.ChangeInfrastructureCompartmentDetails) – (required) Updated Compartment details.
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_infrastructure_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
- change_vm_cluster_network_compartment_and_wait_for_state(vm_cluster_network_id, change_vm_cluster_network_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_vm_cluster_network_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_cluster_network_id (str) –
(required) The OCID of the VM cluster network.
change_vm_cluster_network_compartment_details (oci.datacc.models.ChangeVmClusterNetworkCompartmentDetails) – (required) Updated Compartment details.
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_vm_cluster_network_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
- change_vm_instance_compartment_and_wait_for_state(vm_instance_id, change_vm_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_vm_instance_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_instance_id (str) –
(required) The OCID of the VM instance.
change_vm_instance_compartment_details (oci.datacc.models.ChangeVmInstanceCompartmentDetails) – (required) Updated Compartment details.
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_vm_instance_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_infrastructure_and_wait_for_state(create_infrastructure_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_infrastructure()and waits for theWorkRequestto enter the given state(s).- Parameters
create_infrastructure_details (oci.datacc.models.CreateInfrastructureDetails) – (required) New Database Infrastructure details.
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_infrastructure()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_vm_cluster_network_and_wait_for_state(create_vm_cluster_network_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).- Parameters
create_vm_cluster_network_details (oci.datacc.models.CreateVmClusterNetworkDetails) – (required) New VM cluster network details.
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_vm_cluster_network()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_vm_instance_and_wait_for_state(create_vm_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
create_vm_instance_details (oci.datacc.models.CreateVmInstanceDetails) – (required) New VM instance details.
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_vm_instance()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_infrastructure_and_wait_for_state(infrastructure_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_infrastructure()and waits for theWorkRequestto enter the given state(s).- Parameters
infrastructure_id (str) –
(required) The OCID of the Database Infrastructure.
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_infrastructure()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_vm_cluster_network_and_wait_for_state(vm_cluster_network_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_cluster_network_id (str) –
(required) The OCID of the VM cluster network.
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_vm_cluster_network()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_vm_instance_and_wait_for_state(vm_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_instance_id (str) –
(required) The OCID of the VM 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_vm_instance()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
- generate_recommended_vm_cluster_network_and_wait_for_state(generate_recommended_vm_cluster_network_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
generate_recommended_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).- Parameters
generate_recommended_vm_cluster_network_details (oci.datacc.models.GenerateRecommendedVmClusterNetworkDetails) – (required) Request to generate a recommended VM cluster network details configuration.
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
generate_recommended_vm_cluster_network()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
- migrate_vm_instance_and_wait_for_state(vm_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
migrate_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_instance_id (str) –
(required) The OCID of the VM 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
migrate_vm_instance()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
- reschedule_maintenance_run_and_wait_for_state(maintenance_run_id, reschedule_maintenance_run_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
reschedule_maintenance_run()and waits for theWorkRequestto enter the given state(s).- Parameters
maintenance_run_id (str) – (required) The maintenance run OCID.
reschedule_maintenance_run_details (oci.datacc.models.RescheduleMaintenanceRunDetails) – (required) The new scheduled time for the maintenance run.
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
reschedule_maintenance_run()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
- restart_vm_instance_and_wait_for_state(vm_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
restart_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_instance_id (str) –
(required) The OCID of the VM 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
restart_vm_instance()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
- scale_infrastructure_storage_and_wait_for_state(scale_infrastructure_storage_details, infrastructure_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
scale_infrastructure_storage()and waits for theWorkRequestto enter the given state(s).- Parameters
scale_infrastructure_storage_details (oci.datacc.models.ScaleInfrastructureStorageDetails) – (required) The scale storage details for the Database Infrastructure.
infrastructure_id (str) –
(required) The OCID of the Database Infrastructure.
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
scale_infrastructure_storage()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
- scale_vm_instance_and_wait_for_state(scale_vm_instance_details, vm_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
scale_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
scale_vm_instance_details (oci.datacc.models.ScaleVmInstanceDetails) – (required) Scale the VM instance.
vm_instance_id (str) –
(required) The OCID of the VM 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
scale_vm_instance()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_vm_instance_and_wait_for_state(vm_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
start_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_instance_id (str) –
(required) The OCID of the VM 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
start_vm_instance()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
- stop_vm_instance_and_wait_for_state(vm_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
stop_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_instance_id (str) –
(required) The OCID of the VM 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
stop_vm_instance()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_infrastructure_and_wait_for_state(update_infrastructure_details, infrastructure_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_infrastructure()and waits for theWorkRequestto enter the given state(s).- Parameters
update_infrastructure_details (oci.datacc.models.UpdateInfrastructureDetails) – (required) The updated Database Infrastructure details.
infrastructure_id (str) –
(required) The OCID of the Database Infrastructure.
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_infrastructure()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_maintenance_run_and_wait_for_state(update_maintenance_run_details, maintenance_run_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_maintenance_run()and waits for theWorkRequestto enter the given state(s).- Parameters
update_maintenance_run_details (oci.datacc.models.UpdateMaintenanceRunDetails) – (required) The updated maintenance run details.
maintenance_run_id (str) – (required) The maintenance run OCID.
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_maintenance_run()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_vm_cluster_network_and_wait_for_state(update_vm_cluster_network_details, vm_cluster_network_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).- Parameters
update_vm_cluster_network_details (oci.datacc.models.UpdateVmClusterNetworkDetails) – (required) The updated VM cluster details.
vm_cluster_network_id (str) –
(required) The OCID of the VM cluster network.
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_vm_cluster_network()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_vm_instance_and_wait_for_state(update_vm_instance_details, vm_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_vm_instance()and waits for theWorkRequestto enter the given state(s).- Parameters
update_vm_instance_details (oci.datacc.models.UpdateVmInstanceDetails) – (required) The updated VM instance details.
vm_instance_id (str) –
(required) The OCID of the VM 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
update_vm_instance()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
- validate_infrastructure_and_wait_for_state(validate_infrastructure_details, infrastructure_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
validate_infrastructure()and waits for theWorkRequestto enter the given state(s).- Parameters
validate_infrastructure_details (oci.datacc.models.ValidateInfrastructureDetails) – (required) The validation details for the Database Infrastructure.
infrastructure_id (str) –
(required) The OCID of the Database Infrastructure.
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
validate_infrastructure()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
- validate_vm_cluster_network_and_wait_for_state(vm_cluster_network_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
validate_vm_cluster_network()and waits for theWorkRequestto enter the given state(s).- Parameters
vm_cluster_network_id (str) –
(required) The OCID of the VM cluster network.
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
validate_vm_cluster_network()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