Package google.monitoring.v3

The frequency at which to send reminder notifications for open incidents.

NotificationPrompt

Control when notifications will be sent out.

Enums
`NOTIFICATION_PROMPT_UNSPECIFIED`	No strategy specified. Treated as error.
`OPENED`	Notify when an incident is opened.
`CLOSED`	Notify when an incident is closed.

NotificationRateLimit

Control over the rate of notifications sent to this alerting policy's notification channels.

Fields

period

Not more than one notification per period.

Condition

A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.

Fields
`name`	`string` Required if the condition exists. The unique resource name for this condition. Its format is: `projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]` `[CONDITION_ID]` is assigned by Cloud Monitoring when the condition is created as part of a new or updated alerting policy. When calling the `alertPolicies.create` method, do not include the `name` field in the conditions of the requested alerting policy. Cloud Monitoring creates the condition identifiers and includes them in the new policy. When calling the `alertPolicies.update` method to update a policy, including a condition `name` causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated. Best practice is to preserve `[CONDITION_ID]` if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.
`display_name`	`string` A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
Union field `condition`. Only one of the following condition types will be specified. `condition` can be only one of the following:
`condition_threshold`	`MetricThreshold` A condition that compares a time series against a threshold.
`condition_absent`	`MetricAbsence` A condition that checks that a time series continues to receive new data points.
`condition_matched_log`	`LogMatch` A condition that checks for log messages matching given constraints. If set, no other conditions can be present.
`condition_monitoring_query_language`	`MonitoringQueryLanguageCondition` A condition that uses the Monitoring Query Language to define alerts.
`condition_prometheus_query_language`	`PrometheusQueryLanguageCondition` A condition that uses the Prometheus query language to define alerts.
`condition_sql`	`SqlCondition` A condition that periodically evaluates a SQL query result.

EvaluationMissingData

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. This control doesn't affect metric-absence policies.

Enums
`EVALUATION_MISSING_DATA_UNSPECIFIED`	An unspecified evaluation missing data option. Equivalent to EVALUATION_MISSING_DATA_NO_OP.
`EVALUATION_MISSING_DATA_INACTIVE`	If there is no data to evaluate the condition, then evaluate the condition as false.
`EVALUATION_MISSING_DATA_ACTIVE`	If there is no data to evaluate the condition, then evaluate the condition as true.
`EVALUATION_MISSING_DATA_NO_OP`	Do not evaluate the condition to any value if there is no data.

LogMatch

A condition type that checks whether a log message in the scoping project satisfies the given filter. Logs from other projects in the metrics scope are not evaluated.

Fields

filter

string

Required. A logs-based filter. See Advanced Logs Queries for how this filter should be constructed.

label_extractors

map<string, string>

Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and corresponding values can be used in notifications generated by this condition.

Please see the documentation on logs-based metric valueExtractors for syntax and examples.

MetricAbsence

A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified duration.

Fields
`filter`	`string` Required. A filter that identifies which time series should be compared with the threshold. The filter is similar to the one that is specified in the `ListTimeSeries` request (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.
`aggregations[]`	`Aggregation` Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. This field is similar to the one in the `ListTimeSeries` request. It is advisable to use the `ListTimeSeries` method when debugging this field.
`duration`	`Duration` The amount of time that a time series must fail to report new data to be considered failing. The minimum value of this field is 120 seconds. Larger values that are a multiple of a minute--for example, 240 or 300 seconds--are supported. If an invalid value is given, an error will be returned. The `Duration.nanos` field is ignored.
`trigger`	`Trigger` The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by `filter` and `aggregations`.

MetricThreshold

A condition type that compares a collection of time series against a threshold.

Fields
`filter`	`string` Required. A filter that identifies which time series should be compared with the threshold. The filter is similar to the one that is specified in the `ListTimeSeries` request (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.
`aggregations[]`	`Aggregation` Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified. This field is similar to the one in the `ListTimeSeries` request. It is advisable to use the `ListTimeSeries` method when debugging this field.
`denominator_filter`	`string` A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a `denominator_filter` is specified, the time series specified by the `filter` field will be used as the numerator. The filter must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
`denominator_aggregations[]`	`Aggregation` Specifies the alignment of data points in individual time series selected by `denominatorFilter` as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). When computing ratios, the `aggregations` and `denominator_aggregations` fields must use the same alignment period and produce time series that have the same periodicity and labels.
`forecast_options`	`ForecastOptions` When this field is present, the `MetricThreshold` condition forecasts whether the time series is predicted to violate the threshold within the `forecast_horizon`. When this field is not set, the `MetricThreshold` tests the current value of the timeseries against the threshold.
`comparison`	`ComparisonType` The comparison to apply between the time series (indicated by `filter` and `aggregation`) and the threshold (indicated by `threshold_value`). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. Only `COMPARISON_LT` and `COMPARISON_GT` are supported currently.
`threshold_value`	`double` A value against which to compare the time series.
`duration`	`Duration` The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the `aggregations` field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
`trigger`	`Trigger` The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by `filter` and `aggregations`, or by the ratio, if `denominator_filter` and `denominator_aggregations` are specified.
`evaluation_missing_data`	`EvaluationMissingData` A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the `duration` field must be greater than or equal to 60 seconds.

ForecastOptions

Options used when forecasting the time series and testing the predicted value against the threshold.

Fields

forecast_horizon

Required. The length of time into the future to forecast whether a time series will violate the threshold. If the predicted value is found to violate the threshold, and the violation is observed in all forecasts made for the configured duration, then the time series is considered to be failing. The forecast horizon can range from 1 hour to 60 hours.

MonitoringQueryLanguageCondition

A condition type that allows alerting policies to be defined using Monitoring Query Language.

Fields
`query`	`string` Monitoring Query Language query that outputs a boolean stream.
`duration`	`Duration` The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the `aggregations` field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
`trigger`	`Trigger` The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by `filter` and `aggregations`, or by the ratio, if `denominator_filter` and `denominator_aggregations` are specified.
`evaluation_missing_data`	`EvaluationMissingData` A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.

PrometheusQueryLanguageCondition

A condition type that allows alerting policies to be defined using Prometheus Query Language (PromQL).

The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.

A Prometheus alerting rule is described here. The semantics of a Prometheus alerting rule is described here.

A Prometheus rule group is described here. The semantics of a Prometheus rule group is described here.

Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.

The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).

