Annotation¶

class oci.data_labeling_service_dataplane.models.Annotation(**kwargs)¶

Bases: object

An annotation represents a user- or machine-generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Annotation.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Annotation.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Annotation.
`compartment_id`	[Required] Gets the compartment_id of this Annotation.
`created_by`	[Required] Gets the created_by of this Annotation.
`defined_tags`	Gets the defined_tags of this Annotation.
`entities`	[Required] Gets the entities of this Annotation.
`freeform_tags`	Gets the freeform_tags of this Annotation.
`id`	[Required] Gets the id of this Annotation.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Annotation.
`record_id`	[Required] Gets the record_id of this Annotation.
`time_created`	[Required] Gets the time_created of this Annotation.
`time_updated`	[Required] Gets the time_updated of this Annotation.
`updated_by`	[Required] Gets the updated_by of this Annotation.

Methods

__init__(**kwargs) Initializes a new Annotation object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Annotation. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Annotation. This constant has a value of “DELETED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Annotation. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new Annotation 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 Annotation.
time_created (datetime) – The value to assign to the time_created property of this Annotation.
time_updated (datetime) – The value to assign to the time_updated property of this Annotation.
created_by (str) – The value to assign to the created_by property of this Annotation.
updated_by (str) – The value to assign to the updated_by property of this Annotation.
record_id (str) – The value to assign to the record_id property of this Annotation.
entities (list[oci.data_labeling_service_dataplane.models.Entity]) – The value to assign to the entities property of this Annotation.
compartment_id (str) – The value to assign to the compartment_id property of this Annotation.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Annotation. 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 Annotation.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Annotation.

compartment_id¶

[Required] Gets the compartment_id of this Annotation. The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself.

Returns:	The compartment_id of this Annotation.
Return type:	str

created_by¶

[Required] Gets the created_by of this Annotation. The OCID of the principal which created the annotation.

Returns:	The created_by of this Annotation.
Return type:	str

defined_tags¶

Gets the defined_tags of this Annotation. The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

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

entities¶

[Required] Gets the entities of this Annotation. The entity types are validated against the dataset to ensure consistency.

Returns:	The entities of this Annotation.
Return type:	list[oci.data_labeling_service_dataplane.models.Entity]

freeform_tags¶

Gets the freeform_tags of this Annotation. A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {“bar-key”: “value”}

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

id¶

[Required] Gets the id of this Annotation. The OCID of the annotation.

Returns:	The id of this Annotation.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Annotation. The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for labeling. INACTIVE - The annotation has been marked as inactive and should not be used for labeling. DELETED - Tha annotation 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 Annotation.
Return type:	str

record_id¶

[Required] Gets the record_id of this Annotation. The OCID of the record annotated.

Returns:	The record_id of this Annotation.
Return type:	str

time_created¶

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

Returns:	The time_created of this Annotation.
Return type:	datetime

time_updated¶

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

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

updated_by¶

[Required] Gets the updated_by of this Annotation. The OCID of the principal which updated the annotation.

Returns:	The updated_by of this Annotation.
Return type:	str