@Generated(value="OracleSDKGenerator",
comments="API Version: 20180401")
public final class SummarizeMetricsDataDetails
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 SummarizeMetricsDataDetails.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 SummarizeMetricsDataDetails.Builder, which maintain a
set of all explicitly set fields called SummarizeMetricsDataDetails.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 |
SummarizeMetricsDataDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
SummarizeMetricsDataDetails(String namespace,
String resourceGroup,
String query,
Date startTime,
Date endTime,
String resolution)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static SummarizeMetricsDataDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Date |
getEndTime()
The end of the time range to use when searching for metric data points.
|
String |
getNamespace()
The source service or application to use when searching for metric data points to aggregate.
|
String |
getQuery()
The Monitoring Query Language (MQL) expression to use when searching for metric data points
to aggregate.
|
String |
getResolution()
The time between calculated aggregation windows.
|
String |
getResourceGroup()
Resource group that you want to match.
|
Date |
getStartTime()
The beginning of the time range to use when searching for metric data points.
|
int |
hashCode() |
SummarizeMetricsDataDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"namespace","resourceGroup","query","startTime","endTime","resolution"}) public SummarizeMetricsDataDetails(String namespace, String resourceGroup, String query, Date startTime, Date endTime, String resolution)
public static SummarizeMetricsDataDetails.Builder builder()
Create a new builder.
public SummarizeMetricsDataDetails.Builder toBuilder()
public String getNamespace()
The source service or application to use when searching for metric data points to aggregate.
Example: oci_computeagent
public String getResourceGroup()
Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).
Example: frontend-fleet
public String getQuery()
The Monitoring Query Language (MQL) expression to use when searching for metric data points
to aggregate. The query must specify a metric, statistic, and interval. Supported values for
interval depend on the specified time range. More interval values are supported for smaller
time ranges. You can optionally specify dimensions and grouping functions. When specifying a
dimension value, surround it with double quotes, and escape each double quote with a
backslash (\\) character. Supported grouping functions: grouping(), groupBy().
Construct your query to avoid exceeding limits on returned data. See MetricData.
For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
Example 1: CpuUtilization[1m].sum()
Example 2 (escaped double quotes for value string): CpuUtilization[1m]{resourceId =
\\"<var><instance_OCID></var>\\"}.max()
public Date getStartTime()
The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.
Example: 2023-02-01T01:02:29.600Z
public Date getEndTime()
The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.
Example: 2023-02-01T02:02:29.600Z
public String getResolution()
The time between calculated aggregation windows. Use with the query interval to vary the
frequency for returning aggregated data points. For example, use a query interval of 5
minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute
frequency. The resolution must be equal or less than the interval in the query. The default
resolution is 1m (one minute). Supported values: 1m-60m, 1h-24h, 1d.
Example: 5m
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic 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.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.