Fields
`query`	`string` Required. The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
`duration`	`Duration` Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. Must be a non-negative duration or missing. This field is optional. Its default value is zero.
`evaluation_interval`	`Duration` Optional. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. This field is optional. Its default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
`labels`	`map<string, string>` Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty.
`rule_group`	`string` Optional. The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional. If this field is not empty, then it must contain a valid UTF-8 string. This field may not exceed 2048 Unicode characters in length.
`alert_rule`	`string` Optional. The alerting rule name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional. If this field is not empty, then it must be a valid Prometheus label name. This field may not exceed 2048 Unicode characters in length.

SqlCondition

A condition that allows alerting policies to be defined using GoogleSQL. SQL conditions examine a sliding window of logs using GoogleSQL. Alert policies with SQL conditions may incur additional billing.

Fields
`query`	`string` Required. The Log Analytics SQL query to run, as a string. The query must conform to the required shape. Specifically, the query must not try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run. For example, the following query extracts all log entries containing an HTTP request: SELECT timestamp, log_name, severity, http_request, resource, labels FROM my-project.global._Default._AllLogs WHERE http_request IS NOT NULL
Union field `schedule`. The schedule indicates how often the query should be run. `schedule` can be only one of the following:
`minutes`	`Minutes` Schedule the query to execute every so many minutes.
`hourly`	`Hourly` Schedule the query to execute every so many hours.
`daily`	`Daily` Schedule the query to execute every so many days.
Union field `evaluate`. The test to be run against the SQL result set. `evaluate` can be only one of the following:
`row_count_test`	`RowCountTest` Test the row count against a threshold.
`boolean_test`	`BooleanTest` Test the boolean value in the indicated column.

BooleanTest

A test that uses an alerting result in a boolean column produced by the SQL query.

Fields

column

string

Required. The name of the column containing the boolean value. If the value in a row is NULL, that row is ignored.

Daily

Used to schedule the query to run every so many days.

Fields

periodicity

int32

Required. The number of days between runs. Must be greater than or equal to 1 day and less than or equal to 31 days.

execution_time

TimeOfDay

Optional. The time of day (in UTC) at which the query should run. If left unspecified, the server picks an arbitrary time of day and runs the query at the same time each day.

Hourly

Used to schedule the query to run every so many hours.

Fields

periodicity

int32

Required. The number of hours between runs. Must be greater than or equal to 1 hour and less than or equal to 48 hours.

minute_offset

int32

Optional. The number of minutes after the hour (in UTC) to run the query. Must be greater than or equal to 0 minutes and less than or equal to 59 minutes. If left unspecified, then an arbitrary offset is used.

Minutes

Used to schedule the query to run every so many minutes.

Fields

periodicity

int32

Required. Number of minutes between runs. The interval must be greater than or equal to 5 minutes and less than or equal to 1440 minutes.

RowCountTest

A test that checks if the number of rows in the result set violates some threshold.

Fields

comparison

ComparisonType

Required. The comparison to apply between the number of rows returned by the query and the threshold.

threshold

int64

Required. The value against which to compare the row count.

Trigger

Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a {count: 1} trigger is used.

Fields

Union field type. A type of trigger. type can be only one of the following:

count

int32

The absolute number of time series that must fail the predicate for the condition to be triggered.

percent

double

The percentage of time series that must fail the predicate for the condition to be triggered.

ConditionCombinerType

Operators for combining conditions.

Enums
`COMBINE_UNSPECIFIED`	An unspecified combiner.
`AND`	Combine conditions using the logical `AND` operator. An incident is created only if all the conditions are met simultaneously. This combiner is satisfied if all conditions are met, even if they are met on completely different resources.
`OR`	Combine conditions using the logical `OR` operator. An incident is created if any of the listed conditions is met.
`AND_WITH_MATCHING_RESOURCE`	Combine conditions using logical `AND` operator, but unlike the regular `AND` option, an incident is created only if all conditions are met simultaneously on at least one resource.

Documentation

Documentation that is included in the notifications and incidents pertaining to this policy.

Fields
`content`	`string` The body of the documentation, interpreted according to `mime_type`. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables.
`mime_type`	`string` The format of the `content` field. Presently, only the value `"text/markdown"` is supported. See Markdown for more information.
`subject`	`string` Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread. It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255). The contents of the subject line can be templatized by using variables. If this field is missing or empty, a default subject line will be generated.
`links[]`	`Link` Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.

Link

Links to content such as playbooks, repositories, and other resources.

Fields

display_name

string

A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".

url

string

The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name}"

Severity

An enumeration of possible severity level for an alerting policy.

Enums
`SEVERITY_UNSPECIFIED`	No severity is specified. This is the default value.
`CRITICAL`	This is the highest severity level. Use this if the problem could cause significant damage or downtime.
`ERROR`	This is the medium severity level. Use this if the problem could cause minor damage or downtime.
`WARNING`	This is the lowest severity level. Use this if the problem is not causing any damage or downtime, but could potentially lead to a problem in the future.

BasicSli

An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the service_resource determines the metrics to use and the service_resource.labels and metric_labels are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.

Fields
`method[]`	`string` OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.
`location[]`	`string` OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.
`version[]`	`string` OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.
Union field `sli_criteria`. This SLI can be evaluated on the basis of availability or latency. `sli_criteria` can be only one of the following:
`availability`	`AvailabilityCriteria` Good service is defined to be the count of requests made to this service that return successfully.
`latency`	`LatencyCriteria` Good service is defined to be the count of requests made to this service that are fast enough with respect to `latency.threshold`.

AvailabilityCriteria

This type has no fields.

Future parameters for the availability SLI.

LatencyCriteria

Parameters for a latency threshold SLI.

Fields

threshold

Good service is defined to be the count of requests made to this service that return in no more than threshold.

ComparisonType

Specifies an ordering relationship on two arguments, called left and right.

Enums
`COMPARISON_UNSPECIFIED`	No ordering relationship is specified.
`COMPARISON_GT`	True if the left argument is greater than the right argument.
`COMPARISON_GE`	True if the left argument is greater than or equal to the right argument.
`COMPARISON_LT`	True if the left argument is less than the right argument.
`COMPARISON_LE`	True if the left argument is less than or equal to the right argument.
`COMPARISON_EQ`	True if the left argument is equal to the right argument.
`COMPARISON_NE`	True if the left argument is not equal to the right argument.

CreateAlertPolicyRequest

The protocol for the CreateAlertPolicy request.

Fields

name

string

Required. The project in which to create the alerting policy. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.

Authorization requires the following IAM permission on the specified resource name:

monitoring.alertPolicies.create

alert_policy

AlertPolicy

Required. The requested alerting policy. You should omit the name field in this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID] value.

CreateGroupRequest

The CreateGroup request.

Fields

name

string

Required. The project in which to create the group. The format is:

projects/[PROJECT_ID_OR_NUMBER]

group

Group

Required. A group definition. It is an error to define the name field because the system assigns the name.

