CloudGuardClientCompositeOperations

class oci.cloud_guard.CloudGuardClientCompositeOperations(client, **kwargs)

This class provides a wrapper around CloudGuardClient and 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 functionality

Methods

__init__(client, **kwargs) Creates a new CloudGuardClientCompositeOperations object
create_detector_recipe_and_wait_for_state(…) Calls create_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).
create_managed_list_and_wait_for_state(…) Calls create_managed_list() and waits for the ManagedList acted upon to enter the given state(s).
create_responder_recipe_and_wait_for_state(…) Calls create_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).
create_target_and_wait_for_state(…[, …]) Calls create_target() and waits for the Target acted upon to enter the given state(s).
create_target_detector_recipe_and_wait_for_state(…) Calls create_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).
delete_detector_recipe_and_wait_for_state(…) Calls delete_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).
delete_managed_list_and_wait_for_state(…) Calls delete_managed_list() and waits for the ManagedList acted upon to enter the given state(s).
delete_responder_recipe_and_wait_for_state(…) Calls delete_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).
delete_target_and_wait_for_state(target_id) Calls delete_target() and waits for the Target acted upon to enter the given state(s).
update_detector_recipe_and_wait_for_state(…) Calls update_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).
update_detector_recipe_detector_rule_and_wait_for_state(…) Calls update_detector_recipe_detector_rule() and waits for the DetectorRecipeDetectorRule acted upon to enter the given state(s).
update_managed_list_and_wait_for_state(…) Calls update_managed_list() and waits for the ManagedList acted upon to enter the given state(s).
update_problem_status_and_wait_for_state(…) Calls update_problem_status() and waits for the Problem acted upon to enter the given state(s).
update_responder_recipe_and_wait_for_state(…) Calls update_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).
update_responder_recipe_responder_rule_and_wait_for_state(…) Calls update_responder_recipe_responder_rule() and waits for the ResponderRecipeResponderRule acted upon to enter the given state(s).
update_target_and_wait_for_state(target_id, …) Calls update_target() and waits for the Target acted upon to enter the given state(s).
update_target_detector_recipe_and_wait_for_state(…) Calls update_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).
update_target_detector_recipe_detector_rule_and_wait_for_state(…) Calls update_target_detector_recipe_detector_rule() and waits for the TargetDetectorRecipeDetectorRule acted upon to enter the given state(s).
update_target_responder_recipe_responder_rule_and_wait_for_state(…) Calls update_target_responder_recipe_responder_rule() and waits for the TargetResponderRecipeResponderRule acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new CloudGuardClientCompositeOperations object

Parameters:client (CloudGuardClient) – The service client which will be wrapped by this object
create_detector_recipe_and_wait_for_state(create_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).

