AIServiceVisionClientCompositeOperations¶

class oci.ai_vision.AIServiceVisionClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around AIServiceVisionClient 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 AIServiceVisionClientCompositeOperations object
`change_stream_group_compartment_and_wait_for_state`(...)	Calls `change_stream_group_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`change_stream_job_compartment_and_wait_for_state`(...)	Calls `change_stream_job_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`change_stream_source_compartment_and_wait_for_state`(...)	Calls `change_stream_source_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`create_document_job_and_wait_for_state`(...)	Calls `create_document_job()` and waits for the `DocumentJob` acted upon to enter the given state(s).
`create_image_job_and_wait_for_state`(...[, ...])	Calls `create_image_job()` and waits for the `ImageJob` acted upon to enter the given state(s).
`create_model_and_wait_for_state`(...[, ...])	Calls `create_model()` and waits for the `WorkRequest` to enter the given state(s).
`create_project_and_wait_for_state`(...[, ...])	Calls `create_project()` and waits for the `WorkRequest` to enter the given state(s).
`create_stream_group_and_wait_for_state`(...)	Calls `create_stream_group()` and waits for the `WorkRequest` to enter the given state(s).
`create_stream_job_and_wait_for_state`(...[, ...])	Calls `create_stream_job()` and waits for the `WorkRequest` to enter the given state(s).
`create_stream_source_and_wait_for_state`(...)	Calls `create_stream_source()` and waits for the `WorkRequest` to enter the given state(s).
`create_video_job_and_wait_for_state`(...[, ...])	Calls `create_video_job()` and waits for the `VideoJob` acted upon to enter the given state(s).
`create_vision_private_endpoint_and_wait_for_state`(...)	Calls `create_vision_private_endpoint()` 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 `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).
`delete_stream_group_and_wait_for_state`(...)	Calls `delete_stream_group()` and waits for the `WorkRequest` to enter the given state(s).
`delete_stream_job_and_wait_for_state`(...[, ...])	Calls `delete_stream_job()` and waits for the `WorkRequest` to enter the given state(s).
`delete_stream_source_and_wait_for_state`(...)	Calls `delete_stream_source()` and waits for the `WorkRequest` to enter the given state(s).
`delete_vision_private_endpoint_and_wait_for_state`(...)	Calls `delete_vision_private_endpoint()` and waits for the `WorkRequest` to enter the given state(s).
`start_stream_job_and_wait_for_state`(...[, ...])	Calls `start_stream_job()` and waits for the `WorkRequest` to enter the given state(s).
`stop_stream_job_and_wait_for_state`(stream_job_id)	Calls `stop_stream_job()` 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 `WorkRequest` to enter the given state(s).
`update_project_and_wait_for_state`(...[, ...])	Calls `update_project()` and waits for the `WorkRequest` to enter the given state(s).
`update_stream_group_and_wait_for_state`(...)	Calls `update_stream_group()` and waits for the `WorkRequest` to enter the given state(s).
`update_stream_job_and_wait_for_state`(...[, ...])	Calls `update_stream_job()` and waits for the `WorkRequest` to enter the given state(s).
`update_stream_source_and_wait_for_state`(...)	Calls `update_stream_source()` and waits for the `WorkRequest` to enter the given state(s).
`update_vision_private_endpoint_and_wait_for_state`(...)	Calls `update_vision_private_endpoint()` and waits for the `WorkRequest` to enter the given state(s).

__init__(client, **kwargs)¶

Creates a new AIServiceVisionClientCompositeOperations object

Parameters: client (AIServiceVisionClient) – The service client which will be wrapped by this object

