Class Annotation
An annotation represents a user- or machine-generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.
Inherited Members
Namespace: Oci.DatalabelingservicedataplaneService.Models
Assembly: OCI.DotNetSDK.Datalabelingservicedataplane.dll
Syntax
public class Annotation
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 annotation. This is tied to the dataset. It is not changeable on the record itself. |
Remarks
Required
CreatedBy
Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the principal which created the annotation. |
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"}} |
Entities
Declaration
[Required(ErrorMessage = "Entities is required.")]
[JsonProperty(PropertyName = "entities")]
public List<Entity> Entities { get; set; }
Property Value
Type | Description |
---|---|
List<Entity> | The entity types are validated against the dataset to ensure consistency. |
Remarks
Required
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 annotation. |
Remarks
Required
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Annotation.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Annotation.LifecycleStateEnum? | 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. |
Remarks
Required
RecordId
Declaration
[Required(ErrorMessage = "RecordId is required.")]
[JsonProperty(PropertyName = "recordId")]
public string RecordId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the record annotated. |
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 annotation 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
UpdatedBy
Declaration
[Required(ErrorMessage = "UpdatedBy is required.")]
[JsonProperty(PropertyName = "updatedBy")]
public string UpdatedBy { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the principal which updated the annotation. |
Remarks
Required