validate_only

bool

If true, validate this request but do not create the group.

CreateMetricDescriptorRequest

The CreateMetricDescriptor request.

Fields

name

string

Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER]

metric_descriptor

MetricDescriptor

Required. The new custom metric descriptor.

CreateNotificationChannelRequest

The CreateNotificationChannel request.

Fields

name

string

Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.

Authorization requires the following IAM permission on the specified resource name:

monitoring.notificationChannels.create

notification_channel

NotificationChannel

Required. The definition of the NotificationChannel to create.

CreateServiceLevelObjectiveRequest

The CreateServiceLevelObjective request.

Fields

parent

string

Required. Resource name of the parent Service. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

service_level_objective_id

string

Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern ^[a-zA-Z0-9-_:.]+$

service_level_objective

ServiceLevelObjective

Required. The ServiceLevelObjective to create. The provided name will be respected if no ServiceLevelObjective exists with this name.

CreateServiceRequest

The CreateService request.

Fields

parent

string

Required. Resource name of the parent Metrics Scope. The format is:

projects/[PROJECT_ID_OR_NUMBER]

service_id

string

Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+

service

Service

Required. The Service to create.

CreateSnoozeRequest

The message definition for creating a Snooze. Users must provide the body of the Snooze to be created but must omit the Snooze field, name.

Fields

parent

string

Required. The project in which a Snooze should be created. The format is:

projects/[PROJECT_ID_OR_NUMBER]

snooze

Snooze

Required. The Snooze to create. Omit the name field, as it will be filled in by the API.

CreateTimeSeriesError

DEPRECATED. Used to hold per-time-series error status.

Fields

time_series
(deprecated)

TimeSeries

DEPRECATED. Time series ID that resulted in the status error.

status
(deprecated)

Status

DEPRECATED. The status of the requested write operation for time_series.

CreateTimeSeriesRequest

The CreateTimeSeries request.

Fields

name

string

Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

time_series[]

TimeSeries

Required. 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.

The maximum number of TimeSeries objects per Create request is 200.

CreateTimeSeriesSummary

Summary of the result of a failed request to write data to a time series.

Fields

total_point_count

int32

The number of points in the request.

success_point_count

int32

The number of points that were successfully written.

errors[]

Error

The number of points that failed to be written. Order is not guaranteed.

Error

Detailed information about an error category.

Fields

status

Status

The status of the requested write operation.

point_count

int32

The number of points that couldn't be written because of status.

CreateUptimeCheckConfigRequest

The protocol for the CreateUptimeCheckConfig request.

Fields

parent

string

Required. The project in which to create the Uptime check. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Authorization requires the following IAM permission on the specified resource parent:

monitoring.uptimeCheckConfigs.create

uptime_check_config

UptimeCheckConfig

Required. The new Uptime check configuration.

DeleteAlertPolicyRequest

The protocol for the DeleteAlertPolicy request.

Fields

name

string

Required. The alerting policy to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

For more information, see AlertPolicy.

Authorization requires the following IAM permission on the specified resource name:

monitoring.alertPolicies.delete

DeleteGroupRequest

The DeleteGroup request. The default behavior is to be able to delete a single group without any descendants.

Fields

name

string

Required. The group to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

recursive

bool

If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.

DeleteMetricDescriptorRequest

The DeleteMetricDescriptor request.

Fields

name

string

Required. 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".

DeleteNotificationChannelRequest

The DeleteNotificationChannel request.

Fields

name

string

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Authorization requires the following IAM permission on the specified resource name:

monitoring.notificationChannels.delete

force

bool

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, this operation will fail if the notification channel is referenced by existing alerting policies.

DeleteServiceLevelObjectiveRequest

The DeleteServiceLevelObjective request.

Fields

name

string

Required. Resource name of the ServiceLevelObjective to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

DeleteServiceRequest

The DeleteService request.

Fields

name

string

Required. Resource name of the Service to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

DeleteUptimeCheckConfigRequest

The protocol for the DeleteUptimeCheckConfig request.

Fields

name

string

Required. The Uptime check configuration to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

Authorization requires the following IAM permission on the specified resource name:

monitoring.uptimeCheckConfigs.delete

DistributionCut

A DistributionCut defines a TimeSeries and thresholds used for measuring good service and total service. The TimeSeries must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE. The computed good_service will be the estimated count of values in the Distribution that fall within the specified min and max.

Fields

distribution_filter

string

A monitoring filter specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.

range

Range

Range of values considered "good." For a one-sided range, set one bound to an infinite value.

DroppedLabels

A set of (label, value) pairs that were removed from a Distribution time series during aggregation and then added as an attachment to a Distribution.Exemplar.

The full label set for the exemplars is constructed by using the dropped pairs in combination with the label values that remain on the aggregated Distribution time series. The constructed full label set can be used to identify the specific entity, such as the instance or job, which might be contributing to a long-tail. However, with dropped labels, the storage requirements are reduced because only the aggregated distribution values for a large group of time series are stored.

Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.

Fields

label

map<string, string>

Map from label to its value, for all labels dropped in any aggregation.

GetAlertPolicyRequest

The protocol for the GetAlertPolicy request.

Fields

name

string

Required. The alerting policy to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

Authorization requires the following IAM permission on the specified resource name:

monitoring.alertPolicies.get

GetGroupRequest

The GetGroup request.

Fields

name

string

Required. The group to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

GetMetricDescriptorRequest

The GetMetricDescriptor request.

Fields

name

string

Required. 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".

GetMonitoredResourceDescriptorRequest

The GetMonitoredResourceDescriptor request.

Fields

name

string

Required. 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.

GetNotificationChannelDescriptorRequest

The GetNotificationChannelDescriptor response.

Fields

name

string

Required. The channel type for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]

GetNotificationChannelRequest

The GetNotificationChannel request.

Fields

name

string

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Authorization requires the following IAM permission on the specified resource name:

monitoring.notificationChannels.get

GetNotificationChannelVerificationCodeRequest

The GetNotificationChannelVerificationCode request.

Fields

name

string

Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.

Authorization requires the following IAM permission on the specified resource name:

monitoring.notificationChannels.getVerificationCode

expire_time

The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).

GetNotificationChannelVerificationCodeResponse

The GetNotificationChannelVerificationCode request.

Fields

code

string

The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number).

expire_time

MonitoredResourceDescriptor

The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration.

GetServiceLevelObjectiveRequest

The GetServiceLevelObjective request.

Fields

name

string

Required. Resource name of the ServiceLevelObjective to get. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

view

View

View of the ServiceLevelObjective to return. If DEFAULT, return the ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.

GetServiceRequest

The GetService request.

Fields

name

string

Required. Resource name of the Service. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

GetSnoozeRequest

The message definition for retrieving a Snooze. Users must specify the field, name, which identifies the Snooze.

Fields

name

string

Required. The ID of the Snooze to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

GetUptimeCheckConfigRequest

The protocol for the GetUptimeCheckConfig request.

Fields

name

string

Required. The Uptime check configuration to retrieve. The format is:

projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

Authorization requires the following IAM permission on the specified resource name:

monitoring.uptimeCheckConfigs.get

Group

The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.

Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.

For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.

The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.

Fields
`name`	`string` Output only. The name of this group. The format is: `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]` When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to `CreateGroup` and a unique `[GROUP_ID]` that is generated automatically.
`display_name`	`string` A user-assigned name for this group, used only for display purposes.
`parent_name`	`string` The name of the group's parent, if it has one. The format is: `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]` For groups with no parent, `parent_name` is the empty string, `""`.
`filter`	`string` The filter used to determine which monitored resources belong to this group.
`is_cluster`	`bool` If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

GroupResourceType

The supported resource types that can be used as values of group_resource.resource_type. INSTANCE includes gce_instance and aws_ec2_instance resource types. The resource types gae_app and uptime_url are not valid here because group checks on App Engine modules and URLs are not allowed.

Enums
`RESOURCE_TYPE_UNSPECIFIED`	Default value (not valid).
`INSTANCE`	A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS).
`AWS_ELB_LOAD_BALANCER`	A group of Amazon ELB load balancers.

InternalChecker

An internal checker allows Uptime checks to run on private/internal GCP resources.

Fields
`name`	`string` A unique resource name for this InternalChecker. The format is: `projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID]` `[PROJECT_ID_OR_NUMBER]` is the Cloud Monitoring Metrics Scope project for the Uptime check config associated with the internal checker.
`display_name`	`string` The checker's human-readable name. The display name should be unique within a Cloud Monitoring Metrics Scope in order to make it easier to identify; however, uniqueness is not enforced.
`network`	`string` The GCP VPC network where the internal resource lives (ex: "default").
`gcp_zone`	`string` The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
`peer_project_id`	`string` The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project.
`state`	`State` The current operational state of the internal checker.

State

Operational states for an internal checker.

Enums
`UNSPECIFIED`	An internal checker should never be in the unspecified state.
`CREATING`	The checker is being created, provisioned, and configured. A checker in this state can be returned by `ListInternalCheckers` or `GetInternalChecker`, as well as by examining the long running Operation that created it.
`RUNNING`	The checker is running and available for use. A checker in this state can be returned by `ListInternalCheckers` or `GetInternalChecker` as well as by examining the long running Operation that created it. If a checker is being torn down, it is neither visible nor usable, so there is no "deleting" or "down" state.

LabelValue

A label value.

Fields
Union field `value`. The label value can be a bool, int64, or string. `value` can be only one of the following:
`bool_value`	`bool` A bool label value.
`int64_value`	`int64` An int64 label value.
`string_value`	`string` A string label value.

ListAlertPoliciesRequest

The protocol for the ListAlertPolicies request.

Fields
`name`	`string` Required. The project whose alert policies are to be listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]` Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the `GetAlertPolicy` operation, instead. Authorization requires the following IAM permission on the specified resource `name`: `monitoring.alertPolicies.list`
`filter`	`string` Optional. If provided, this field specifies the criteria that must be met by alert policies to be included in the response. For more details, see sorting and filtering.
`order_by`	`string` Optional. A comma-separated list of fields by which to sort the result. Supports the same set of field references as the `filter` field. Entries can be prefixed with a minus sign to sort by the field in descending order. For more details, see sorting and filtering.
`page_size`	`int32` Optional. The maximum number of results to return in a single response.
`page_token`	`string` Optional. 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 more results from the previous method call.

ListAlertPoliciesResponse

The protocol for the ListAlertPolicies response.

Fields

alert_policies[]

AlertPolicy

The returned alert policies.

next_page_token

string

If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method.

total_size

int32

The total number of alert policies in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158

ListGroupMembersRequest

The ListGroupMembers request.

Fields
`name`	`string` Required. The group whose members are listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`
`page_size`	`int32` A positive number that is the maximum number of results to return.
`page_token`	`string` If this field is not empty then it must contain the `next_page_token` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
`filter`	`string` An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: `resource.type = "gce_instance"`
`interval`	`TimeInterval` An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.

ListGroupMembersResponse

The ListGroupMembers response.

Fields

members[]

MonitoredResource

A set of monitored resources in the group.

next_page_token

string

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 page_token in the next call to this method.

total_size

int32

The total number of elements matching this request.

ListGroupsRequest

The ListGroup request.

Fields
`name`	`string` Required. The project whose groups are to be listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]`
`page_size`	`int32` A positive number that is the maximum number of results to return.
`page_token`	`string` If this field is not empty then it must contain the `next_page_token` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
Union field `filter`. An optional filter consisting of a single group name. The filters limit the groups returned based on their parent-child relationship with the specified group. If no filter is specified, all groups are returned. `filter` can be only one of the following:
`children_of_group`	`string` A group name. The format is: `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]` Returns groups whose `parent_name` field contains the group name. If no groups have this parent, the results are empty.
`ancestors_of_group`	`string` A group name. The format is: `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]` Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
`descendants_of_group`	`string` A group name. The format is: `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]` Returns the descendants of the specified group. This is a superset of the results returned by the `children_of_group` filter, and includes children-of-children, and so forth.

ListGroupsResponse

The ListGroups response.

Fields

group[]

Group

The groups that match the specified filters.

next_page_token

string

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 page_token in the next call to this method.

ListMetricDescriptorsRequest

The ListMetricDescriptors request.

Fields
`name`	`string` Required. The project on which to execute the request. The format is: `projects/[PROJECT_ID_OR_NUMBER]`
`filter`	`string` Optional. 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/")`
`page_size`	`int32` Optional. A positive number that is the maximum number of results to return. The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results.
`page_token`	`string` Optional. 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.

ListMetricDescriptorsResponse

The ListMetricDescriptors response.

Fields

metric_descriptors[]

MetricDescriptor

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

next_page_token

string

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 page_token in the next call to this method.

ListMonitoredResourceDescriptorsRequest

The ListMonitoredResourceDescriptors request.

