ZprClientCompositeOperations¶
- class oci.zpr.ZprClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
ZprClientand 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 ZprClientCompositeOperations object
Calls
create_configuration()and waits for theWorkRequestto enter the given state(s).create_zpr_policy_and_wait_for_state(...[, ...])Calls
create_zpr_policy()and waits for theWorkRequestto enter the given state(s).delete_zpr_policy_and_wait_for_state(...[, ...])Calls
delete_zpr_policy()and waits for theWorkRequestto enter the given state(s).update_zpr_policy_and_wait_for_state(...[, ...])Calls
update_zpr_policy()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new ZprClientCompositeOperations object
- Parameters
client (ZprClient) – The service client which will be wrapped by this object
- create_configuration_and_wait_for_state(create_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_configuration()and waits for theWorkRequestto enter the given state(s).- Parameters
create_configuration_details (oci.zpr.models.CreateConfigurationDetails) – (required) Details for ZPR configuration in the tenancy.
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_configuration()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_zpr_policy_and_wait_for_state(create_zpr_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_zpr_policy()and waits for theWorkRequestto enter the given state(s).- Parameters
create_zpr_policy_details (oci.zpr.models.CreateZprPolicyDetails) – (required) Details for the new ZprPolicy.
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_zpr_policy()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_zpr_policy_and_wait_for_state(zpr_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_zpr_policy()and waits for theWorkRequestto enter the given state(s).- Parameters
zpr_policy_id (str) –
(required) The OCID of the ZprPolicy.
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_zpr_policy()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_zpr_policy_and_wait_for_state(zpr_policy_id, update_zpr_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_zpr_policy()and waits for theWorkRequestto enter the given state(s).- Parameters
zpr_policy_id (str) –
(required) The OCID of the ZprPolicy.
update_zpr_policy_details (oci.zpr.models.UpdateZprPolicyDetails) – (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_zpr_policy()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