RecordSummary

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

Bases: object

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

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this RecordSummary.
dataset_id [Required] Gets the dataset_id of this RecordSummary.
defined_tags Gets the defined_tags of this RecordSummary.
freeform_tags Gets the freeform_tags of this RecordSummary.
id [Required] Gets the id of this RecordSummary.
is_labeled [Required] Gets the is_labeled of this RecordSummary.
lifecycle_state [Required] Gets the lifecycle_state of this RecordSummary.
name [Required] Gets the name of this RecordSummary.
record_metadata Gets the record_metadata of this RecordSummary.
time_created [Required] Gets the time_created of this RecordSummary.
time_updated [Required] Gets the time_updated of this RecordSummary.
__init__(**kwargs)

Initializes a new RecordSummary 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 RecordSummary.
  • name (str) – The value to assign to the name property of this RecordSummary.
  • time_created (datetime) – The value to assign to the time_created property of this RecordSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this RecordSummary.
  • dataset_id (str) – The value to assign to the dataset_id property of this RecordSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this RecordSummary.
  • is_labeled (bool) – The value to assign to the is_labeled property of this RecordSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this RecordSummary.
  • record_metadata (oci.data_labeling_service_dataplane.models.RecordMetadata) – The value to assign to the record_metadata property of this RecordSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RecordSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RecordSummary.
compartment_id

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

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

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

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

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

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

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

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

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

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

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

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

[Required] Gets the name of this RecordSummary. The name is automatically assigned by the service. It is unique and immutable

Returns:The name of this RecordSummary.
Return type:str
record_metadata

Gets the record_metadata of this RecordSummary.

Returns:The record_metadata of this RecordSummary.
Return type:oci.data_labeling_service_dataplane.models.RecordMetadata
time_created

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

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

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

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