RequestSummarizedMetricDataDetails¶
- class oci.oci_control_center.models.RequestSummarizedMetricDataDetails(**kwargs)¶
Bases:
objectThe request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.
Methods:
__init__(**kwargs)Initializes a new RequestSummarizedMetricDataDetails object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this RequestSummarizedMetricDataDetails.
Gets the dimensions of this RequestSummarizedMetricDataDetails.
Gets the end_time of this RequestSummarizedMetricDataDetails.
[Required] Gets the metric_name of this RequestSummarizedMetricDataDetails.
[Required] Gets the namespace_name of this RequestSummarizedMetricDataDetails.
Gets the start_time of this RequestSummarizedMetricDataDetails.
- __init__(**kwargs)¶
Initializes a new RequestSummarizedMetricDataDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
namespace_name (str) – The value to assign to the namespace_name property of this RequestSummarizedMetricDataDetails.
metric_name (str) – The value to assign to the metric_name property of this RequestSummarizedMetricDataDetails.
compartment_id (str) – The value to assign to the compartment_id property of this RequestSummarizedMetricDataDetails.
dimensions (dict(str, DimensionValue)) – The value to assign to the dimensions property of this RequestSummarizedMetricDataDetails.
start_time (datetime) – The value to assign to the start_time property of this RequestSummarizedMetricDataDetails.
end_time (datetime) – The value to assign to the end_time property of this RequestSummarizedMetricDataDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this RequestSummarizedMetricDataDetails. The OCID of the compartment to use for authorization to read metrics. To use the root compartment, provide the tenancyId.
- Returns
The compartment_id of this RequestSummarizedMetricDataDetails.
- Return type
str
- property dimensions¶
Gets the dimensions of this RequestSummarizedMetricDataDetails. Qualifiers to use when searching for metric data. For a list of valid dimensions for a given metric, see
list_metric_properties().- Returns
The dimensions of this RequestSummarizedMetricDataDetails.
- Return type
dict(str, DimensionValue)
- property end_time¶
Gets the end_time of this RequestSummarizedMetricDataDetails. The end of the sampled time range to use when searching for metric data points. Format is defined by <a href=”https://www.rfc-editor.org/rfc/rfc3339”>RFC3339</a>. The response excludes metric data points for sampled time. Example 2019-02-01T02:02:29.600Z
- Returns
The end_time of this RequestSummarizedMetricDataDetails.
- Return type
datetime
- property metric_name¶
[Required] Gets the metric_name of this RequestSummarizedMetricDataDetails. The name of a metric for retrieving aggregated data. For a list of valid metrics for a given namespace, see
list_metric_properties().- Returns
The metric_name of this RequestSummarizedMetricDataDetails.
- Return type
str
- property namespace_name¶
[Required] Gets the namespace_name of this RequestSummarizedMetricDataDetails. The source service or application to use when searching for metric data points to aggregate. For a list of valid namespaces, see
list_namespaces().- Returns
The namespace_name of this RequestSummarizedMetricDataDetails.
- Return type
str
- property start_time¶
Gets the start_time of this RequestSummarizedMetricDataDetails. The beginning of the sampled time range to use when searching for metric data points. Format is defined by <a href=”https://www.rfc-editor.org/rfc/rfc3339”>RFC3339</a>. The response includes metric data points for the sampled time. Example 2019-02-01T02:02:29.600Z
- Returns
The start_time of this RequestSummarizedMetricDataDetails.
- Return type
datetime