Package com.oracle.bmc.apmconfig.model

Class MetricGroupSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.apmconfig.model.ConfigSummary

com.oracle.bmc.apmconfig.model.MetricGroupSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public final class MetricGroupSummary
extends ConfigSummary

A metric group defines a set of metrics to collect from a span.

It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.
Note: Objects should always be created or deserialized using the MetricGroupSummary.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 MetricGroupSummary.Builder, which maintain a set of all explicitly set fields called MetricGroupSummary.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricGroupSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
MetricGroupSummary(String id, Date timeCreated, Date timeUpdated, String createdBy, String updatedBy, String etag, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, String displayName, String filterId, String namespace, List<Dimension> dimensions, List<Metric> metrics)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static MetricGroupSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<Dimension>	getDimensions()	A list of dimensions for the metric.
String	getDisplayName()	The name by which a configuration entity is displayed to the end user.
String	getFilterId()	The OCID of a Span Filter.
List<Metric>	getMetrics()	The list of metrics in this group.
String	getNamespace()	The namespace to which the metrics are published.
int	hashCode()
MetricGroupSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.apmconfig.model.ConfigSummary

getCreatedBy, getDefinedTags, getEtag, getFreeformTags, getId, getSystemTags, getTimeCreated, getTimeUpdated, getUpdatedBy

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricGroupSummary

@Deprecated
public MetricGroupSummary(String id,
                          Date timeCreated,
                          Date timeUpdated,
                          String createdBy,
                          String updatedBy,
                          String etag,
                          Map<String,String> freeformTags,
                          Map<String,Map<String,Object>> definedTags,
                          Map<String,Map<String,Object>> systemTags,
                          String displayName,
                          String filterId,
                          String namespace,
                          List<Dimension> dimensions,
                          List<Metric> metrics)

Deprecated.

Method Detail

builder

public static MetricGroupSummary.Builder builder()

Create a new builder.

toBuilder

public MetricGroupSummary.Builder toBuilder()

getDisplayName

public String getDisplayName()

The name by which a configuration entity is displayed to the end user.

Returns:

the value

getFilterId

public String getFilterId()

The OCID of a Span Filter.

The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.

Returns:

the value

getNamespace

public String getNamespace()

The namespace to which the metrics are published.

It must be one of several predefined namespaces.

Returns:

the value

getDimensions

public List<Dimension> getDimensions()

A list of dimensions for the metric.

This variable should not be used.

Returns:

the value

getMetrics

public List<Metric> getMetrics()

The list of metrics in this group.

Returns:

the value

toString

public String toString()

Overrides:

toString in class ConfigSummary

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ConfigSummary

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ConfigSummary

hashCode

public int hashCode()

Overrides:

hashCode in class ConfigSummary