Fields
`name`	`string` Required. The project on which to execute the request. The format is: `projects/[PROJECT_ID_OR_NUMBER]`
`filter`	`string` 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`
`page_size`	`int32` A positive number that is the maximum number of results to return.
`page_token`	`string` 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.

ListMonitoredResourceDescriptorsResponse

The ListMonitoredResourceDescriptors response.

Fields

resource_descriptors[]

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

next_page_token

string

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 page_token in the next call to this method.

ListNotificationChannelDescriptorsRequest

The ListNotificationChannelDescriptors request.

Fields

name

string

Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

projects/[PROJECT_ID_OR_NUMBER]

Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.

Authorization requires the following IAM permission on the specified resource name:

monitoring.notificationChannelDescriptors.list

page_size

int32

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

page_token

string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

ListNotificationChannelDescriptorsResponse

The ListNotificationChannelDescriptors response.

Fields

channel_descriptors[]

NotificationChannelDescriptor

The monitored resource descriptors supported for the specified project, optionally filtered.

next_page_token

string

If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned.

ListNotificationChannelsRequest

The ListNotificationChannels request.

Fields
`name`	`string` Required. The project on which to execute the request. The format is: `projects/[PROJECT_ID_OR_NUMBER]` This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the `GetNotificationChannel` operation. Authorization requires the following IAM permission on the specified resource `name`: `monitoring.notificationChannels.list`
`filter`	`string` Optional. If provided, this field specifies the criteria that must be met by notification channels to be included in the response. For more details, see sorting and filtering.
`order_by`	`string` Optional. A comma-separated list of fields by which to sort the result. Supports the same set of fields as in `filter`. Entries can be prefixed with a minus sign to sort in descending rather than ascending order. For more details, see sorting and filtering.
`page_size`	`int32` Optional. The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
`page_token`	`string` Optional. If non-empty, `page_token` must contain a value returned as the `next_page_token` in a previous response to request the next set of results.

ListNotificationChannelsResponse

The ListNotificationChannels response.

Fields

notification_channels[]

NotificationChannel

The notification channels defined for the specified project.

next_page_token

string

total_size

int32

The total number of notification channels in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158

ListServiceLevelObjectivesRequest

The ListServiceLevelObjectives request.

Fields
`parent`	`string` Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Metrics Scope. The formats are: `projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-`
`filter`	`string` A filter specifying what `ServiceLevelObjective`s to return.
`page_size`	`int32` A non-negative number that is the maximum number of results to return. When 0, use default page size.
`page_token`	`string` 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.
`view`	`View` View of the `ServiceLevelObjective`s to return. If `DEFAULT`, return each `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.

ListServiceLevelObjectivesResponse

The ListServiceLevelObjectives response.

Fields

service_level_objectives[]

ServiceLevelObjective

The ServiceLevelObjectives matching the specified filter.

next_page_token

string

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 page_token in the next call to this method.

ListServicesRequest

The ListServices request.

Fields
`parent`	`string` Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are: `projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]`
`filter`	`string` A filter specifying what `Service`s to return. The filter supports filtering on a particular service-identifier type or one of its attributes. To filter on a particular service-identifier type, the `identifier_case` refers to which option in the `identifier` field is populated. For example, the filter `identifier_case = "CUSTOM"` would match all services with a value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other options listed at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service To filter on an attribute of a service-identifier type, apply the filter name by using the snake case of the service-identifier type and the attribute of that service-identifier type, and join the two with a period. For example, to filter by the `meshUid` field of the `MeshIstio` service-identifier type, you must filter on `mesh_istio.mesh_uid = "123"` to match all services with mesh UID "123". Service-identifier types and their attributes are described at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
`page_size`	`int32` A non-negative number that is the maximum number of results to return. When 0, use default page size.
`page_token`	`string` 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.

ListServicesResponse

The ListServices response.

Fields

services[]

Service

The Services matching the specified filter.

next_page_token

string

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 page_token in the next call to this method.

ListSnoozesRequest

The message definition for listing Snoozes associated with the given parent, satisfying the optional filter.

Fields
`parent`	`string` Required. The project whose `Snooze`s should be listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]`
`filter`	`string` Optional. Optional filter to restrict results to the given criteria. The following fields are supported. `interval.start_time` `interval.end_time` For example: ``` interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ```
`page_size`	`int32` Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range [1, 1000]. If the value given is outside this range, the server will decide the number of results to be returned.
`page_token`	`string` Optional. The `next_page_token` from a previous call to `ListSnoozesRequest` to get the next page of results.

ListSnoozesResponse

The results of a successful ListSnoozes call, containing the matching Snoozes.

Fields

snoozes[]

Snooze

Snoozes matching this list call.

next_page_token

string

Page token for repeated calls to ListSnoozes, to fetch additional pages of results. If this is empty or missing, there are no more pages.

ListTimeSeriesRequest

The ListTimeSeries request.

Fields
`name`	`string` Required. The project, organization or folder on which to execute the request. The format is: `projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]`
`filter`	`string` Required. 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.labels.instance_name = "my-instance-name"`
`interval`	`TimeInterval` Required. 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.
`aggregation`	`Aggregation` Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels. By default (if no `aggregation` is explicitly specified), the raw time series data is returned.
`secondary_aggregation`	`Aggregation` Apply a second aggregation after `aggregation` is applied. May only be specified if `aggregation` is specified.
`order_by`	`string` Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
`view`	`TimeSeriesView` Required. Specifies which information is returned about the time series.
`page_size`	`int32` 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.
`page_token`	`string` 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.

TimeSeriesView

Controls which fields are returned by ListTimeSeries*.

Enums
`FULL`	Returns the identity of the metric(s), the time series, and the time series data.
`HEADERS`	Returns the identity of the metric and the time series resource, but not the time series data.

ListTimeSeriesResponse

The ListTimeSeries response.

Fields
`time_series[]`	`TimeSeries` One or more time series that match the filter included in the request.
`next_page_token`	`string` 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 `page_token` in the next call to this method.
`execution_errors[]`	`Status` Query execution errors that may have caused the time series data returned to be incomplete.
`unit`	`string` The unit in which all `time_series` point values are reported. `unit` follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. If different `time_series` have different units (for example, because they come from different metric types, or a unit is absent), then `unit` will be "{not_a_unit}".

ListUptimeCheckConfigsRequest

The protocol for the ListUptimeCheckConfigs request.

Fields
`parent`	`string` Required. The project whose Uptime check configurations are listed. The format is: `projects/[PROJECT_ID_OR_NUMBER]` Authorization requires the following IAM permission on the specified resource `parent`: `monitoring.uptimeCheckConfigs.list`
`filter`	`string` If provided, this field specifies the criteria that must be met by uptime checks to be included in the response. For more details, see Filtering syntax.
`page_size`	`int32` The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.
`page_token`	`string` 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 more results from the previous method call.

ListUptimeCheckConfigsResponse

The protocol for the ListUptimeCheckConfigs response.

Fields

