Service: Monitoring (ntt.monitoring.v3 - v3)

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". NOTE: currently only "monitoredResourceDescriptors/{type}" form is supported.

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

Optional. A detailed description of the monitored resource type that might be used in documentation.

Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

Promoted Label Key Sets allow defining multiple indexing rules for underlying backend enabling query optimizations. Metric promoted label sets are combined with MonitoredResource promoted label sets and result in PromotedKeySet.

Optional parent ntt.monitoring.v3.MonitoredResourceDescriptor

Names of MonitoredResourceDescriptors

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

found MonitoredResourceDescriptors

list of not found MonitoredResourceDescriptors

Reference to ntt.monitoring.v3.MonitoredResourceDescriptor

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

Requested page size. Server may return fewer MonitoredResourceDescriptors than requested. If unspecified, server will pick an appropriate default.

A token identifying a page of results the server should return.

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to MonitoredResourceDescriptor that don't affect any of masked fields won't be sent back.

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to MonitoredResourceDescriptor that don't affect any of masked fields won't be sent back.

Changes of MonitoredResourceDescriptors

When present, PageTokens used for page navigation should be updated.

New token to retrieve previous page of results.

New token to retrieve next page of results.

MonitoredResourceDescriptor resource body

MonitoredResourceDescriptor resource body

FieldMask applied to request - change will be applied only for fields in the mask

Reference of ntt.monitoring.v3.MonitoredResourceDescriptor

The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database.

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:

 resource.type = starts_with("gce_") AND resource.label:id

A positive number that is the maximum number of results to return.

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.

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

The monitored resource descriptors that are available to this project and that match filter, if present.

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

Name of Project

Reference of ntt.monitoring.v3.Project

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

Optional parent ntt.monitoring.v3.Project

Names of Projects

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

found Projects

list of not found Projects

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

A token identifying a page of results the server should return. Typically, this is the value of [ListProjectsResponse.next_page_token][ntt.monitoring.v3.ListProjectsResponse.next_page_token]

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

The list of Projects

A token to retrieve previous page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.monitoring.v3.ListProjectsRequest.page_token]

A token to retrieve next page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.monitoring.v3.ListProjectsRequest.page_token]

Reference to ntt.monitoring.v3.Project

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

A token identifying a page of results the server should return.

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Project that don't affect any of masked fields won't be sent back.

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Project that don't affect any of masked fields won't be sent back.

Changes of Projects

When present, PageTokens used for page navigation should be updated.

New token to retrieve previous page of results.

New token to retrieve next page of results.

Project resource body

Project resource body

FieldMask applied to request - change will be applied only for fields in the mask

Reference of ntt.monitoring.v3.Project

The resource name of the metric descriptor.

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example:

 "custom.googleapis.com/invoice/paid/amount"
 "external.googleapis.com/prometheus/up"
 "appengine.googleapis.com/http/server/response_latencies"

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure standard:

Basic units (UNIT)

• bit bit
• By byte
• s second
• min minute
• h hour
• d day

Prefixes (PREFIX)

• k kilo (10**3)
• M mega (10**6)
• G giga (10**9)
• T tera (10**12)
• P peta (10**15)
• E exa (10**18)
• Z zetta (10**21)
• Y yotta (10**24)
• m milli (10**-3)
• u micro (10**-6)
• n nano (10**-9)
• p pico (10**-12)
• f femto (10**-15)
• a atto (10**-18)
• z zepto (10**-21)
• y yocto (10**-24)
• Ki kibi (2**10)
• Mi mebi (2**20)
• Gi gibi (2**30)
• Ti tebi (2**40)

Grammar

The grammar also includes these connectors:

• / division (as an infix operator, e.g. 1/s).
• . multiplication (as an infix operator, e.g. GBy.d)

The grammar for a unit is as follows:

 Expression = Component { "." Component } { "/" Component } ;

 Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
           | Annotation
           | "1"
           ;

 Annotation = "{" NAME "}" ;

