Show / Hide Table of Contents

Class Record

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

Inheritance
object
Record
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatalabelingservicedataplaneService.Models
Assembly: OCI.DotNetSDK.Datalabelingservicedataplane.dll
Syntax
public class Record

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment for the task.

Remarks

Required

DatasetId

Declaration
[Required(ErrorMessage = "DatasetId is required.")]
[JsonProperty(PropertyName = "datasetId")]
public string DatasetId { get; set; }
Property Value
Type Description
string

The OCID of the dataset to associate the record with.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

The defined tags for this resource. Each key is predefined and scoped to a namespace. For Example: {"foo-namespace": {"bar-key": "value"}}

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the record.

Remarks

Required

IsLabeled

Declaration
[Required(ErrorMessage = "IsLabeled is required.")]
[JsonProperty(PropertyName = "isLabeled")]
public bool? IsLabeled { get; set; }
Property Value
Type Description
bool?

Whether or not the record has been labeled and has associated annotations.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Record.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Record.LifecycleStateEnum?

The lifecycle state of the record. ACTIVE - The record is active and ready for labeling. INACTIVE - The record has been marked as inactive and should not be used for labeling. DELETED - The record has been deleted and is no longer available for labeling.

Remarks

Required

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

The name is created by the user. It is unique and immutable.

Remarks

Required

RecordMetadata

Declaration
[JsonProperty(PropertyName = "recordMetadata")]
public RecordMetadata RecordMetadata { get; set; }
Property Value
Type Description
RecordMetadata

SourceDetails

Declaration
[Required(ErrorMessage = "SourceDetails is required.")]
[JsonProperty(PropertyName = "sourceDetails")]
public SourceDetails SourceDetails { get; set; }
Property Value
Type Description
SourceDetails
Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the resource was created, in the timestamp format defined by RFC3339.

Remarks

Required

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the resource was updated, in the timestamp format defined by RFC3339.

Remarks

Required

In this article
Back to top