ApiPlatformClientCompositeOperations

class oci.api_platform.ApiPlatformClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ApiPlatformClient 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 ApiPlatformClientCompositeOperations object
create_api_platform_instance_and_wait_for_state(…)	Calls create_api_platform_instance() and waits for the WorkRequest to enter the given state(s).
delete_api_platform_instance_and_wait_for_state(…)	Calls delete_api_platform_instance() and waits for the WorkRequest to enter the given state(s).
update_api_platform_instance_and_wait_for_state(…)	Calls update_api_platform_instance() and waits for the ApiPlatformInstance acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new ApiPlatformClientCompositeOperations object

Parameters:client (ApiPlatformClient) – The service client which will be wrapped by this object

create_api_platform_instance_and_wait_for_state(create_api_platform_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_api_platform_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_api_platform_instance_details (oci.api_platform.models.CreateApiPlatformInstanceDetails) – (required) Details for the new API Platform Instance
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_api_platform_instance()
• 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_api_platform_instance_and_wait_for_state(api_platform_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_api_platform_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:

• api_platform_instance_id (str) –

  (required) The OCID of the instance

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_api_platform_instance()
• 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_api_platform_instance_and_wait_for_state(api_platform_instance_id, update_api_platform_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_api_platform_instance() and waits for the ApiPlatformInstance acted upon to enter the given state(s).

Parameters:

• api_platform_instance_id (str) –

  (required) The OCID of the instance

• update_api_platform_instance_details (oci.api_platform.models.UpdateApiPlatformInstanceDetails) – (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_api_platform_instance()
• 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