Notes:

• Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.
• NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
• 1 represents dimensionless value 1, such as in 1/s.
• % represents dimensionless value 1/100, and annotates values giving a percentage.

A detailed description of the metric, which can be used in documentation.

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

Optional. Metadata which can be used to guide usage of the metric.

Distribution bucketing options - define only when ValueType is Distribution. Used for validating input.

Promoted Label Key Sets allow defining multiple indexing rules for underlying backend enabling query optimizations. Metric promoted label sets are combined with MonitoredResource promoted label sets and result in PromotedKeySet.

The launch stage of the metric definition.

Optional parent ntt.monitoring.v3.MetricDescriptor

Names of MetricDescriptors

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

found MetricDescriptors

list of not found MetricDescriptors

Reference to ntt.monitoring.v3.MetricDescriptor

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

Parent reference of ntt.monitoring.v3.MetricDescriptor

Requested page size. Server may return fewer MetricDescriptors than requested. If unspecified, server will pick an appropriate default.

A token identifying a page of results the server should return.

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to MetricDescriptor that don't affect any of masked fields won't be sent back.

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to MetricDescriptor that don't affect any of masked fields won't be sent back.

Changes of MetricDescriptors

When present, PageTokens used for page navigation should be updated.

New token to retrieve previous page of results.

New token to retrieve next page of results.

MetricDescriptor resource body

FieldMask applied to request - change will be applied only for fields in the mask

The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count".

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

The project on which to execute the request. The format is "projects/{project_id_or_number}". TODO: enable when multi-parents are supported

The new custom metric descriptor.

The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric".

The project on which to execute the request. The format is "projects/{project_id_or_number}". TODO: enable when multi-parents are supported

If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:

 metric.type = starts_with("custom.googleapis.com/")

A positive number that is the maximum number of results to return.

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.

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

The metric descriptors that are available to the project and that match the value of filter, if present.

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

Do not use this default value.

An instantaneous measurement of a value.

The change in a value during a time interval.

A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

Do not use this default value.

The value is a boolean. This value type can be used only if the metric kind is GAUGE.

The value is a signed 64-bit integer.

The value is a double precision floating point number.

The value is a text string. This value type can be used only if the metric kind is GAUGE.

The value is a [Distribution][google.api.Distribution].

The value is money.

TimeSerie key identifies unique TimeSeries tuple: <project, metric.type, metric.labels, resource.type, resource.labels>

Kind/ValueType are not present in key Key is not to be decoded outside of service, but treated as opaque string

Internal use - for bulk reporting of TimeSeries

The associated metric. A fully-specified metric used to identify the time series.

The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.

Output only. The associated monitored resource metadata. When reading a a timeseries, this field will include metadata labels that are explicitly named in the reduction. When creating a timeseries, this field is ignored.

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.

The data points of this time series. When listing time series, points are returned in reverse time order.

When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

The project on which to execute the request. The format is "projects/{project_id_or_number}".

A monitoring filter 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.label.instance_name = "my-instance-name"

The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

Unsupported: must be left blank. The points in each time series are returned in reverse time order.

Specifies which information is returned about the time series.

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.

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.

One or more time series that match the filter included in the request.

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.

Query execution errors that may have caused the time series data returned to be incomplete.

The project on which to execute the request. The format is "projects/{project_id_or_number}".

The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

Time Serie keys indexed by Create position - present only when given TimeSerie didn't use Key field

Common resource Metadata

Name of PhantomTimeSeries

TimeSerie key identifies unique TimeSeries tuple: <project, metric.type, metric.labels, resource.type, resource.labels>

Kind/ValueType are not present in key Key is not to be decoded outside of service, but treated as opaque string

Internal use - for bulk reporting of TimeSeries

The associated metric. A fully-specified metric used to identify the time series.

The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.

When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.

Phantom value

Reference of ntt.monitoring.v3.PhantomTimeSerie

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

