@Generated(value="OracleSDKGenerator", comments="API Version: 20211001") public final class AnnotationAnalyticsAggregation extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.
Note: Objects should always be created or deserialized using the AnnotationAnalyticsAggregation.Builder
. This model
distinguishes fields that are null
because they are unset from fields that are explicitly
set to null
. This is done in the setter methods of the AnnotationAnalyticsAggregation.Builder
, which maintain a
set of all explicitly set fields called AnnotationAnalyticsAggregation.Builder.__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
AnnotationAnalyticsAggregation.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
AnnotationAnalyticsAggregation(BigDecimal count,
String datasetId,
AnnotationAggregationDimensions dimensions,
String updatedBy,
String compartmentId,
Annotation.LifecycleState lifecycleState)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AnnotationAnalyticsAggregation.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment containing the annotations.
|
BigDecimal |
getCount()
The count of the matching results.
|
String |
getDatasetId()
The OCID of the dataset the annotations belong to.
|
AnnotationAggregationDimensions |
getDimensions() |
Annotation.LifecycleState |
getLifecycleState()
Describes the lifecycle state.
|
String |
getUpdatedBy()
The OCID of the principal which updated the annotation.
|
int |
hashCode() |
AnnotationAnalyticsAggregation.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"count","datasetId","dimensions","updatedBy","compartmentId","lifecycleState"}) public AnnotationAnalyticsAggregation(BigDecimal count, String datasetId, AnnotationAggregationDimensions dimensions, String updatedBy, String compartmentId, Annotation.LifecycleState lifecycleState)
public static AnnotationAnalyticsAggregation.Builder builder()
Create a new builder.
public AnnotationAnalyticsAggregation.Builder toBuilder()
public BigDecimal getCount()
The count of the matching results.
public String getDatasetId()
The OCID of the dataset the annotations belong to.
public AnnotationAggregationDimensions getDimensions()
public String getUpdatedBy()
The OCID of the principal which updated the annotation.
public String getCompartmentId()
The OCID of the compartment containing the annotations.
public Annotation.LifecycleState getLifecycleState()
Describes the lifecycle state.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.