uptime_check_configs[]

UptimeCheckConfig

The returned Uptime check configurations.

next_page_token

string

This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).

total_size

int32

The total number of Uptime check configurations for the project, irrespective of any pagination.

ListUptimeCheckIpsRequest

The protocol for the ListUptimeCheckIps request.

Fields

page_size

int32

The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented

page_token

string

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 more results from the previous method call. NOTE: this field is not yet implemented

ListUptimeCheckIpsResponse

The protocol for the ListUptimeCheckIps response.

Fields

uptime_check_ips[]

UptimeCheckIp

The returned list of IP addresses (including region and location) that the checkers run from.

next_page_token

string

MutationRecord

Describes a change made to a configuration.

Fields

mutate_time

When the change occurred.

mutated_by

string

The email address of the user making the change.

NotificationChannel

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

Fields
`type`	`string` The type of the notification channel. This field matches the value of the `NotificationChannelDescriptor.type` field.
`name`	`string` Identifier. The full REST resource name for this channel. The format is: `projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]` The `[CHANNEL_ID]` is automatically assigned by the server on creation.
`display_name`	`string` An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
`description`	`string` An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.
`labels`	`map<string, string>` Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the `NotificationChannelDescriptor.labels` of the `NotificationChannelDescriptor` corresponding to the `type` field.
`user_labels`	`map<string, string>` User-supplied key/value data that does not need to conform to the corresponding `NotificationChannelDescriptor`'s schema, unlike the `labels` field. This field is intended to be used for organizing and identifying the `NotificationChannel` objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
`verification_status`	`VerificationStatus` Indicates whether this channel has been verified or not. On a `ListNotificationChannels` or `GetNotificationChannel` operation, this field is expected to be populated. If the value is `UNVERIFIED`, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works. If the channel is neither `VERIFIED` nor `UNVERIFIED`, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type. This field cannot be modified using a standard `UpdateNotificationChannel` operation. To change the value of this field, you must call `VerifyNotificationChannel`.
`enabled`	`BoolValue` Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
`creation_record`	`MutationRecord` Record of the creation of this channel.
`mutation_records[]`	`MutationRecord` Records of the modification of this channel.

VerificationStatus

Indicates whether the channel has been verified or not. It is illegal to specify this field in a CreateNotificationChannel or an UpdateNotificationChannel operation.

Enums
`VERIFICATION_STATUS_UNSPECIFIED`	Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
`UNVERIFIED`	The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
`VERIFIED`	It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

NotificationChannelDescriptor

A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.

Fields
`name`	`string` The full REST resource name for this descriptor. The format is: `projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]` In the above, `[TYPE]` is the value of the `type` field.
`type`	`string` The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors. Notification channel types are globally unique.
`display_name`	`string` A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
`description`	`string` A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.
`labels[]`	`LabelDescriptor` The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.
`launch_stage`	`LaunchStage` The product launch stage for channels of this type.

Point

A single data point in a time series.

Fields

interval

TimeInterval

The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. 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.

value

TypedValue

The value of the data point.

QueryError

An error associated with a query in the time series query language format.

Fields

locator

TextLocator

The location of the time series query language text that this error applies to.

message

string

The error message.

QueryErrorList

This is an error detail intended to be used with INVALID_ARGUMENT errors.

Fields

errors[]

QueryError

Errors in parsing the time series query language text. The number of errors in the response may be limited.

error_summary

string

A summary of all the errors.

QueryTimeSeriesRequest

The QueryTimeSeries request. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice.

Fields
`name`	`string` Required. The project on which to execute the request. The format is: `projects/[PROJECT_ID_OR_NUMBER]`
`query`	`string` Required. The query in the Monitoring Query Language format. The default time zone is in UTC.
`page_size`	`int32` A positive number that is the maximum number of time_series_data to return.
`page_token`	`string` 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.

QueryTimeSeriesResponse

The QueryTimeSeries response. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice.

Fields
`time_series_descriptor`	`TimeSeriesDescriptor` The descriptor for the time series data.
`time_series_data[]`	`TimeSeriesData` The time series data.
`next_page_token`	`string` 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 `page_token` in the next call to this method.
`partial_errors[]`	`Status` Query execution errors that may have caused the time series data returned to be incomplete. The available data will be available in the response.

Range

Range of numerical values within min and max.

Fields

min

double

Range minimum.

max

double

Range maximum.

RequestBasedSli

Service Level Indicators for which atomic units of service are counted directly.

Fields

Union field method. The means to compute a ratio of good_service to total_service. method can be only one of the following:

good_total_ratio

TimeSeriesRatio

good_total_ratio is used when the ratio of good_service to total_service is computed from two TimeSeries.

distribution_cut

DistributionCut

distribution_cut is used when good_service is a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution.

SendNotificationChannelVerificationCodeRequest

The SendNotificationChannelVerificationCode request.

Fields

name

string

Required. The notification channel to which to send a verification code.

Authorization requires the following IAM permission on the specified resource name:

monitoring.notificationChannels.sendVerificationCode

Service

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

Fields
`name`	`string` Identifier. Resource name for this Service. The format is: `projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]`
`display_name`	`string` Name used for UI elements listing this Service.
`basic_service`	`BasicService` Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here.
`telemetry`	`Telemetry` Configuration for how to query telemetry on a Service.
`user_labels`	`map<string, string>` Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
Union field `identifier`. REQUIRED. Service-identifying atoms specifying the underlying service. `identifier` can be only one of the following:
`custom`	`Custom` Custom service type.
`app_engine`	`AppEngine` Type used for App Engine services.
`cluster_istio`	`ClusterIstio` Type used for Istio services that live in a Kubernetes cluster.
`mesh_istio`	`MeshIstio` Type used for Istio services scoped to an Istio mesh.
`istio_canonical_service`	`IstioCanonicalService` Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here
`cloud_run`	`CloudRun` Type used for Cloud Run services.
`gke_namespace`	`GkeNamespace` Type used for GKE Namespaces.
`gke_workload`	`GkeWorkload` Type used for GKE Workloads.
`gke_service`	`GkeService` Type used for GKE Services (the Kubernetes concept of a service).

AppEngine

App Engine service. Learn more at https://cloud.google.com/appengine.

Fields

module_id

string

The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource.

BasicService

A well-known service type, defined by its service type and service labels. Documentation and examples here.

Fields

service_type

string

The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here.

service_labels

map<string, string>

Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here.

CloudRun

Cloud Run service. Learn more at https://cloud.google.com/run.

Fields

service_name

string

The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource.

location

string

The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource.

ClusterIstio

Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type.

