AnnotationSummary

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

Bases: object

An annotation summary is the representation returned in list views. It is usually a subset of the full annotation entity and should not contain any potentially sensitive information.

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this AnnotationSummary.
defined_tags Gets the defined_tags of this AnnotationSummary.
freeform_tags Gets the freeform_tags of this AnnotationSummary.
id [Required] Gets the id of this AnnotationSummary.
lifecycle_state [Required] Gets the lifecycle_state of this AnnotationSummary.
record_id [Required] Gets the record_id of this AnnotationSummary.
time_created [Required] Gets the time_created of this AnnotationSummary.
time_updated [Required] Gets the time_updated of this AnnotationSummary.
__init__(**kwargs)

Initializes a new AnnotationSummary 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 AnnotationSummary.
  • time_created (datetime) – The value to assign to the time_created property of this AnnotationSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this AnnotationSummary.
  • record_id (str) – The value to assign to the record_id property of this AnnotationSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this AnnotationSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AnnotationSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AnnotationSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AnnotationSummary.
compartment_id

[Required] Gets the compartment_id of this AnnotationSummary. The OCID of the compartment for the annotation

Returns:The compartment_id of this AnnotationSummary.
Return type:str
defined_tags

Gets the defined_tags of this AnnotationSummary. 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 AnnotationSummary.
Return type:dict(str, dict(str, object))
freeform_tags

Gets the freeform_tags of this AnnotationSummary. 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 AnnotationSummary.
Return type:dict(str, str)
id

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

Returns:The id of this AnnotationSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this AnnotationSummary. Describes the lifecycle state.

Returns:The lifecycle_state of this AnnotationSummary.
Return type:str
record_id

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

Returns:The record_id of this AnnotationSummary.
Return type:str
time_created

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

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

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

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