DatasetSummary

class oci.data_labeling_service.models.DatasetSummary(**kwargs)

Bases: object

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

Methods

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

Attributes

annotation_format [Required] Gets the annotation_format of this DatasetSummary.
compartment_id [Required] Gets the compartment_id of this DatasetSummary.
dataset_format_details [Required] Gets the dataset_format_details of this DatasetSummary.
defined_tags Gets the defined_tags of this DatasetSummary.
display_name Gets the display_name of this DatasetSummary.
freeform_tags Gets the freeform_tags of this DatasetSummary.
id [Required] Gets the id of this DatasetSummary.
lifecycle_details Gets the lifecycle_details of this DatasetSummary.
lifecycle_state [Required] Gets the lifecycle_state of this DatasetSummary.
system_tags Gets the system_tags of this DatasetSummary.
time_created [Required] Gets the time_created of this DatasetSummary.
time_updated [Required] Gets the time_updated of this DatasetSummary.
__init__(**kwargs)

Initializes a new DatasetSummary 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 DatasetSummary.
  • display_name (str) – The value to assign to the display_name property of this DatasetSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this DatasetSummary.
  • time_created (datetime) – The value to assign to the time_created property of this DatasetSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this DatasetSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatasetSummary.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatasetSummary.
  • annotation_format (str) – The value to assign to the annotation_format property of this DatasetSummary.
  • dataset_format_details (oci.data_labeling_service.models.DatasetFormatDetails) – The value to assign to the dataset_format_details property of this DatasetSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatasetSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatasetSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatasetSummary.
annotation_format

[Required] Gets the annotation_format of this DatasetSummary. The annotation format name required for labeling records.

Returns:The annotation_format of this DatasetSummary.
Return type:str
compartment_id

[Required] Gets the compartment_id of this DatasetSummary. Compartment Identifier

Returns:The compartment_id of this DatasetSummary.
Return type:str
dataset_format_details

[Required] Gets the dataset_format_details of this DatasetSummary.

Returns:The dataset_format_details of this DatasetSummary.
Return type:oci.data_labeling_service.models.DatasetFormatDetails
defined_tags

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

Gets the display_name of this DatasetSummary. A user-friendly display name for the resource.

Returns:The display_name of this DatasetSummary.
Return type:str
freeform_tags

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

[Required] Gets the id of this DatasetSummary. The OCID of the Dataset

Returns:The id of this DatasetSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this DatasetSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:The lifecycle_details of this DatasetSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this DatasetSummary. The state of a Dataset.

Returns:The lifecycle_state of this DatasetSummary.
Return type:str
system_tags

Gets the system_tags of this DatasetSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:The system_tags of this DatasetSummary.
Return type:dict(str, dict(str, object))
time_created

[Required] Gets the time_created of this DatasetSummary. The time the the Dataset was created. An RFC3339 formatted datetime string

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

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

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