change_stream_group_compartment_and_wait_for_state(stream_group_id, change_stream_group_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_group_id (str) – (required) StreamGroup Id.
change_stream_group_compartment_details (oci.ai_vision.models.ChangeStreamGroupCompartmentDetails) – (required) The details of the move.
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_stream_group_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

change_stream_job_compartment_and_wait_for_state(stream_job_id, change_stream_job_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_job_id (str) – (required) Stream job id.
change_stream_job_compartment_details (oci.ai_vision.models.ChangeStreamJobCompartmentDetails) – (required) The details of the move.
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_stream_job_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

change_stream_source_compartment_and_wait_for_state(stream_source_id, change_stream_source_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_source_id (str) – (required) StreamSource Id.
change_stream_source_compartment_details (oci.ai_vision.models.ChangeStreamSourceCompartmentDetails) – (required) The details of the move.
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_stream_source_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_document_job_and_wait_for_state(create_document_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_document_job() and waits for the DocumentJob acted upon to enter the given state(s).

Parameters

create_document_job_details (oci.ai_vision.models.CreateDocumentJobDetails) – (required) The details of the batch document analysis.
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_document_job()
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_image_job_and_wait_for_state(create_image_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_image_job() and waits for the ImageJob acted upon to enter the given state(s).

Parameters

create_image_job_details (oci.ai_vision.models.CreateImageJobDetails) – (required) The details of the batch image analysis.
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_image_job()
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 WorkRequest to enter the given state(s).

Parameters

create_model_details (oci.ai_vision.models.CreateModelDetails) – (required) The metadata about the new model.
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_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_project_and_wait_for_state(create_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

create_project_details (oci.ai_vision.models.CreateProjectDetails) – (required) The new Project’s details.
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_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

create_stream_group_and_wait_for_state(create_stream_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

create_stream_group_details (oci.ai_vision.models.CreateStreamGroupDetails) – (required) Details about the streamGroup
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_stream_group()
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_stream_job_and_wait_for_state(create_stream_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

create_stream_job_details (oci.ai_vision.models.CreateStreamJobDetails) – (required) Details about the stream analysis.
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_stream_job()
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_stream_source_and_wait_for_state(create_stream_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

create_stream_source_details (oci.ai_vision.models.CreateStreamSourceDetails) – (required) Details about the StreamSource
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_stream_source()
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_video_job_and_wait_for_state(create_video_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_video_job() and waits for the VideoJob acted upon to enter the given state(s).

Parameters

create_video_job_details (oci.ai_vision.models.CreateVideoJobDetails) – (required) Details about the video analysis.
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_video_job()
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_vision_private_endpoint_and_wait_for_state(create_vision_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

create_vision_private_endpoint_details (oci.ai_vision.models.CreateVisionPrivateEndpointDetails) – (required) The new VisionPrivateEndpoint’s details.
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_vision_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_model_and_wait_for_state(model_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

model_id (str) – (required) A unique model identifier.
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_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_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) A unique project identifier.
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

delete_stream_group_and_wait_for_state(stream_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_group_id (str) – (required) StreamGroup Id.
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_stream_group()
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_stream_job_and_wait_for_state(stream_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_job_id (str) – (required) Stream job id.
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_stream_job()
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_stream_source_and_wait_for_state(stream_source_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_source_id (str) – (required) StreamSource Id.
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_stream_source()
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_vision_private_endpoint_and_wait_for_state(vision_private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

vision_private_endpoint_id (str) – (required) Vision private endpoint Id.
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_vision_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

start_stream_job_and_wait_for_state(stream_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_job_id (str) – (required) Stream job id.
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 start_stream_job()
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

stop_stream_job_and_wait_for_state(stream_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_job_id (str) – (required) Stream job id.
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 stop_stream_job()
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 WorkRequest to enter the given state(s).

Parameters

model_id (str) – (required) A unique model identifier.
update_model_details (oci.ai_vision.models.UpdateModelDetails) – (required) The model metadata to be updated.
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_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_project_and_wait_for_state(project_id, update_project_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

project_id (str) – (required) A unique project identifier.
update_project_details (oci.ai_vision.models.UpdateProjectDetails) – (required) The project metadata to be updated.
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_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_stream_group_and_wait_for_state(stream_group_id, update_stream_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_group_id (str) – (required) StreamGroup Id.
update_stream_group_details (oci.ai_vision.models.UpdateStreamGroupDetails) – (required) Details about the streamGroup
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_stream_group()
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_stream_job_and_wait_for_state(update_stream_job_details, stream_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

update_stream_job_details (oci.ai_vision.models.UpdateStreamJobDetails) – (required) Details about the stream analysis.
stream_job_id (str) – (required) Stream job id.
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_stream_job()
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_stream_source_and_wait_for_state(stream_source_id, update_stream_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

stream_source_id (str) – (required) StreamSource Id.
update_stream_source_details (oci.ai_vision.models.UpdateStreamSourceDetails) – (required) Details about the StreamSource
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_stream_source()
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_vision_private_endpoint_and_wait_for_state(vision_private_endpoint_id, update_vision_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

vision_private_endpoint_id (str) – (required) Vision private endpoint Id.
update_vision_private_endpoint_details (oci.ai_vision.models.UpdateVisionPrivateEndpointDetails) – (required) The visionPrivateEndpoint metadata to be updated.
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_vision_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