File manager

File manager - Edit - /usr/lib/mysqlsh/lib/python3.9/site-packages/oci/ai_vision/models/image_job.py

Back
# coding: utf-8 # Copyright (c) 2016, 2026, Oracle and/or its affiliates. All rights reserved. # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. # NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220125 from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401 from oci.decorators import init_model_state_from_kwargs @init_model_state_from_kwargs class ImageJob(object): """ The job details for a batch image analysis. """ #: A constant which can be used with the lifecycle_state property of a ImageJob. #: This constant has a value of "SUCCEEDED" LIFECYCLE_STATE_SUCCEEDED = "SUCCEEDED" #: A constant which can be used with the lifecycle_state property of a ImageJob. #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" #: A constant which can be used with the lifecycle_state property of a ImageJob. #: This constant has a value of "ACCEPTED" LIFECYCLE_STATE_ACCEPTED = "ACCEPTED" #: A constant which can be used with the lifecycle_state property of a ImageJob. #: This constant has a value of "CANCELED" LIFECYCLE_STATE_CANCELED = "CANCELED" #: A constant which can be used with the lifecycle_state property of a ImageJob. #: This constant has a value of "IN_PROGRESS" LIFECYCLE_STATE_IN_PROGRESS = "IN_PROGRESS" #: A constant which can be used with the lifecycle_state property of a ImageJob. #: This constant has a value of "CANCELING" LIFECYCLE_STATE_CANCELING = "CANCELING" #: A constant which can be used with the lifecycle_details property of a ImageJob. #: This constant has a value of "PARTIALLY_SUCCEEDED" LIFECYCLE_DETAILS_PARTIALLY_SUCCEEDED = "PARTIALLY_SUCCEEDED" #: A constant which can be used with the lifecycle_details property of a ImageJob. #: This constant has a value of "COMPLETELY_FAILED" LIFECYCLE_DETAILS_COMPLETELY_FAILED = "COMPLETELY_FAILED" def __init__(self, kwargs): """ Initializes a new ImageJob object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): :param id: The value to assign to the id property of this ImageJob. :type id: str :param compartment_id: The value to assign to the compartment_id property of this ImageJob. :type compartment_id: str :param display_name: The value to assign to the display_name property of this ImageJob. :type display_name: str :param features: The value to assign to the features property of this ImageJob. :type features: list[oci.ai_vision.models.ImageFeature] :param input_location: The value to assign to the input_location property of this ImageJob. :type input_location: oci.ai_vision.models.InputLocation :param time_accepted: The value to assign to the time_accepted property of this ImageJob. :type time_accepted: datetime :param time_started: The value to assign to the time_started property of this ImageJob. :type time_started: datetime :param time_finished: The value to assign to the time_finished property of this ImageJob. :type time_finished: datetime :param percent_complete: The value to assign to the percent_complete property of this ImageJob. :type percent_complete: float :param output_location: The value to assign to the output_location property of this ImageJob. :type output_location: oci.ai_vision.models.OutputLocation :param lifecycle_state: The value to assign to the lifecycle_state property of this ImageJob. Allowed values for this property are: "SUCCEEDED", "FAILED", "ACCEPTED", "CANCELED", "IN_PROGRESS", "CANCELING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str :param lifecycle_details: The value to assign to the lifecycle_details property of this ImageJob. Allowed values for this property are: "PARTIALLY_SUCCEEDED", "COMPLETELY_FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_details: str :param is_zip_output_enabled: The value to assign to the is_zip_output_enabled property of this ImageJob. :type is_zip_output_enabled: bool """ self.swagger_types = { 'id': 'str', 'compartment_id': 'str', 'display_name': 'str', 'features': 'list[ImageFeature]', 'input_location': 'InputLocation', 'time_accepted': 'datetime', 'time_started': 'datetime', 'time_finished': 'datetime', 'percent_complete': 'float', 'output_location': 'OutputLocation', 'lifecycle_state': 'str', 'lifecycle_details': 'str', 'is_zip_output_enabled': 'bool' } self.attribute_map = { 'id': 'id', 'compartment_id': 'compartmentId', 'display_name': 'displayName', 'features': 'features', 'input_location': 'inputLocation', 'time_accepted': 'timeAccepted', 'time_started': 'timeStarted', 'time_finished': 'timeFinished', 'percent_complete': 'percentComplete', 'output_location': 'outputLocation', 'lifecycle_state': 'lifecycleState', 'lifecycle_details': 'lifecycleDetails', 'is_zip_output_enabled': 'isZipOutputEnabled' } self._id = None self._compartment_id = None self._display_name = None self._features = None self._input_location = None self._time_accepted = None self._time_started = None self._time_finished = None self._percent_complete = None self._output_location = None self._lifecycle_state = None self._lifecycle_details = None self._is_zip_output_enabled = None @property def id(self): """ [Required] Gets the id of this ImageJob. The job id :return: The id of this ImageJob. :rtype: str """ return self._id @id.setter def id(self, id): """ Sets the id of this ImageJob. The job id :param id: The id of this ImageJob. :type: str """ self._id = id @property def compartment_id(self): """ [Required] Gets the compartment_id of this ImageJob. The OCID of the compartment that starts the job. :return: The compartment_id of this ImageJob. :rtype: str """ return self._compartment_id @compartment_id.setter def compartment_id(self, compartment_id): """ Sets the compartment_id of this ImageJob. The OCID of the compartment that starts the job. :param compartment_id: The compartment_id of this ImageJob. :type: str """ self._compartment_id = compartment_id @property def display_name(self): """ Gets the display_name of this ImageJob. The image job display name. :return: The display_name of this ImageJob. :rtype: str """ return self._display_name @display_name.setter def display_name(self, display_name): """ Sets the display_name of this ImageJob. The image job display name. :param display_name: The display_name of this ImageJob. :type: str """ self._display_name = display_name @property def features(self): """ [Required] Gets the features of this ImageJob. The list of requested document analysis types. :return: The features of this ImageJob. :rtype: list[oci.ai_vision.models.ImageFeature] """ return self._features @features.setter def features(self, features): """ Sets the features of this ImageJob. The list of requested document analysis types. :param features: The features of this ImageJob. :type: list[oci.ai_vision.models.ImageFeature] """ self._features = features @property def input_location(self): """ Gets the input_location of this ImageJob. :return: The input_location of this ImageJob. :rtype: oci.ai_vision.models.InputLocation """ return self._input_location @input_location.setter def input_location(self, input_location): """ Sets the input_location of this ImageJob. :param input_location: The input_location of this ImageJob. :type: oci.ai_vision.models.InputLocation """ self._input_location = input_location @property def time_accepted(self): """ [Required] Gets the time_accepted of this ImageJob. The job acceptance time. :return: The time_accepted of this ImageJob. :rtype: datetime """ return self._time_accepted @time_accepted.setter def time_accepted(self, time_accepted): """ Sets the time_accepted of this ImageJob. The job acceptance time. :param time_accepted: The time_accepted of this ImageJob. :type: datetime """ self._time_accepted = time_accepted @property def time_started(self): """ Gets the time_started of this ImageJob. The job start time. :return: The time_started of this ImageJob. :rtype: datetime """ return self._time_started @time_started.setter def time_started(self, time_started): """ Sets the time_started of this ImageJob. The job start time. :param time_started: The time_started of this ImageJob. :type: datetime """ self._time_started = time_started @property def time_finished(self): """ Gets the time_finished of this ImageJob. The job finish time. :return: The time_finished of this ImageJob. :rtype: datetime """ return self._time_finished @time_finished.setter def time_finished(self, time_finished): """ Sets the time_finished of this ImageJob. The job finish time. :param time_finished: The time_finished of this ImageJob. :type: datetime """ self._time_finished = time_finished @property def percent_complete(self): """ Gets the percent_complete of this ImageJob. How much progress the operation has made, compared to the total amount of work to be performed. :return: The percent_complete of this ImageJob. :rtype: float """ return self._percent_complete @percent_complete.setter def percent_complete(self, percent_complete): """ Sets the percent_complete of this ImageJob. How much progress the operation has made, compared to the total amount of work to be performed. :param percent_complete: The percent_complete of this ImageJob. :type: float """ self._percent_complete = percent_complete @property def output_location(self): """ [Required] Gets the output_location of this ImageJob. :return: The output_location of this ImageJob. :rtype: oci.ai_vision.models.OutputLocation """ return self._output_location @output_location.setter def output_location(self, output_location): """ Sets the output_location of this ImageJob. :param output_location: The output_location of this ImageJob. :type: oci.ai_vision.models.OutputLocation """ self._output_location = output_location @property def lifecycle_state(self): """ [Required]** Gets the lifecycle_state of this ImageJob. The current state of the batch image job. Allowed values for this property are: "SUCCEEDED", "FAILED", "ACCEPTED", "CANCELED", "IN_PROGRESS", "CANCELING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The lifecycle_state of this ImageJob. :rtype: str """ return self._lifecycle_state @lifecycle_state.setter def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this ImageJob. The current state of the batch image job. :param lifecycle_state: The lifecycle_state of this ImageJob. :type: str """ allowed_values = ["SUCCEEDED", "FAILED", "ACCEPTED", "CANCELED", "IN_PROGRESS", "CANCELING"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state @property def lifecycle_details(self): """ Gets the lifecycle_details of this ImageJob. The detailed status of FAILED state. Allowed values for this property are: "PARTIALLY_SUCCEEDED", "COMPLETELY_FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The lifecycle_details of this ImageJob. :rtype: str """ return self._lifecycle_details @lifecycle_details.setter def lifecycle_details(self, lifecycle_details): """ Sets the lifecycle_details of this ImageJob. The detailed status of FAILED state. :param lifecycle_details: The lifecycle_details of this ImageJob. :type: str """ allowed_values = ["PARTIALLY_SUCCEEDED", "COMPLETELY_FAILED"] if not value_allowed_none_or_none_sentinel(lifecycle_details, allowed_values): lifecycle_details = 'UNKNOWN_ENUM_VALUE' self._lifecycle_details = lifecycle_details @property def is_zip_output_enabled(self): """ Gets the is_zip_output_enabled of this ImageJob. Whether or not to generate a ZIP file containing the results. :return: The is_zip_output_enabled of this ImageJob. :rtype: bool """ return self._is_zip_output_enabled @is_zip_output_enabled.setter def is_zip_output_enabled(self, is_zip_output_enabled): """ Sets the is_zip_output_enabled of this ImageJob. Whether or not to generate a ZIP file containing the results. :param is_zip_output_enabled: The is_zip_output_enabled of this ImageJob. :type: bool """ self._is_zip_output_enabled = is_zip_output_enabled def __repr__(self): return formatted_flat_dict(self) def __eq__(self, other): if other is None: return False return self.__dict__ == other.__dict__ def __ne__(self, other): return not self == other

| ver. 1.4 | Github | . | PHP 8.2.32 | Generation time: 0.06 | proxy | phpinfo | Settings