Optional parent ntt.monitoring.v3.PhantomTimeSerie

Names of PhantomTimeSeries

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

found PhantomTimeSeries

list of not found PhantomTimeSeries

Parent name of ntt.monitoring.v3.PhantomTimeSerie

Requested page size. Server may return fewer PhantomTimeSeries than requested. If unspecified, server will pick an appropriate default.

A token identifying a page of results the server should return. Typically, this is the value of [ListPhantomTimeSeriesResponse.next_page_token][ntt.monitoring.v3.ListPhantomTimeSeriesResponse.next_page_token]

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

If true, server will skip checking if query result is present in it's cache

The list of PhantomTimeSeries

A token to retrieve previous page of results. Pass this value in the [ListPhantomTimeSeriesRequest.page_token][ntt.monitoring.v3.ListPhantomTimeSeriesRequest.page_token]

A token to retrieve next page of results. Pass this value in the [ListPhantomTimeSeriesRequest.page_token][ntt.monitoring.v3.ListPhantomTimeSeriesRequest.page_token]

Reference to ntt.monitoring.v3.PhantomTimeSerie

A list of extra fields to be obtained for each response item on top of fields defined by request field view

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

Parent reference of ntt.monitoring.v3.PhantomTimeSerie

Requested page size. Server may return fewer PhantomTimeSeries than requested. If unspecified, server will pick an appropriate default.

A token identifying a page of results the server should return.

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to PhantomTimeSerie that don't affect any of masked fields won't be sent back.

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to PhantomTimeSerie that don't affect any of masked fields won't be sent back.

Changes of PhantomTimeSeries

When present, PageTokens used for page navigation should be updated.

New token to retrieve previous page of results.

New token to retrieve next page of results.

Parent reference of ntt.monitoring.v3.PhantomTimeSerie

PhantomTimeSerie resource body

Reference of ntt.monitoring.v3.PhantomTimeSerie

The alignment period for per-[time series][ntt.monitoring.v3.TimeSeries] alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.

The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.

Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.

Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.

The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. 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 crossSeriesReducer 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 groupByFields are aggregated away. If groupByFields 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 crossSeriesReducer is not defined, this field is ignored.

The time series, including the Metric, MonitoredResource, and Points (including timestamp and value) that resulted in the error. This field provides all of the context that would be needed to retry the operation.

The status of the requested write operation.

The number of values in the population. Must be non-negative.

The arithmetic mean of the values in the population. If count is zero then this field must be zero.

The sum of squared deviations from the mean of the values in the population. For values x_i this is:

 Sum[i=1..n]((x_i - mean)^2)

Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.

If count is zero then this field must be zero.

If specified, contains the range of the population values. The field must not be present if the count is zero.

Defines the histogram bucket boundaries.

If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.

Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).

The size of bucket_counts must be no greater than N as defined in bucket_options.

Any suffix of trailing zero bucket_count fields may be omitted.

The linear bucket.

The exponential buckets.

The explicit buckets.

The values must be monotonically increasing.

Must be greater than 0.

Must be greater than 1.

Must be greater than 0.

Must be greater than 0.

Must be greater than 0.

Lower bound of the first bucket.

The minimum of the population values.

The maximum of the population values.

The label key.

The type of data that can be assigned to the label.

A human-readable description for the label.

Default value for string label - this value is used in two cases:

1. to populate missing labels while creating TimeSeries
2. to populate missing remaining kvs while querying TimeSeries - usually applies to old data

if set, index will not be considered for queries, but will be written to. useful for transition periods.

An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor]. For example, custom.googleapis.com/invoice/paid/amount.

The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.

reduced labels in aggregations

Added is returned when watched document is added, either created or enters Query view

Modified is returned when watched document is modified

Removed is returned when MetricDescriptor is deleted or leaves Query view

Integer describing index of added MetricDescriptor in resulting query view.

Name of modified MetricDescriptor

