FunctionsManagementClientCompositeOperations¶
- class oci.functions.FunctionsManagementClientCompositeOperations(client, work_request_clients=None, **kwargs)¶
This class provides a wrapper around
FunctionsManagementClientand 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 FunctionsManagementClientCompositeOperations object
Calls
change_application_compartment()and waits for theWorkRequestto enter the given state(s).create_application_and_wait_for_state(...[, ...])Calls
create_application()and waits for theWorkRequestto enter the given state(s).create_function_and_wait_for_state(...[, ...])Calls
create_function()and waits for theWorkRequestto enter the given state(s).delete_application_and_wait_for_state(...[, ...])Calls
delete_application()and waits for theWorkRequestto enter the given state(s).delete_function_and_wait_for_state(function_id)Calls
delete_function()and waits for theWorkRequestto enter the given state(s).update_application_and_wait_for_state(...[, ...])Calls
update_application()and waits for theWorkRequestto enter the given state(s).update_function_and_wait_for_state(...[, ...])Calls
update_function()and waits for theWorkRequestto enter the given state(s).- __init__(client, work_request_clients=None, **kwargs)¶
Creates a new FunctionsManagementClientCompositeOperations object
- Parameters
client (FunctionsManagementClient) – 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_application_compartment_and_wait_for_state(application_id, change_application_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_application_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
application_id (str) –
(required) The OCID of this application.
change_application_compartment_details (oci.functions.models.ChangeApplicationCompartmentDetails) – (required) Properties to change the compartment of an application.
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
change_application_compartment()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_application_and_wait_for_state(create_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_application()and waits for theWorkRequestto enter the given state(s).- Parameters
create_application_details (oci.functions.models.CreateApplicationDetails) – (required) Specification of the application to create
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_application()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_function_and_wait_for_state(create_function_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_function()and waits for theWorkRequestto enter the given state(s).- Parameters
create_function_details (oci.functions.models.CreateFunctionDetails) – (required) Specification of the function to create
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_function()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_application_and_wait_for_state(application_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_application()and waits for theWorkRequestto enter the given state(s).- Parameters
application_id (str) –
(required) The OCID of this application.
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_application()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_function_and_wait_for_state(function_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_function()and waits for theWorkRequestto enter the given state(s).- Parameters
function_id (str) –
(required) The OCID of this function.
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_function()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_application_and_wait_for_state(application_id, update_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_application()and waits for theWorkRequestto enter the given state(s).- Parameters
application_id (str) –
(required) The OCID of this application.
update_application_details (oci.functions.models.UpdateApplicationDetails) – (required) The new application spec to apply
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
update_application()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_function_and_wait_for_state(function_id, update_function_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_function()and waits for theWorkRequestto enter the given state(s).- Parameters
function_id (str) –
(required) The OCID of this function.
update_function_details (oci.functions.models.UpdateFunctionDetails) – (required) The new function spec to apply
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
update_function()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