CloudMonitoringProviderGetDataPointsAsync Method |
This API is preliminary and subject to change.
Gets a collection of data points collected for a metric by the monitoring service.
Namespace: net.openstack.Providers.RackspaceAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax public Task<ReadOnlyCollection<DataPoint>> GetDataPointsAsync(
EntityId entityId,
CheckId checkId,
MetricName metricName,
Nullable<int> points,
DataPointGranularity resolution,
IEnumerable<DataPointStatistic> select,
DateTimeOffset from,
DateTimeOffset to,
CancellationToken cancellationToken
)
Public Function GetDataPointsAsync (
entityId As EntityId,
checkId As CheckId,
metricName As MetricName,
points As Nullable(Of Integer),
resolution As DataPointGranularity,
select As IEnumerable(Of DataPointStatistic),
from As DateTimeOffset,
to As DateTimeOffset,
cancellationToken As CancellationToken
) As Task(Of ReadOnlyCollection(Of DataPoint))
public:
virtual Task<ReadOnlyCollection<DataPoint^>^>^ GetDataPointsAsync(
EntityId^ entityId,
CheckId^ checkId,
MetricName^ metricName,
Nullable<int> points,
DataPointGranularity^ resolution,
IEnumerable<DataPointStatistic^>^ select,
DateTimeOffset from,
DateTimeOffset to,
CancellationToken cancellationToken
) sealed
abstract GetDataPointsAsync :
entityId : EntityId *
checkId : CheckId *
metricName : MetricName *
points : Nullable<int> *
resolution : DataPointGranularity *
select : IEnumerable<DataPointStatistic> *
from : DateTimeOffset *
to : DateTimeOffset *
cancellationToken : CancellationToken -> Task<ReadOnlyCollection<DataPoint>>
override GetDataPointsAsync :
entityId : EntityId *
checkId : CheckId *
metricName : MetricName *
points : Nullable<int> *
resolution : DataPointGranularity *
select : IEnumerable<DataPointStatistic> *
from : DateTimeOffset *
to : DateTimeOffset *
cancellationToken : CancellationToken -> Task<ReadOnlyCollection<DataPoint>>
Parameters
- entityId
- Type: net.openstack.Providers.Rackspace.Objects.MonitoringEntityId
The entity ID. This is obtained from Entity.Id. - checkId
- Type: net.openstack.Providers.Rackspace.Objects.MonitoringCheckId
The check ID. This is obtained from Check.Id. - metricName
- Type: net.openstack.Providers.Rackspace.Objects.MonitoringMetricName
The metric name. This is obtained from Metric.Name. - points
- Type: SystemNullableInt32
The number of data points to return. - resolution
- Type: net.openstack.Providers.Rackspace.Objects.MonitoringDataPointGranularity
The granularity of the returned data points. - select
- Type: System.Collections.GenericIEnumerableDataPointStatistic
A collection of DataPointStatistic objects identifying the statistics to compute for the data. - from
- Type: SystemDateTimeOffset
The beginning timestamp of the items to include in the collection. This parameter is used for time series collections. - to
- Type: SystemDateTimeOffset
The ending timestamp of the items to include in the collection. This parameter is used for time series collections. - cancellationToken
- Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.
Return Value
Type:
TaskReadOnlyCollectionDataPoint
A
Task object representing the asynchronous operation. When
the task completes successfully, the
Result
property will contain a collection of
DataPoint objects
describing the data points collected for the metric.
Implements
IMonitoringServiceGetDataPointsAsync(EntityId, CheckId, MetricName, NullableInt32, DataPointGranularity, IEnumerableDataPointStatistic, DateTimeOffset, DateTimeOffset, CancellationToken)Exceptions Exception | Condition |
---|
ArgumentNullException |
If entityId is .
-or- If checkId is . -or- If metricName is . |
ArgumentException |
If both points and resolution are .
-or- If to occurs before from. |
ArgumentOutOfRangeException |
If points is less than or equal to 0.
-or- If from represents a date before January 1, 1970 UTC. -or- If to represents a date before January 1, 1970 UTC. |
WebException | If the REST request does not return successfully. |
Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also