15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
3.4 KiB
vim.PerformanceManager.QuerySpec
- This data object specifies the query parameters, including the managed object reference to the target entity for statistics retrieval.
- If the optional
- intervalId
- is omitted, the metrics are returned in their originally sampled interval.
- When an
- intervalId
- is specified, the server tries to summarize the information for the specified
- intervalId
- . However, if that interval does not exist or has no data, the server summarizes the information using the best interval available.
- If the range between
- startTime
- and
- endTime
- crosses multiple sample interval periods, the result contains data from the longest interval in the period.
- extends
- Attributes:
-
entity (vmodl.ManagedObject):
The managed object whose performance statistics are being queried.
startTime (datetime, optional):
The server time from which to obtain counters. If not specified, defaults to the first available counter. When a startTime is specified, the returned samples do not include the sample at startTime.
endTime (datetime, optional):
The time up to which statistics are retrieved. Corresponds to server time. When endTime is omitted, the returned result includes up to the most recent metric value. When an endTime is specified, the returned samples include the sample at endTime.
maxSample (int, optional):
Limits the number of samples returned. Defaults to the most recent sample (or samples), unless a time range is specified. Use this property only in conjunction with the intervalId to obtain real-time statistics (set the intervalId to the refreshRate . This property is ignored for historical statistics, and is not valid for the QueryPerfComposite operation.
metricId (vim.PerformanceManager.MetricId, optional):
The performance metrics to be retrieved. This property is required for the QueryPerfComposite operation.
intervalId (int, optional):
- The interval ( samplingPeriod ), in seconds, for the performance statisticsFor aggregated information, use one of the historical intervals for this property. See PerfInterval for more information.
-
- To obtain the greatest detail, use the provider
- s
- refreshRate
- for this property.
format (str, optional):
The format to be used while returning the statisticsSee PerfFormat