Fields
`location`	`string` The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the `location` resource label in `k8s_cluster` resources.
`cluster_name`	`string` The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the `cluster_name` resource label in `k8s_cluster` resources.
`service_namespace`	`string` The namespace of the Istio service underlying this service. Corresponds to the `destination_service_namespace` metric label in Istio metrics.
`service_name`	`string` The name of the Istio service underlying this service. Corresponds to the `destination_service_name` metric label in Istio metrics.

Custom

This type has no fields.

Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service.

GkeNamespace

GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod).

Fields
`project_id`	`string` Output only. The project this resource lives in. For legacy services migrated from the `Custom` type, this may be a distinct project from the one parenting the service itself.
`location`	`string` The location of the parent cluster. This may be a zone or region.
`cluster_name`	`string` The name of the parent cluster.
`namespace_name`	`string` The name of this namespace.

GkeService

GKE Service. The "service" here represents a Kubernetes service object. The field names correspond to the resource labels on k8s_service monitored resources.

Fields
`project_id`	`string` Output only. The project this resource lives in. For legacy services migrated from the `Custom` type, this may be a distinct project from the one parenting the service itself.
`location`	`string` The location of the parent cluster. This may be a zone or region.
`cluster_name`	`string` The name of the parent cluster.
`namespace_name`	`string` The name of the parent namespace.
`service_name`	`string` The name of this service.

GkeWorkload

A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod).

Fields
`project_id`	`string` Output only. The project this resource lives in. For legacy services migrated from the `Custom` type, this may be a distinct project from the one parenting the service itself.
`location`	`string` The location of the parent cluster. This may be a zone or region.
`cluster_name`	`string` The name of the parent cluster.
`namespace_name`	`string` The name of the parent namespace.
`top_level_controller_type`	`string` The type of this workload (for example, "Deployment" or "DaemonSet")
`top_level_controller_name`	`string` The name of this workload.

IstioCanonicalService

Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.

Fields

mesh_uid

string

Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics.

canonical_service_namespace

string

The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics.

canonical_service

string

The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics.

MeshIstio

Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.

Fields

mesh_uid

string

Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics.

service_namespace

string

The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.

service_name

string

The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.

Telemetry

Configuration for how to query telemetry on a Service.

Fields

resource_name

string

The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.

ServiceLevelIndicator

A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be good_service / total_service over any queried time interval. The value of performance always falls into the range 0 <= performance <= 1. A custom SLI describes how to compute this ratio, whether this is by dividing values from a pair of time series, cutting a Distribution into good and bad counts, or counting time windows in which the service complies with a criterion. For separation of concerns, a single Service-Level Indicator measures performance for only one aspect of service quality, such as fraction of successful queries or fast-enough queries.

Fields
Union field `type`. Service level indicators can be grouped by whether the "unit" of service being measured is based on counts of good requests or on counts of good time windows `type` can be only one of the following:
`basic_sli`	`BasicSli` Basic SLI on a well-known service type.
`request_based`	`RequestBasedSli` Request-based SLIs
`windows_based`	`WindowsBasedSli` Windows-based SLIs

ServiceLevelObjective

A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully."

Fields
`name`	`string` Identifier. Resource name for this `ServiceLevelObjective`. The format is: `projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]`
`display_name`	`string` Name used for UI elements listing this SLO.
`service_level_indicator`	`ServiceLevelIndicator` The definition of good service, used to measure and calculate the quality of the `Service`'s performance with respect to a single aspect of service quality.
`goal`	`double` The fraction of service that must be good in order for this objective to be met. `0 < goal <= 0.9999`.
`user_labels`	`map<string, string>` Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.
Union field `period`. The time period over which the objective will be evaluated. `period` can be only one of the following:
`rolling_period`	`Duration` A rolling time period, semantically "in the past `<rolling_period>`". Must be an integer multiple of 1 day no larger than 30 days.
`calendar_period`	`CalendarPeriod` A calendar period, semantically "since the start of the current `<calendar_period>`". At this time, only `DAY`, `WEEK`, `FORTNIGHT`, and `MONTH` are supported.

View

ServiceLevelObjective.View determines what form of ServiceLevelObjective is returned from GetServiceLevelObjective, ListServiceLevelObjectives, and ListServiceLevelObjectiveVersions RPCs.

Enums
`VIEW_UNSPECIFIED`	Same as FULL.
`FULL`	Return the embedded `ServiceLevelIndicator` in the form in which it was defined. If it was defined using a `BasicSli`, return that `BasicSli`.
`EXPLICIT`	For `ServiceLevelIndicator`s using `BasicSli` articulation, instead return the `ServiceLevelIndicator` with its mode of computation fully spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using `RequestBasedSli` or `WindowsBasedSli`, return the `ServiceLevelIndicator` as it was provided.

Snooze

A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time.

Fields
`name`	`string` Required. Identifier. The name of the `Snooze`. The format is: `projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]` The ID of the `Snooze` will be generated by the system.
`criteria`	`Criteria` Required. This defines the criteria for applying the `Snooze`. See `Criteria` for more information.
`interval`	`TimeInterval` Required. The `Snooze` will be active from `interval.start_time` through `interval.end_time`. `interval.start_time` cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
`display_name`	`string` Required. A display name for the `Snooze`. This can be, at most, 512 unicode characters.

Criteria

Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied.

Fields

policies[]

string

The specific AlertPolicy names for the alert that should be snoozed. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]

There is a limit of 16 policies per snooze. This limit is checked during snooze creation.

SpanContext

The context of a span. This is attached to an Exemplar in Distribution values during aggregation.

It contains the name of a span with format:

projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]

Fields

span_name

string

The resource name of the span. The format is:

projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]

[TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.

[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.

SyntheticMonitorTarget

Describes a Synthetic Monitor to be invoked by Uptime.

Fields

Union field target. Specifies a Synthetic Monitor's execution stack. target can be only one of the following:

cloud_function_v2

CloudFunctionV2Target

Target a Synthetic Monitor GCFv2 instance.

CloudFunctionV2Target

A Synthetic Monitor deployed to a Cloud Functions V2 instance.

Fields

name

string

Required. Fully qualified GCFv2 resource name i.e. projects/{project}/locations/{location}/functions/{function} Required.

cloud_run_revision

MonitoredResource

Output only. The cloud_run_revision Monitored Resource associated with the GCFv2. The Synthetic Monitor execution results (metrics, logs, and spans) are reported against this Monitored Resource. This field is output only.

TextLocator

A locator for text. Indicates a particular part of the text of a request or of an object referenced in the request.

For example, suppose the request field text contains:

text: "The quick brown fox jumps over the lazy dog."

Then the locator:

source: "text" start_position { line: 1 column: 17 } end_position { line: 1 column: 19 }

refers to the part of the text: "fox".

Fields
`source`	`string` The source of the text. The source may be a field in the request, in which case its format is the format of the google.rpc.BadRequest.FieldViolation.field field in https://cloud.google.com/apis/design/errors#error_details. It may also be be a source other than the request field (e.g. a macro definition referenced in the text of the query), in which case this is the name of the source (e.g. the macro name).
`start_position`	`Position` The position of the first byte within the text.
`end_position`	`Position` The position of the last byte within the text.
`nested_locator`	`TextLocator` If `source`, `start_position`, and `end_position` describe a call on some object (e.g. a macro in the time series query language text) and a location is to be designated in that object's text, `nested_locator` identifies the location within that object.
`nesting_reason`	`string` When `nested_locator` is set, this field gives the reason for the nesting. Usually, the reason is a macro invocation. In that case, the macro name (including the leading '@') signals the location of the macro call in the text and a macro argument name (including the leading '$') signals the location of the macro argument inside the macro body that got substituted away.

Position

The position of a byte within the text.

Fields

line

int32

The line, starting with 1, where the byte is positioned.

column

int32

The column within the line, starting with 1, where the byte is positioned. This is a byte index even though the text is UTF-8.

TimeInterval

Describes a time interval:

Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric.
Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future.
- For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval.
- For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval.
- For CUMULATIVE metrics, the start time and end time must 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 new start time must be at least a millisecond after the end time of the previous interval.
- The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time.

Fields

end_time

Required. The end of the time interval.

start_time

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.

TimeSeries

A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.

Fields
`metric`	`Metric` The associated metric. A fully-specified metric used to identify the time series.
`resource`	`MonitoredResource` The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics.
`metadata`	`MonitoredResourceMetadata` Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.
`metric_kind`	`MetricKind` 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`.
`value_type`	`ValueType` 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.
`points[]`	`Point` 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`.
`unit`	`string` The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.
`description`	`string` Input only. A detailed description of the time series that will be associated with the `google.api.MetricDescriptor` for the metric. Once set, this field cannot be changed through CreateTimeSeries.

TimeSeriesData

Represents the values of a time series associated with a TimeSeriesDescriptor.

Fields

label_values[]

LabelValue

The values of the labels in the time series identifier, given in the same order as the label_descriptors field of the TimeSeriesDescriptor associated with this object. Each value must have a value of the type given in the corresponding entry of label_descriptors.

point_data[]

PointData

The points in the time series.

PointData

A point's value columns and time interval. Each point has one or more point values corresponding to the entries in point_descriptors field in the TimeSeriesDescriptor associated with this object.

Fields

values[]

TypedValue

The values that make up the point.

time_interval

TimeInterval

The time interval associated with the point.

TimeSeriesDescriptor

A descriptor for the labels and points in a time series.

Fields

label_descriptors[]

LabelDescriptor

Descriptors for the labels.

point_descriptors[]

ValueDescriptor

Descriptors for the point data value columns.

ValueDescriptor

A descriptor for the value columns in a data point.

Fields
`key`	`string` The value key.
`value_type`	`ValueType` The value type.
`metric_kind`	`MetricKind` The value stream kind.
`unit`	`string` The unit in which `time_series` point values are reported. `unit` follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. `unit` is only valid if `value_type` is INTEGER, DOUBLE, DISTRIBUTION.

TimeSeriesRatio

A TimeSeriesRatio specifies two TimeSeries to use for computing the good_service / total_service ratio. The specified TimeSeries must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. The TimeSeriesRatio must specify exactly two of good, bad, and total, and the relationship good_service + bad_service = total_service will be assumed.

Fields

good_service_filter

string

A monitoring filter specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.

bad_service_filter

string

A monitoring filter specifying a TimeSeries quantifying bad service, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.

total_service_filter

string

A monitoring filter specifying a TimeSeries quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.

TypedValue

A single strongly-typed value.

Fields
Union field `value`. The typed value field. `value` can be only one of the following:
`bool_value`	`bool` A Boolean value: `true` or `false`.
`int64_value`	`int64` A 64-bit integer. Its range is approximately ±9.2x10¹⁸.
`double_value`	`double` A 64-bit double-precision floating-point number. Its magnitude is approximately ±10^±300 and it has 16 significant digits of precision.
`string_value`	`string` A variable-length string value.
`distribution_value`	`Distribution` A distribution value.

UpdateAlertPolicyRequest

The protocol for the UpdateAlertPolicy request.

Fields

update_mask

Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.

Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.

If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:

The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents.
Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created.

alert_policy

AlertPolicy

Required. The updated alerting policy or the updated values for the fields listed in update_mask. If update_mask is not empty, any fields in this policy that are not in update_mask are ignored.

Authorization requires the following IAM permission on the specified resource alertPolicy:

monitoring.alertPolicies.update

UpdateGroupRequest

The UpdateGroup request.

Fields

group

Group

Required. The new definition of the group. All fields of the existing group, excepting name, are replaced with the corresponding fields of this group.

validate_only

bool

If true, validate this request but do not update the existing group.

UpdateNotificationChannelRequest

The UpdateNotificationChannel request.

Fields

update_mask

Optional. The fields to update.

notification_channel

NotificationChannel

Required. A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the update_mask.

UpdateServiceLevelObjectiveRequest

The UpdateServiceLevelObjective request.

Fields

service_level_objective

ServiceLevelObjective

Required. The ServiceLevelObjective to draw updates from. The given name specifies the resource to update.

update_mask

A set of field paths defining which fields to use for the update.

UpdateServiceRequest

The UpdateService request.

Fields

service

Service

Required. The Service to draw updates from. The given name specifies the resource to update.

update_mask

A set of field paths defining which fields to use for the update.

UpdateSnoozeRequest

The message definition for updating a Snooze. The field, snooze.name identifies the Snooze to be updated. The remainder of snooze gives the content the Snooze in question will be assigned.

What fields can be updated depends on the start time and end time of the Snooze.

end time is in the past: These Snoozes are considered read-only and cannot be updated.
start time is in the past and end time is in the future: display_name and interval.end_time can be updated.
start time is in the future: display_name, interval.start_time and interval.end_time can be updated.

Fields

snooze

Snooze

Required. The Snooze to update. Must have the name field present.

update_mask

Required. The fields to update.

For each field listed in update_mask:

If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze.
If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.

Fields not listed retain their existing value.

The following are the field names that are accepted in update_mask:

display_name
interval.start_time
interval.end_time

That said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.

UpdateUptimeCheckConfigRequest

The protocol for the UpdateUptimeCheckConfig request.

Fields

update_mask