Record

class oci.data_labeling_service_dataplane.models.Record(**kwargs)

Bases: object

A record represents an entry in a dataset that needs labeling.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Record.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Record.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a Record.
compartment_id [Required] Gets the compartment_id of this Record.
dataset_id [Required] Gets the dataset_id of this Record.
defined_tags Gets the defined_tags of this Record.
freeform_tags Gets the freeform_tags of this Record.
id [Required] Gets the id of this Record.
is_labeled [Required] Gets the is_labeled of this Record.
lifecycle_state [Required] Gets the lifecycle_state of this Record.
name [Required] Gets the name of this Record.
source_details [Required] Gets the source_details of this Record.
time_created [Required] Gets the time_created of this Record.
time_updated [Required] Gets the time_updated of this Record.

Methods

__init__(**kwargs) Initializes a new Record object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Record. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Record. This constant has a value of “DELETED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Record. This constant has a value of “INACTIVE”

__init__(**kwargs)

Initializes a new Record object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • id (str) – The value to assign to the id property of this Record.
  • name (str) – The value to assign to the name property of this Record.
  • time_created (datetime) – The value to assign to the time_created property of this Record.
  • time_updated (datetime) – The value to assign to the time_updated property of this Record.
  • dataset_id (str) – The value to assign to the dataset_id property of this Record.
  • compartment_id (str) – The value to assign to the compartment_id property of this Record.
  • source_details (oci.data_labeling_service_dataplane.models.SourceDetails) – The value to assign to the source_details property of this Record.
  • is_labeled (bool) – The value to assign to the is_labeled property of this Record.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Record. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Record.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Record.
compartment_id

[Required] Gets the compartment_id of this Record. The OCID of the compartment for the task.

Returns:The compartment_id of this Record.
Return type:str
dataset_id

[Required] Gets the dataset_id of this Record. The OCID of the dataset to associate the record with

Returns:The dataset_id of this Record.
Return type:str
defined_tags

Gets the defined_tags of this Record. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this Record.
Return type:dict(str, dict(str, object))
freeform_tags

Gets the freeform_tags of this Record. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:The freeform_tags of this Record.
Return type:dict(str, str)
id

[Required] Gets the id of this Record. The OCID of the record

Returns:The id of this Record.
Return type:str
is_labeled

[Required] Gets the is_labeled of this Record. Whether the record has been labeled and has associated annotations.

Returns:The is_labeled of this Record.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this Record. Lifecycle state of the Record. ACTIVE - Record is active and ready for labeling. INACTIVE - Record has been marked as inactive and should not be used for labeling. DELETED - Record has been deleted and no longer available for labeling.

Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this Record.
Return type:str
name

[Required] Gets the name of this Record. This will be created by Customer. It will be unique and immutable.

Returns:The name of this Record.
Return type:str
source_details

[Required] Gets the source_details of this Record.

Returns:The source_details of this Record.
Return type:oci.data_labeling_service_dataplane.models.SourceDetails
time_created

[Required] Gets the time_created of this Record. The date and time the resource was created, in the timestamp format defined by RFC3339.

Returns:The time_created of this Record.
Return type:datetime
time_updated

[Required] Gets the time_updated of this Record. The date and time the resource was updated, in the timestamp format defined by RFC3339.

Returns:The time_updated of this Record.
Return type:datetime