DataScienceClientCompositeOperations

class oci.data_science.DataScienceClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DataScienceClient 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 DataScienceClientCompositeOperations object
activate_model_and_wait_for_state(model_id) Calls activate_model() and waits for the Model acted upon to enter the given state(s).
activate_notebook_session_and_wait_for_state(…) Calls activate_notebook_session() and waits for the WorkRequest to enter the given state(s).
create_model_and_wait_for_state(…[, …]) Calls create_model() and waits for the Model acted upon to enter the given state(s).
create_notebook_session_and_wait_for_state(…) Calls create_notebook_session() and waits for the WorkRequest to enter the given state(s).
create_project_and_wait_for_state(…[, …]) Calls create_project() and waits for the Project acted upon to enter the given state(s).
deactivate_model_and_wait_for_state(model_id) Calls deactivate_model() and waits for the Model acted upon to enter the given state(s).
deactivate_notebook_session_and_wait_for_state(…) Calls deactivate_notebook_session() and waits for the WorkRequest to enter the given state(s).
delete_model_and_wait_for_state(model_id[, …]) Calls delete_model() and waits for the Model acted upon to enter the given state(s).
delete_notebook_session_and_wait_for_state(…) Calls delete_notebook_session() and waits for the WorkRequest to enter the given state(s).
delete_project_and_wait_for_state(project_id) Calls delete_project() and waits for the WorkRequest to enter the given state(s).
update_model_and_wait_for_state(model_id, …) Calls update_model() and waits for the Model acted upon to enter the given state(s).
update_notebook_session_and_wait_for_state(…) Calls update_notebook_session() and waits for the NotebookSession acted upon to enter the given state(s).
update_project_and_wait_for_state(…[, …]) Calls update_project() and waits for the Project acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new DataScienceClientCompositeOperations object

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

Calls activate_model() and waits for the Model acted upon to enter the given state(s).

Parameters:
  • model_id (str) –

    (required) The OCID of the model.

  • 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 activate_model()
  • 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
activate_notebook_session_and_wait_for_state(notebook_session_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • notebook_session_id (str) –

    (required) The OCID of the notebook session.

  • 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 activate_notebook_session()
  • 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_model_and_wait_for_state(create_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_model() and waits for the Model acted upon to enter the given state(s).

Parameters:
  • create_model_details (CreateModelDetails) – (required) Details for creating a new model.
  • 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_model()
  • 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_notebook_session_and_wait_for_state(create_notebook_session_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_notebook_session_details (CreateNotebookSessionDetails) – (required) Details for creating a new notebook session.
  • 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_notebook_session()
  • 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_project_and_wait_for_state(create_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_project() and waits for the Project acted upon to enter the given state(s).

Parameters:
  • create_project_details (CreateProjectDetails) – (required) Details for creating a new project.
  • 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_project()
  • 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
deactivate_model_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls deactivate_model() and waits for the Model acted upon to enter the given state(s).

Parameters:
  • model_id (str) –

    (required) The OCID of the model.

  • 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 deactivate_model()
  • 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
deactivate_notebook_session_and_wait_for_state(notebook_session_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • notebook_session_id (str) –

    (required) The OCID of the notebook session.

  • 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 deactivate_notebook_session()
  • 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_model_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_model() and waits for the Model acted upon to enter the given state(s).

Parameters:
  • model_id (str) –

    (required) The OCID of the model.

  • 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_model()
  • 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_notebook_session_and_wait_for_state(notebook_session_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • notebook_session_id (str) –

    (required) The OCID of the notebook session.

  • 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_notebook_session()
  • 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_project_and_wait_for_state(project_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • project_id (str) –

    (required) The OCID of the project.

  • 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_project()
  • 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_model_and_wait_for_state(model_id, update_model_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_model() and waits for the Model acted upon to enter the given state(s).

Parameters:
  • model_id (str) –

    (required) The OCID of the model.

  • update_model_details (UpdateModelDetails) – (required) Details for updating a model. You can update the displayName, description, freeformTags, and definedTags properties.
  • 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_model()
  • 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_notebook_session_and_wait_for_state(notebook_session_id, update_notebook_session_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_notebook_session() and waits for the NotebookSession acted upon to enter the given state(s).

Parameters:
  • notebook_session_id (str) –

    (required) The OCID of the notebook session.

  • update_notebook_session_details (UpdateNotebookSessionDetails) – (required) Details for updating a notebook session. notebookSessionConfigurationDetails can only be updated while the notebook session is in the INACTIVE state. Changes to the notebookSessionConfigurationDetails will take effect the next time the ActivateNotebookSession action is invoked on the notebook session resource.
  • 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_notebook_session()
  • 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_project_and_wait_for_state(project_id, update_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_project() and waits for the Project acted upon to enter the given state(s).

Parameters:
  • project_id (str) –

    (required) The OCID of the project.

  • update_project_details (UpdateProjectDetails) – (required) Details for updating a project. You can update the displayName, description, freeformTags, and definedTags properties.
  • 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_project()
  • 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