Package com.oracle.bmc.ocicontrolcenter.model

Class RequestSummarizedMetricDataDetails

java.lang.Object

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

com.oracle.bmc.ocicontrolcenter.model.RequestSummarizedMetricDataDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230515")
public final class RequestSummarizedMetricDataDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The request details for retrieving aggregated data.

Use the query and optional properties to filter the returned results.
Note: Objects should always be created or deserialized using the RequestSummarizedMetricDataDetails.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 RequestSummarizedMetricDataDetails.Builder, which maintain a set of all explicitly set fields called RequestSummarizedMetricDataDetails.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	RequestSummarizedMetricDataDetails.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
RequestSummarizedMetricDataDetails(String namespaceName, String metricName, String compartmentId, Map<String,DimensionValue> dimensions, Date startTime, Date endTime)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RequestSummarizedMetricDataDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment to use for authorization to read metrics.
Map<String,DimensionValue>	getDimensions()	Qualifiers to use when searching for metric data.
Date	getEndTime()	The end of the sampled time range to use when searching for metric data points.
String	getMetricName()	The name of a metric for retrieving aggregated data.
String	getNamespaceName()	The source service or application to use when searching for metric data points to aggregate.
Date	getStartTime()	The beginning of the sampled time range to use when searching for metric data points.
int	hashCode()
RequestSummarizedMetricDataDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

RequestSummarizedMetricDataDetails

@Deprecated
@ConstructorProperties({"namespaceName","metricName","compartmentId","dimensions","startTime","endTime"})
public RequestSummarizedMetricDataDetails(String namespaceName,
                                          String metricName,
                                          String compartmentId,
                                          Map<String,DimensionValue> dimensions,
                                          Date startTime,
                                          Date endTime)

Deprecated.

Method Detail

builder

public static RequestSummarizedMetricDataDetails.Builder builder()

Create a new builder.

toBuilder

public RequestSummarizedMetricDataDetails.Builder toBuilder()

getNamespaceName

public String getNamespaceName()

The source service or application to use when searching for metric data points to aggregate.

For a list of valid namespaces, see listNamespaces.

Returns:

the value

getMetricName

public String getMetricName()

The name of a metric for retrieving aggregated data.

For a list of valid metrics for a given namespace, see listMetricProperties.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment to use for authorization to read metrics.

To use the root compartment, provide the tenancyId.

Returns:

the value

getDimensions

public Map<String,DimensionValue> getDimensions()

Qualifiers to use when searching for metric data.

For a list of valid dimensions for a given metric, see listMetricProperties.

Returns:

the value

getStartTime

public Date getStartTime()

The beginning of the sampled time range to use when searching for metric data points.

Format is defined by RFC3339. The response includes metric data points for the sampled time. Example 2019-02-01T02:02:29.600Z

Returns:

the value

getEndTime

public Date getEndTime()

The end of the sampled time range to use when searching for metric data points.

Format is defined by RFC3339. The response excludes metric data points for sampled time. Example 2019-02-01T02:02:29.600Z

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel