DataLabelingManagementClientCompositeOperations¶
-
class
oci.data_labeling_service.
DataLabelingManagementClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
DataLabelingManagementClient
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 functionalityMethods
__init__
(client, **kwargs)Creates a new DataLabelingManagementClientCompositeOperations object add_dataset_labels_and_wait_for_state
(…[, …])Calls add_dataset_labels()
and waits for theWorkRequest
to enter the given state(s).change_dataset_compartment_and_wait_for_state
(…)Calls change_dataset_compartment()
and waits for theWorkRequest
to enter the given state(s).create_dataset_and_wait_for_state
(…[, …])Calls create_dataset()
and waits for theWorkRequest
to enter the given state(s).delete_dataset_and_wait_for_state
(dataset_id)Calls delete_dataset()
and waits for theWorkRequest
to enter the given state(s).generate_dataset_records_and_wait_for_state
(…)Calls generate_dataset_records()
and waits for theWorkRequest
to enter the given state(s).import_pre_annotated_data_and_wait_for_state
(…)Calls import_pre_annotated_data()
and waits for theWorkRequest
to enter the given state(s).remove_dataset_labels_and_wait_for_state
(…)Calls remove_dataset_labels()
and waits for theWorkRequest
to enter the given state(s).rename_dataset_labels_and_wait_for_state
(…)Calls rename_dataset_labels()
and waits for theWorkRequest
to enter the given state(s).snapshot_dataset_and_wait_for_state
(…[, …])Calls snapshot_dataset()
and waits for theWorkRequest
to enter the given state(s).update_dataset_and_wait_for_state
(…[, …])Calls update_dataset()
and waits for theDataset
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new DataLabelingManagementClientCompositeOperations object
Parameters: client (DataLabelingManagementClient) – The service client which will be wrapped by this object
-
add_dataset_labels_and_wait_for_state
(dataset_id, add_dataset_labels_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
add_dataset_labels()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- add_dataset_labels_details (oci.data_labeling_service.models.AddDatasetLabelsDetails) – (required) Details for adding Labels to the LabelSet of the Dataset.
- 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
add_dataset_labels()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
change_dataset_compartment_and_wait_for_state
(dataset_id, change_dataset_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_dataset_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- change_dataset_compartment_details (oci.data_labeling_service.models.ChangeDatasetCompartmentDetails) – (required) Details for changing the compartment of a Dataset
- 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_dataset_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_dataset_and_wait_for_state
(create_dataset_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_dataset()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_dataset_details (oci.data_labeling_service.models.CreateDatasetDetails) – (required) Details for the new Dataset.
- 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_dataset()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_dataset_and_wait_for_state
(dataset_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_dataset()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- 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_dataset()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
generate_dataset_records_and_wait_for_state
(dataset_id, generate_dataset_records_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
generate_dataset_records()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- generate_dataset_records_details (oci.data_labeling_service.models.GenerateDatasetRecordsDetails) – (required) Details for generating Dataset records.
- 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
generate_dataset_records()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
import_pre_annotated_data_and_wait_for_state
(dataset_id, import_pre_annotated_data_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
import_pre_annotated_data()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- import_pre_annotated_data_details (oci.data_labeling_service.models.ImportPreAnnotatedDataDetails) – (required) Details for importing Dataset
- 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
import_pre_annotated_data()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
remove_dataset_labels_and_wait_for_state
(dataset_id, remove_dataset_labels_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
remove_dataset_labels()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- remove_dataset_labels_details (oci.data_labeling_service.models.RemoveDatasetLabelsDetails) – (required) Details for removing Labels from the LabelSet of the Dataset.
- 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
remove_dataset_labels()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
rename_dataset_labels_and_wait_for_state
(dataset_id, rename_dataset_labels_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
rename_dataset_labels()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- rename_dataset_labels_details (oci.data_labeling_service.models.RenameDatasetLabelsDetails) – (required) Details for renaming Labels in the LabelSet of the Dataset.
- 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
rename_dataset_labels()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-
snapshot_dataset_and_wait_for_state
(dataset_id, snapshot_dataset_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
snapshot_dataset()
and waits for theWorkRequest
to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- snapshot_dataset_details (oci.data_labeling_service.models.SnapshotDatasetDetails) – (required) Details of creating a snapshot of the Dataset’s Records and Annotations
- 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
snapshot_dataset()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_dataset_and_wait_for_state
(dataset_id, update_dataset_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_dataset()
and waits for theDataset
acted upon to enter the given state(s).Parameters: - dataset_id (str) – (required) Unique Dataset OCID
- update_dataset_details (oci.data_labeling_service.models.UpdateDatasetDetails) – (required) Details for updating a Dataset.
- 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_dataset()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-