DataFlowClientCompositeOperations

class oci.data_flow.DataFlowClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DataFlowClient 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 DataFlowClientCompositeOperations object
change_private_endpoint_compartment_and_wait_for_state(…) Calls change_private_endpoint_compartment() and waits for the WorkRequest to enter the given state(s).
create_application_and_wait_for_state(…[, …]) Calls create_application() and waits for the Application acted upon to enter the given state(s).
create_private_endpoint_and_wait_for_state(…) Calls create_private_endpoint() and waits for the WorkRequest to enter the given state(s).
create_run_and_wait_for_state(create_run_details) Calls create_run() and waits for the Run acted upon to enter the given state(s).
delete_application_and_wait_for_state(…[, …]) Calls delete_application() and waits for the Application acted upon to enter the given state(s).
delete_private_endpoint_and_wait_for_state(…) Calls delete_private_endpoint() and waits for the WorkRequest to enter the given state(s).
delete_run_and_wait_for_state(run_id[, …]) Calls delete_run() and waits for the Run acted upon to enter the given state(s).
update_application_and_wait_for_state(…[, …]) Calls update_application() and waits for the Application acted upon to enter the given state(s).
update_private_endpoint_and_wait_for_state(…) Calls update_private_endpoint() and waits for the WorkRequest to enter the given state(s).
update_run_and_wait_for_state(…[, …]) Calls update_run() and waits for the Run acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new DataFlowClientCompositeOperations object

Parameters:client (DataFlowClient) – The service client which will be wrapped by this object
change_private_endpoint_compartment_and_wait_for_state(private_endpoint_id, change_private_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • private_endpoint_id (str) – (required) The unique ID for a private endpoint.
  • change_private_endpoint_compartment_details (oci.data_flow.models.ChangePrivateEndpointCompartmentDetails) – (required) Details for changing a private endpoint’s compartment.
  • 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 change_private_endpoint_compartment()
  • 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_application_and_wait_for_state(create_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_application() and waits for the Application acted upon to enter the given state(s).

Parameters:
  • create_application_details (oci.data_flow.models.CreateApplicationDetails) – (required) Details to create an application.
  • 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_application()
  • 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_private_endpoint_and_wait_for_state(create_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_private_endpoint_details (oci.data_flow.models.CreatePrivateEndpointDetails) – (required) Details to create a private endpoint.
  • 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_private_endpoint()
  • 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_run_and_wait_for_state(create_run_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_run() and waits for the Run acted upon to enter the given state(s).

Parameters:
  • create_run_details (oci.data_flow.models.CreateRunDetails) – (required) Details for creating a run of an application.
  • 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_run()
  • 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_application_and_wait_for_state(application_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_application() and waits for the Application acted upon to enter the given state(s).

Parameters:
  • application_id (str) – (required) The unique ID for an application.
  • 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_application()
  • 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_private_endpoint_and_wait_for_state(private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • private_endpoint_id (str) – (required) The unique ID for a private endpoint.
  • 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_private_endpoint()
  • 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_run_and_wait_for_state(run_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_run() and waits for the Run acted upon to enter the given state(s).

Parameters:
  • run_id (str) – (required) The unique ID for the run
  • 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_run()
  • 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_application_and_wait_for_state(update_application_details, application_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_application() and waits for the Application acted upon to enter the given state(s).

Parameters:
  • update_application_details (oci.data_flow.models.UpdateApplicationDetails) – (required) Details for updating an application.
  • application_id (str) – (required) The unique ID for an application.
  • 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_application()
  • 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_private_endpoint_and_wait_for_state(update_private_endpoint_details, private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • update_private_endpoint_details (oci.data_flow.models.UpdatePrivateEndpointDetails) – (required) Details for updating a private endpoint.
  • private_endpoint_id (str) – (required) The unique ID for a private endpoint.
  • 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 update_private_endpoint()
  • 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_run_and_wait_for_state(update_run_details, run_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_run() and waits for the Run acted upon to enter the given state(s).

Parameters:
  • update_run_details (oci.data_flow.models.UpdateRunDetails) – (required) Details for updating a run.
  • run_id (str) – (required) The unique ID for the run
  • 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_run()
  • 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