New version of MetricDescriptor or masked difference, depending on mask_changes instrumentation of issued [WatchMetricDescriptorRequest] or [WatchMetricDescriptorsRequest]

Used when mask_changes is set, contains field paths of modified properties.

Previous view index specifies previous position of modified MetricDescriptor. When modification doesn't affect sorted order, value will remain identical to [view_index].

Integer specifying MetricDescriptor new index in resulting query view.

Integer specifying removed MetricDescriptor index.

Required. The monitored resource type. This field must match the type field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Compute Engine VM instance is gce_instance.

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".

reduced labels in aggregations

Added is returned when watched document is added, either created or enters Query view

Modified is returned when watched document is modified

Removed is returned when MonitoredResourceDescriptor is deleted or leaves Query view

Integer describing index of added MonitoredResourceDescriptor in resulting query view.

Name of modified MonitoredResourceDescriptor

New version of MonitoredResourceDescriptor or masked difference, depending on mask_changes instrumentation of issued [WatchMonitoredResourceDescriptorRequest] or [WatchMonitoredResourceDescriptorsRequest]

Used when mask_changes is set, contains field paths of modified properties.

Previous view index specifies previous position of modified MonitoredResourceDescriptor. When modification doesn't affect sorted order, value will remain identical to [view_index].

Integer specifying MonitoredResourceDescriptor new index in resulting query view.

Integer specifying removed MonitoredResourceDescriptor index.

Output only. A map of user-defined metadata labels.

Added is returned when watched document is added, either created or enters Query view

Modified is returned when watched document is modified

Removed is returned when PhantomTimeSerie is deleted or leaves Query view

Integer describing index of added PhantomTimeSerie in resulting query view.

Name of modified PhantomTimeSerie

New version of PhantomTimeSerie or masked difference, depending on mask_changes instrumentation of issued [WatchPhantomTimeSerieRequest] or [WatchPhantomTimeSeriesRequest]

Used when mask_changes is set, contains field paths of modified properties.

Previous view index specifies previous position of modified PhantomTimeSerie. When modification doesn't affect sorted order, value will remain identical to [view_index].

Integer specifying PhantomTimeSerie new index in resulting query view.

Integer specifying removed PhantomTimeSerie index.

add partitioning information (e.g. project, hash key to invalidate whole group upon resync)

partition identifier (e.g. project, key_hash)

The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

The value of the data point.

Additional aggregation info Used internally for batching rollup points

Added is returned when watched document is added, either created or enters Query view

Modified is returned when watched document is modified

Removed is returned when Project is deleted or leaves Query view

Integer describing index of added Project in resulting query view.

Name of modified Project

New version of Project or masked difference, depending on mask_changes instrumentation of issued [WatchProjectRequest] or [WatchProjectsRequest]

Used when mask_changes is set, contains field paths of modified properties.

Previous view index specifies previous position of modified Project. When modification doesn't affect sorted order, value will remain identical to [view_index].

Integer specifying Project new index in resulting query view.

Integer specifying removed Project index.

Required. The end of the time interval.

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

A Boolean value: true or false.

A 64-bit integer. Its range is approximately ±9.2x10¹⁸.

A 64-bit double-precision floating-point number. Its magnitude is approximately ±10^±300 and it has 16 significant digits of precision.

A variable-length string value.

A distribution value.

No alignment. Raw data is returned. Not valid if cross-time series reduction is requested. The value type of the result is the same as the value type of the input.

Align and convert to delta metric type. This alignment is valid for cumulative metrics and delta metrics. Aligning an existing delta metric to a delta metric requires that the alignment period be increased. The value type of the result is the same as the value type of the input.

One can think of this aligner as a rate but without time units; that is, the output is conceptually (second_point - first_point).

Align and convert to a rate. This alignment is valid for cumulative metrics and delta metrics with numeric values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

One can think of this aligner as conceptually providing the slope of the line that passes through the value at the start and end of the window. In other words, this is conceptually ((y1 - y0)/(t1 - t0)), and the output unit is one that has a "/time" dimension.

