com.oracle.bmc.monitoring.model

Class SummarizeMetricsDataDetails.Builder

java.lang.Object

com.oracle.bmc.monitoring.model.SummarizeMetricsDataDetails.Builder

Enclosing class:

SummarizeMetricsDataDetails

public static class SummarizeMetricsDataDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SummarizeMetricsDataDetails	build()
SummarizeMetricsDataDetails.Builder	copy(SummarizeMetricsDataDetails model)
SummarizeMetricsDataDetails.Builder	endTime(Date endTime) The end of the time range to use when searching for metric data points.
SummarizeMetricsDataDetails.Builder	namespace(String namespace) The source service or application to use when searching for metric data points to aggregate.
SummarizeMetricsDataDetails.Builder	query(String query) The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate.
SummarizeMetricsDataDetails.Builder	resolution(String resolution) The time between calculated aggregation windows.
SummarizeMetricsDataDetails.Builder	resourceGroup(String resourceGroup) Resource group that you want to match.
SummarizeMetricsDataDetails.Builder	startTime(Date startTime) The beginning of the time range to use when searching for metric data points.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

namespace

public SummarizeMetricsDataDetails.Builder namespace(String namespace)

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

Example: oci_computeagent

Parameters:

namespace - the value to set

Returns:

this builder

resourceGroup

public SummarizeMetricsDataDetails.Builder resourceGroup(String resourceGroup)

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

Parameters:

resourceGroup - the value to set

Returns:

this builder

query

public SummarizeMetricsDataDetails.Builder query(String query)

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>&lt;instance_OCID&gt;</var>\\"}.max()

Parameters:

query - the value to set

Returns:

this builder

startTime

public SummarizeMetricsDataDetails.Builder startTime(Date startTime)

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

Parameters:

startTime - the value to set

Returns:

this builder

endTime

public SummarizeMetricsDataDetails.Builder endTime(Date endTime)

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

Parameters:

endTime - the value to set

Returns:

this builder

resolution

public SummarizeMetricsDataDetails.Builder resolution(String resolution)

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

Parameters:

resolution - the value to set

Returns:

this builder

build

public SummarizeMetricsDataDetails build()

copy

public SummarizeMetricsDataDetails.Builder copy(SummarizeMetricsDataDetails model)