Parameters:
  • create_detector_recipe_details (oci.cloud_guard.models.CreateDetectorRecipeDetails) – (required) Details for the new DetectorRecipe.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_managed_list_and_wait_for_state(create_managed_list_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_managed_list() and waits for the ManagedList acted upon to enter the given state(s).

Parameters:
  • create_managed_list_details (oci.cloud_guard.models.CreateManagedListDetails) – (required) Details for the new ManagedList.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_managed_list()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_responder_recipe_and_wait_for_state(create_responder_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).

Parameters:
  • create_responder_recipe_details (oci.cloud_guard.models.CreateResponderRecipeDetails) – (required) Details for ResponderRecipe.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_responder_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_target_and_wait_for_state(create_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_target() and waits for the Target acted upon to enter the given state(s).

Parameters:
  • create_target_details (oci.cloud_guard.models.CreateTargetDetails) – (required) Details for the new Target.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_target()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
create_target_detector_recipe_and_wait_for_state(target_id, attach_target_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of target
  • attach_target_detector_recipe_details (oci.cloud_guard.models.AttachTargetDetectorRecipeDetails) – (required) Details for associating DetectorRecipe to Target
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_target_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_detector_recipe_and_wait_for_state(detector_recipe_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_managed_list_and_wait_for_state(managed_list_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_managed_list() and waits for the ManagedList acted upon to enter the given state(s).

Parameters:
  • managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_managed_list()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_responder_recipe_and_wait_for_state(responder_recipe_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_responder_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
delete_target_and_wait_for_state(target_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_target() and waits for the Target acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of target
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_target()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_detector_recipe_and_wait_for_state(detector_recipe_id, update_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_detector_recipe() and waits for the DetectorRecipe acted upon to enter the given state(s).

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • update_detector_recipe_details (oci.cloud_guard.models.UpdateDetectorRecipeDetails) – (required) Details for the DetectorRecipe to be updated
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_detector_recipe_detector_rule_and_wait_for_state(detector_recipe_id, detector_rule_id, update_detector_recipe_detector_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_detector_recipe_detector_rule() and waits for the DetectorRecipeDetectorRule acted upon to enter the given state(s).

Parameters:
  • detector_recipe_id (str) – (required) DetectorRecipe OCID
  • detector_rule_id (str) – (required) The key of Detector Rule.
  • update_detector_recipe_detector_rule_details (oci.cloud_guard.models.UpdateDetectorRecipeDetectorRuleDetails) – (required) The details to be updated for DetectorRule.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_detector_recipe_detector_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_managed_list_and_wait_for_state(managed_list_id, update_managed_list_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_managed_list() and waits for the ManagedList acted upon to enter the given state(s).

Parameters:
  • managed_list_id (str) – (required) The cloudguard list OCID to be passed in the request.
  • update_managed_list_details (oci.cloud_guard.models.UpdateManagedListDetails) – (required) Details for the ManagedList to be updated
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_managed_list()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_problem_status_and_wait_for_state(problem_id, update_problem_status_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_problem_status() and waits for the Problem acted upon to enter the given state(s).

Parameters:
  • problem_id (str) – (required) OCId of the problem.
  • update_problem_status_details (oci.cloud_guard.models.UpdateProblemStatusDetails) – (required) The additional details for the problem.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_problem_status()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_responder_recipe_and_wait_for_state(responder_recipe_id, update_responder_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_responder_recipe() and waits for the ResponderRecipe acted upon to enter the given state(s).

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • update_responder_recipe_details (oci.cloud_guard.models.UpdateResponderRecipeDetails) – (required) The details to be updated.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_responder_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_responder_recipe_responder_rule_and_wait_for_state(responder_recipe_id, responder_rule_id, update_responder_recipe_responder_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_responder_recipe_responder_rule() and waits for the ResponderRecipeResponderRule acted upon to enter the given state(s).

Parameters:
  • responder_recipe_id (str) – (required) OCID of ResponderRecipe
  • responder_rule_id (str) – (required) The id of ResponderRule
  • update_responder_recipe_responder_rule_details (oci.cloud_guard.models.UpdateResponderRecipeResponderRuleDetails) – (required) The details to be updated for ResponderRule.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_responder_recipe_responder_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_and_wait_for_state(target_id, update_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target() and waits for the Target acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of target
  • update_target_details (oci.cloud_guard.models.UpdateTargetDetails) – (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_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_detector_recipe_and_wait_for_state(target_id, target_detector_recipe_id, update_target_detector_recipe_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target_detector_recipe() and waits for the TargetDetectorRecipe acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • update_target_detector_recipe_details (oci.cloud_guard.models.UpdateTargetDetectorRecipeDetails) – (required) The details to be updated.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target_detector_recipe()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_detector_recipe_detector_rule_and_wait_for_state(target_id, target_detector_recipe_id, detector_rule_id, update_target_detector_recipe_detector_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target_detector_recipe_detector_rule() and waits for the TargetDetectorRecipeDetectorRule acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of target
  • target_detector_recipe_id (str) – (required) OCID of TargetDetectorRecipe
  • detector_rule_id (str) – (required) The id of DetectorRule
  • update_target_detector_recipe_detector_rule_details (oci.cloud_guard.models.UpdateTargetDetectorRecipeDetectorRuleDetails) – (required) The details to be updated for DetectorRule.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target_detector_recipe_detector_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
update_target_responder_recipe_responder_rule_and_wait_for_state(target_id, target_responder_recipe_id, responder_rule_id, update_target_responder_recipe_responder_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_target_responder_recipe_responder_rule() and waits for the TargetResponderRecipeResponderRule acted upon to enter the given state(s).

Parameters:
  • target_id (str) – (required) OCID of target
  • target_responder_recipe_id (str) – (required) OCID of TargetResponderRecipe
  • responder_rule_id (str) – (required) The id of ResponderRule
  • update_target_responder_recipe_responder_rule_details (oci.cloud_guard.models.UpdateTargetResponderRecipeResponderRuleDetails) – (required) The details to be updated for ResponderRule.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_target_responder_recipe_responder_rule()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait