DataLabelingClientCompositeOperations

class oci.data_labeling_service_dataplane.DataLabelingClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DataLabelingClient 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 DataLabelingClientCompositeOperations object
create_annotation_and_wait_for_state(…[, …]) Calls create_annotation() and waits for the Annotation acted upon to enter the given state(s).
create_record_and_wait_for_state(…[, …]) Calls create_record() and waits for the Record acted upon to enter the given state(s).
delete_annotation_and_wait_for_state(…[, …]) Calls delete_annotation() and waits for the Annotation acted upon to enter the given state(s).
delete_record_and_wait_for_state(record_id) Calls delete_record() and waits for the Record acted upon to enter the given state(s).
update_annotation_and_wait_for_state(…[, …]) Calls update_annotation() and waits for the Annotation acted upon to enter the given state(s).
update_record_and_wait_for_state(record_id, …) Calls update_record() and waits for the Record acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new DataLabelingClientCompositeOperations object

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

Calls create_annotation() and waits for the Annotation acted upon to enter the given state(s).

Parameters:
  • create_annotation_details (oci.data_labeling_service_dataplane.models.CreateAnnotationDetails) – (required) Details for the new CreateAnnotation.
  • 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_annotation()
  • 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_record_and_wait_for_state(create_record_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_record() and waits for the Record acted upon to enter the given state(s).

Parameters:
  • create_record_details (oci.data_labeling_service_dataplane.models.CreateRecordDetails) – (required) Details for the new Record.
  • 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_record()
  • 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_annotation_and_wait_for_state(annotation_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_annotation() and waits for the Annotation acted upon to enter the given state(s).

Parameters:
  • annotation_id (str) – (required) unique Annotation identifier
  • 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_annotation()
  • 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_record_and_wait_for_state(record_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_record() and waits for the Record acted upon to enter the given state(s).

Parameters:
  • record_id (str) – (required) The OCID of the record annotated
  • 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_record()
  • 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_annotation_and_wait_for_state(annotation_id, update_annotation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_annotation() and waits for the Annotation acted upon to enter the given state(s).

Parameters:
  • annotation_id (str) – (required) unique Annotation identifier
  • update_annotation_details (oci.data_labeling_service_dataplane.models.UpdateAnnotationDetails) – (required) 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_annotation()
  • 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_record_and_wait_for_state(record_id, update_record_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_record() and waits for the Record acted upon to enter the given state(s).

Parameters:
  • record_id (str) – (required) The OCID of the record annotated
  • update_record_details (oci.data_labeling_service_dataplane.models.UpdateRecordDetails) – (required) 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_record()
  • 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