RecordAnalyticsAggregation¶

class oci.data_labeling_service_dataplane.models.RecordAnalyticsAggregation(**kwargs)¶

Bases: object

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.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this RecordAnalyticsAggregation.
`count`	[Required] Gets the count of this RecordAnalyticsAggregation.
`dataset_id`	[Required] Gets the dataset_id of this RecordAnalyticsAggregation.
`dimensions`	Gets the dimensions of this RecordAnalyticsAggregation.
`lifecycle_state`	Gets the lifecycle_state of this RecordAnalyticsAggregation.

__init__(**kwargs)¶

Initializes a new RecordAnalyticsAggregation object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

count (float) – The value to assign to the count property of this RecordAnalyticsAggregation.
dimensions (oci.data_labeling_service_dataplane.models.RecordAggregationDimensions) – The value to assign to the dimensions property of this RecordAnalyticsAggregation.
dataset_id (str) – The value to assign to the dataset_id property of this RecordAnalyticsAggregation.
compartment_id (str) – The value to assign to the compartment_id property of this RecordAnalyticsAggregation.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RecordAnalyticsAggregation.

compartment_id¶

[Required] Gets the compartment_id of this RecordAnalyticsAggregation. ocid of the compartment the records

Returns:	The compartment_id of this RecordAnalyticsAggregation.
Return type:	str

count¶

[Required] Gets the count of this RecordAnalyticsAggregation. the count of the matching results

Returns:	The count of this RecordAnalyticsAggregation.
Return type:	float

dataset_id¶

[Required] Gets the dataset_id of this RecordAnalyticsAggregation. ocid of the dataset the annotation belongs to

Returns:	The dataset_id of this RecordAnalyticsAggregation.
Return type:	str

dimensions¶

Gets the dimensions of this RecordAnalyticsAggregation.

Returns:	The dimensions of this RecordAnalyticsAggregation.
Return type:	oci.data_labeling_service_dataplane.models.RecordAggregationDimensions

lifecycle_state¶

Gets the lifecycle_state of this RecordAnalyticsAggregation. Describes the lifecycle state.

Returns:	The lifecycle_state of this RecordAnalyticsAggregation.
Return type:	str