CapacityManagementClientCompositeOperations

class oci.capacity_management.CapacityManagementClientCompositeOperations(client, **kwargs)

This class provides a wrapper around CapacityManagementClient 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 CapacityManagementClientCompositeOperations object
create_occ_availability_catalog_and_wait_for_state(…) Calls create_occ_availability_catalog() and waits for the OccAvailabilityCatalog acted upon to enter the given state(s).
create_occ_capacity_request_and_wait_for_state(…) Calls create_occ_capacity_request() and waits for the OccCapacityRequest acted upon to enter the given state(s).
create_occ_customer_group_and_wait_for_state(…) Calls create_occ_customer_group() and waits for the OccCustomerGroup acted upon to enter the given state(s).
delete_occ_availability_catalog_and_wait_for_state(…) Calls delete_occ_availability_catalog() and waits for the OccAvailabilityCatalog acted upon to enter the given state(s).
delete_occ_capacity_request_and_wait_for_state(…) Calls delete_occ_capacity_request() and waits for the OccCapacityRequest acted upon to enter the given state(s).
delete_occ_customer_group_and_wait_for_state(…) Calls delete_occ_customer_group() and waits for the OccCustomerGroup acted upon to enter the given state(s).
update_occ_availability_catalog_and_wait_for_state(…) Calls update_occ_availability_catalog() and waits for the OccAvailabilityCatalog acted upon to enter the given state(s).
update_occ_capacity_request_and_wait_for_state(…) Calls update_occ_capacity_request() and waits for the OccCapacityRequest acted upon to enter the given state(s).
update_occ_customer_group_and_wait_for_state(…) Calls update_occ_customer_group() and waits for the OccCustomerGroup acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new CapacityManagementClientCompositeOperations object

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

Calls create_occ_availability_catalog() and waits for the OccAvailabilityCatalog acted upon to enter the given state(s).

Parameters:
  • create_occ_availability_catalog_details (oci.capacity_management.models.CreateOccAvailabilityCatalogDetails) – (required) The request details for creating an availability catalog.
  • 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_occ_availability_catalog()
  • 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_occ_capacity_request_and_wait_for_state(create_occ_capacity_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_occ_capacity_request() and waits for the OccCapacityRequest acted upon to enter the given state(s).

Parameters:
  • create_occ_capacity_request_details (oci.capacity_management.models.CreateOccCapacityRequestDetails) – (required) The request details for creating a capacity 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 create_occ_capacity_request()
  • 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_occ_customer_group_and_wait_for_state(create_occ_customer_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_occ_customer_group() and waits for the OccCustomerGroup acted upon to enter the given state(s).

Parameters:
  • create_occ_customer_group_details (oci.capacity_management.models.CreateOccCustomerGroupDetails) – (required) The request details for creating a customer group.
  • 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_occ_customer_group()
  • 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_occ_availability_catalog_and_wait_for_state(occ_availability_catalog_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_occ_availability_catalog() and waits for the OccAvailabilityCatalog acted upon to enter the given state(s).

Parameters:
  • occ_availability_catalog_id (str) – (required) The OCID of the availability catalog.
  • 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_occ_availability_catalog()
  • 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_occ_capacity_request_and_wait_for_state(occ_capacity_request_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_occ_capacity_request() and waits for the OccCapacityRequest acted upon to enter the given state(s).

Parameters:
  • occ_capacity_request_id (str) – (required) The OCID of the capacity 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_occ_capacity_request()
  • 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_occ_customer_group_and_wait_for_state(occ_customer_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_occ_customer_group() and waits for the OccCustomerGroup acted upon to enter the given state(s).

Parameters:
  • occ_customer_group_id (str) – (required) The OCID of the customer group.
  • 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_occ_customer_group()
  • 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_occ_availability_catalog_and_wait_for_state(update_occ_availability_catalog_details, occ_availability_catalog_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_occ_availability_catalog() and waits for the OccAvailabilityCatalog acted upon to enter the given state(s).

Parameters:
  • update_occ_availability_catalog_details (oci.capacity_management.models.UpdateOccAvailabilityCatalogDetails) – (required) Request to update the properties of the availability catalog.
  • occ_availability_catalog_id (str) – (required) The OCID of the availability catalog.
  • 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_occ_availability_catalog()
  • 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_occ_capacity_request_and_wait_for_state(update_occ_capacity_request_details, occ_capacity_request_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_occ_capacity_request() and waits for the OccCapacityRequest acted upon to enter the given state(s).

Parameters:
  • update_occ_capacity_request_details (oci.capacity_management.models.UpdateOccCapacityRequestDetails) – (required) Request to update the properties of the capacity request.
  • occ_capacity_request_id (str) – (required) The OCID of the capacity 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 update_occ_capacity_request()
  • 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_occ_customer_group_and_wait_for_state(update_occ_customer_group_details, occ_customer_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_occ_customer_group() and waits for the OccCustomerGroup acted upon to enter the given state(s).

Parameters:
  • update_occ_customer_group_details (oci.capacity_management.models.UpdateOccCustomerGroupDetails) – (required) Request to update the properties of the customer group.
  • occ_customer_group_id (str) – (required) The OCID of the customer group.
  • 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_occ_customer_group()
  • 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