If, by rate, you are looking for percentage change, see the ALIGN_PERCENT_CHANGE aligner option.

Align by interpolating between adjacent points around the period boundary. This alignment is valid for gauge metrics with numeric values. The value type of the result is the same as the value type of the input.

Align by shifting the oldest data point before the period boundary to the boundary. This alignment is valid for gauge metrics. The value type of the result is the same as the value type of the input.

Align time series via aggregation. The resulting data point in the alignment period is the minimum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the result is the same as the value type of the input.

Align time series via aggregation. The resulting data point in the alignment period is the maximum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the result is the same as the value type of the input.

Align time series via aggregation. The resulting data point in the alignment period is the average or arithmetic mean of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Align time series via aggregation. The resulting data point in the alignment period is the count of all data points in the period. This alignment is valid for gauge and delta metrics with numeric or Boolean values. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

Align time series via aggregation. The resulting data point in the alignment period is the sum of all data points in the period. This alignment is valid for gauge and delta metrics with numeric and distribution values. The value type of the output is the same as the value type of the input.

Align time series via aggregation. The resulting data point in the alignment period is the standard deviation of all data points in the period. This alignment is valid for gauge and delta metrics with numeric values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Align time series via aggregation. The resulting data point in the alignment period is the count of True-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

Align time series via aggregation. The resulting data point in the alignment period is the count of False-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

Align time series via aggregation. The resulting data point in the alignment period is the fraction of True-valued data points in the period. This alignment is valid for gauge metrics with Boolean values. The output value is in the range [0, 1] and has value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Align time series via aggregation. The resulting data point in the alignment period is the 99th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Align time series via aggregation. The resulting data point in the alignment period is the 95th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Align time series via aggregation. The resulting data point in the alignment period is the 50th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Align time series via aggregation. The resulting data point in the alignment period is the 5th percentile of all data points in the period. This alignment is valid for gauge and delta metrics with distribution values. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Align and convert to a percentage change. This alignment is valid for gauge and delta metrics with numeric values. This alignment conceptually computes the equivalent of "((current - previous)/previous)*100" where previous value is determined based on the alignmentPeriod. In the event that previous is 0 the calculated value is infinity with the exception that if both (current - previous) and previous are 0 the calculated value is 0. A 10 minute moving mean is computed at each point of the time window prior to the above calculation to smooth the metric and prevent false positives from very short lived spikes. Only applicable for data that is >= 0. Any values < 0 are treated as no data. While delta metrics are accepted by this alignment special care should be taken that the values for the metric will always be positive. The output is a gauge metric with value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

No cross-time series reduction. The output of the aligner is returned.

Reduce by computing the mean across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric or distribution values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Reduce by computing the minimum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric values. The value type of the output is the same as the value type of the input.

Reduce by computing the maximum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric values. The value type of the output is the same as the value type of the input.

Reduce by computing the sum across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric and distribution values. The value type of the output is the same as the value type of the input.

Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for delta and gauge metrics with numeric or distribution values. The value type of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Reduce by computing the count of data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of numeric, Boolean, distribution, and string value type. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

Reduce by computing the count of True-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

Reduce by computing the count of False-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The value type of the output is [INT64][google.api.MetricDescriptor.ValueType.INT64].

Reduce by computing the fraction of True-valued data points across time series for each alignment period. This reducer is valid for delta and gauge metrics of Boolean value type. The output value is in the range [0, 1] and has value type [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].

Reduce by computing 99th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

Reduce by computing 95th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

Reduce by computing 50th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

Reduce by computing 5th percentile of data points across time series for each alignment period. This reducer is valid for gauge and delta metrics of numeric and distribution type. The value of the output is [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE]

A variable-length string. This is the default.

Boolean; true or false.

A 64-bit signed integer.

Returns the identity of the metric(s), the time series, and the time series data.

Returns the identity of the metric and the time series resource, but not the time series data.