@Generated(value="OracleSDKGenerator", comments="API Version: 20180401") public final class SummarizeMetricsDataDetails extends Object
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 __explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take __explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
SummarizeMetricsDataDetails.Builder |
Constructor and Description |
---|
SummarizeMetricsDataDetails(String namespace,
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) |
Set<String> |
get__explicitlySet__() |
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.
|
Date |
getStartTime()
The beginning of the time range to use when searching for metric data points.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"namespace","query","startTime","endTime","resolution"}) @Deprecated public SummarizeMetricsDataDetails(String namespace, String query, Date startTime, Date endTime, String resolution)
public static SummarizeMetricsDataDetails.Builder builder()
Create a new builder.
public String getNamespace()
The source service or application to use when searching for metric data points to aggregate.
Example: oci_computeagent
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: 1m
-60m
(also 1h
). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping()
, groupBy()
. For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.
Example: CpuUtilization[1m].sum()
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: 2019-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: 2019-02-01T02:02:29.600Z
public String getResolution()
The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. 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
(also 1h
).
Example: 5m
Copyright © 2016–2019. All rights reserved.