InventoryClientCompositeOperations¶
- class oci.cloud_bridge.InventoryClientCompositeOperations(client, work_request_clients=None, **kwargs)¶
This class provides a wrapper around
InventoryClientand 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[, work_request_clients])Creates a new InventoryClientCompositeOperations object
change_asset_tags_and_wait_for_state(...[, ...])Calls
change_asset_tags()and waits for theAssetacted upon to enter the given state(s).create_asset_and_wait_for_state(...[, ...])Calls
create_asset()and waits for theAssetacted upon to enter the given state(s).create_inventory_and_wait_for_state(...[, ...])Calls
create_inventory()and waits for theWorkRequestto enter the given state(s).delete_asset_and_wait_for_state(asset_id[, ...])Calls
delete_asset()and waits for theAssetacted upon to enter the given state(s).delete_inventory_and_wait_for_state(inventory_id)Calls
delete_inventory()and waits for theWorkRequestto enter the given state(s).get_inventory_and_wait_for_state(inventory_id)Calls
get_inventory()and waits for theWorkRequestto enter the given state(s).import_inventory_and_wait_for_state(...[, ...])Calls
import_inventory()and waits for theWorkRequestto enter the given state(s).update_asset_and_wait_for_state(asset_id, ...)Calls
update_asset()and waits for theAssetacted upon to enter the given state(s).update_inventory_and_wait_for_state(...[, ...])Calls
update_inventory()and waits for theInventoryacted upon to enter the given state(s).- __init__(client, work_request_clients=None, **kwargs)¶
Creates a new InventoryClientCompositeOperations object
- Parameters
client (InventoryClient) – The service client which will be wrapped by this object
work_request_clients (dict) –
(optional) Service-local clients keyed by generated client class name, for example
{'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.
Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.
- change_asset_tags_and_wait_for_state(asset_id, change_asset_tags_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_asset_tags()and waits for theAssetacted upon to enter the given state(s).- Parameters
asset_id (str) – (required) Unique asset identifier.
change_asset_tags_details (oci.cloud_bridge.models.ChangeAssetTagsDetails) – (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_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_asset_tags()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_asset_and_wait_for_state(create_asset_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_asset()and waits for theAssetacted upon to enter the given state(s).- Parameters
create_asset_details (oci.cloud_bridge.models.CreateAssetDetails) – (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_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_asset()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_inventory_and_wait_for_state(create_inventory_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_inventory()and waits for theWorkRequestto enter the given state(s).- Parameters
create_inventory_details (oci.cloud_bridge.models.CreateInventoryDetails) – (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
create_inventory()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_asset_and_wait_for_state(asset_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_asset()and waits for theAssetacted upon to enter the given state(s).- Parameters
asset_id (str) – (required) Unique asset identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_asset()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_inventory_and_wait_for_state(inventory_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_inventory()and waits for theWorkRequestto enter the given state(s).- Parameters
inventory_id (str) – (required) Inventory 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
delete_inventory()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
- get_inventory_and_wait_for_state(inventory_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
get_inventory()and waits for theWorkRequestto enter the given state(s).- Parameters
inventory_id (str) – (required) Inventory 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
get_inventory()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
- import_inventory_and_wait_for_state(import_inventory_details, inventory_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
import_inventory()and waits for theWorkRequestto enter the given state(s).- Parameters
import_inventory_details (oci.cloud_bridge.models.ImportInventoryDetails) – (required) The file input to create resources.
inventory_id (str) – (required) Inventory 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
import_inventory()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_asset_and_wait_for_state(asset_id, update_asset_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_asset()and waits for theAssetacted upon to enter the given state(s).- Parameters
asset_id (str) – (required) Unique asset identifier.
update_asset_details (oci.cloud_bridge.models.UpdateAssetDetails) – (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_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_asset()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_inventory_and_wait_for_state(inventory_id, update_inventory_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_inventory()and waits for theInventoryacted upon to enter the given state(s).- Parameters
inventory_id (str) – (required) Inventory OCID.
update_inventory_details (oci.cloud_bridge.models.UpdateInventoryDetails) – (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_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_inventory()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