Class FoldersResource.TimeSeriesResource.ListRequest

Lists time series that match a filter.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListTimeSeriesResponse>
MonitoringBaseServiceRequest<ListTimeSeriesResponse>
FoldersResource.TimeSeriesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Monitoring.v3
Assembly: Google.Apis.Monitoring.v3.dll
Syntax
public class FoldersResource.TimeSeriesResource.ListRequest : MonitoringBaseServiceRequest<ListTimeSeriesResponse>, IClientServiceRequest<ListTimeSeriesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string name)
Parameters
Type Name Description
IClientService service
string name

Properties

AggregationAlignmentPeriod

The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.

Declaration
[RequestParameter("aggregation.alignmentPeriod", RequestParameterType.Query)]
public virtual object AggregationAlignmentPeriod { get; set; }
Property Value
Type Description
object

AggregationCrossSeriesReducer

The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.

Declaration
[RequestParameter("aggregation.crossSeriesReducer", RequestParameterType.Query)]
public virtual FoldersResource.TimeSeriesResource.ListRequest.AggregationCrossSeriesReducerEnum? AggregationCrossSeriesReducer { get; set; }
Property Value
Type Description
FoldersResource.TimeSeriesResource.ListRequest.AggregationCrossSeriesReducerEnum?

AggregationGroupByFields

The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.

Declaration
[RequestParameter("aggregation.groupByFields", RequestParameterType.Query)]
public virtual Repeatable<string> AggregationGroupByFields { get; set; }
Property Value
Type Description
Repeatable<string>

AggregationPerSeriesAligner

An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.

Declaration
[RequestParameter("aggregation.perSeriesAligner", RequestParameterType.Query)]
public virtual FoldersResource.TimeSeriesResource.ListRequest.AggregationPerSeriesAlignerEnum? AggregationPerSeriesAligner { get; set; }
Property Value
Type Description
FoldersResource.TimeSeriesResource.ListRequest.AggregationPerSeriesAlignerEnum?

Filter

Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

IntervalEndTime

object representation of IntervalEndTimeRaw.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use IntervalEndTimeDateTimeOffset instead.")]
public virtual object IntervalEndTime { get; set; }
Property Value
Type Description
object

IntervalEndTimeDateTimeOffset

Declaration
public virtual DateTimeOffset? IntervalEndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

IntervalEndTimeRaw

String representation of IntervalEndTimeDateTimeOffset, formatted for inclusion in the HTTP request.

Declaration
[RequestParameter("interval.endTime", RequestParameterType.Query)]
public virtual string IntervalEndTimeRaw { get; }
Property Value
Type Description
string

IntervalStartTime

object representation of IntervalStartTimeRaw.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use IntervalStartTimeDateTimeOffset instead.")]
public virtual object IntervalStartTime { get; set; }
Property Value
Type Description
object

IntervalStartTimeDateTimeOffset

Declaration
public virtual DateTimeOffset? IntervalStartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

IntervalStartTimeRaw

String representation of IntervalStartTimeDateTimeOffset, formatted for inclusion in the HTTP request.

Declaration
[RequestParameter("interval.startTime", RequestParameterType.Query)]
public virtual string IntervalStartTimeRaw { get; }
Property Value
Type Description
string

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

OrderBy

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SecondaryAggregationAlignmentPeriod

The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.

Declaration
[RequestParameter("secondaryAggregation.alignmentPeriod", RequestParameterType.Query)]
public virtual object SecondaryAggregationAlignmentPeriod { get; set; }
Property Value
Type Description
object

SecondaryAggregationCrossSeriesReducer

The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.

Declaration
[RequestParameter("secondaryAggregation.crossSeriesReducer", RequestParameterType.Query)]
public virtual FoldersResource.TimeSeriesResource.ListRequest.SecondaryAggregationCrossSeriesReducerEnum? SecondaryAggregationCrossSeriesReducer { get; set; }
Property Value
Type Description
FoldersResource.TimeSeriesResource.ListRequest.SecondaryAggregationCrossSeriesReducerEnum?

SecondaryAggregationGroupByFields

The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.

Declaration
[RequestParameter("secondaryAggregation.groupByFields", RequestParameterType.Query)]
public virtual Repeatable<string> SecondaryAggregationGroupByFields { get; set; }
Property Value
Type Description
Repeatable<string>

SecondaryAggregationPerSeriesAligner

An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.

Declaration
[RequestParameter("secondaryAggregation.perSeriesAligner", RequestParameterType.Query)]
public virtual FoldersResource.TimeSeriesResource.ListRequest.SecondaryAggregationPerSeriesAlignerEnum? SecondaryAggregationPerSeriesAligner { get; set; }
Property Value
Type Description
FoldersResource.TimeSeriesResource.ListRequest.SecondaryAggregationPerSeriesAlignerEnum?

View

Required. Specifies which information is returned about the time series.

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual FoldersResource.TimeSeriesResource.ListRequest.ViewEnum? View { get; set; }
Property Value
Type Description
FoldersResource.TimeSeriesResource.ListRequest.ViewEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements