Class AnnotationAnalyticsAggregation

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation.

Inheritance

object

AnnotationAnalyticsAggregation

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 AnnotationAnalyticsAggregation

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 containing the annotations.

Remarks

Required

Count

Declaration

[Required(ErrorMessage = "Count is required.")]
[JsonProperty(PropertyName = "count")]
public decimal? Count { get; set; }

Property Value

Type	Description
decimal?	The count of the matching results.

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 the annotations belong to.

Remarks

Required

Dimensions

Declaration

[JsonProperty(PropertyName = "dimensions")]
public AnnotationAggregationDimensions Dimensions { get; set; }

Property Value

Type	Description
AnnotationAggregationDimensions

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public Annotation.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Annotation.LifecycleStateEnum?	Describes the lifecycle state.

UpdatedBy

Declaration

[JsonProperty(PropertyName = "updatedBy")]
public string UpdatedBy { get; set; }

Property Value

Type	Description
string	The OCID of the principal which updated the annotation.