NotificationDataPlaneClientCompositeOperations

class oci.ons.NotificationDataPlaneClientCompositeOperations(client, **kwargs)

This class provides a wrapper around NotificationDataPlaneClient 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 NotificationDataPlaneClientCompositeOperations object
create_subscription_and_wait_for_state(…) Calls create_subscription() and waits for the Subscription acted upon to enter the given state(s).
delete_subscription_and_wait_for_state(…) Calls delete_subscription() and waits for the Subscription acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new NotificationDataPlaneClientCompositeOperations object

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

Calls create_subscription() and waits for the Subscription acted upon to enter the given state(s).

Parameters:
  • create_subscription_details (oci.ons.models.CreateSubscriptionDetails) – (required) The subscription to create.
  • 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_subscription()
  • 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_subscription_and_wait_for_state(subscription_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_subscription() and waits for the Subscription acted upon to enter the given state(s).

Parameters:
  • subscription_id (str) –

    (required) The OCID of the subscription to delete.

  • 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_subscription()
  • 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