Class RecordAnalyticsAggregation

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize record information for a given dataset and are 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

RecordAnalyticsAggregation

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 RecordAnalyticsAggregation

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	ocid of the compartment the records

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	ocid of the dataset the annotation belongs to

Remarks

Required

Dimensions

Declaration

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

Property Value

Type	Description
RecordAggregationDimensions

LifecycleState

Declaration

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

Property Value

Type	Description
Record.LifecycleStateEnum?	Describes the lifecycle state.