Module types (0.36.2)

API documentation for monitoring_v3.types module.

Classes

Aggregation

Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.

Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.

Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.

The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example “the 95% latency across the average of all tasks in a cluster”. This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation <https://cloud.google.com/monitoring/api/v3/aggregation>__.

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

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

AlertPolicy

A description of the conditions under which some aspect of your system is considered to be “unhealthy” and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting <https://cloud.google.com/monitoring/alerts/>__.

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don’t use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.

User-supplied key/value data to be used for organizing and identifying the AlertPolicy 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.

How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.

Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

Any

API documentation for monitoring_v3.types.Any class.

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.

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.

This SLI can be evaluated on the basis of availability or latency.

Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold.

BoolValue

API documentation for monitoring_v3.types.BoolValue class.

BytesValue

API documentation for monitoring_v3.types.BytesValue class.

CreateAlertPolicyRequest

The protocol for the CreateAlertPolicy request.

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.

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

CreateMetricDescriptorRequest

The CreateMetricDescriptor request.

Required. The new custom metric <https://cloud.google.com/monitoring/custom-metrics>__ descriptor.

CreateNotificationChannelRequest

The CreateNotificationChannel request.

Required. The definition of the NotificationChannel to create.

CreateServiceLevelObjectiveRequest

The CreateServiceLevelObjective request.

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

CreateServiceRequest

The CreateService request.

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

CreateTimeSeriesError

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

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

CreateTimeSeriesRequest

The CreateTimeSeries request.

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.

The number of points that were successfully written.

CreateUptimeCheckConfigRequest

The protocol for the CreateUptimeCheckConfig request.

Required. The new Uptime check configuration.

DeleteAlertPolicyRequest

The protocol for the DeleteAlertPolicy request.

DeleteGroupRequest

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

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.

DeleteNotificationChannelRequest

The DeleteNotificationChannel request.

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, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

DeleteServiceLevelObjectiveRequest

The DeleteServiceLevelObjective request.

DeleteServiceRequest

The DeleteService request.

DeleteUptimeCheckConfigRequest

The protocol for the DeleteUptimeCheckConfig request.

Distribution

API documentation for monitoring_v3.types.Distribution class.

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 count of values x in the Distribution such that range.min <= x < range.max.

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

DoubleValue

API documentation for monitoring_v3.types.DoubleValue class.

DroppedLabels

A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.

These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.

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.

Duration

API documentation for monitoring_v3.types.Duration class.

Empty

API documentation for monitoring_v3.types.Empty class.

FieldMask

API documentation for monitoring_v3.types.FieldMask class.

FloatValue

API documentation for monitoring_v3.types.FloatValue class.

GetAlertPolicyRequest

The protocol for the GetAlertPolicy request.

GetGroupRequest

The GetGroup request.

GetMetricDescriptorRequest

The GetMetricDescriptor request.

GetMonitoredResourceDescriptorRequest

The GetMonitoredResourceDescriptor request.

GetNotificationChannelDescriptorRequest

The GetNotificationChannelDescriptor response.

GetNotificationChannelRequest

The GetNotificationChannel request.

GetNotificationChannelVerificationCodeRequest

The GetNotificationChannelVerificationCode request.

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.

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.

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.

GetUptimeCheckConfigRequest

The protocol for the GetUptimeCheckConfig request.

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.

A user-assigned name for this group, used only for display purposes.

The filter used to determine which monitored resources belong to this group.

Int32Value

API documentation for monitoring_v3.types.Int32Value class.

Int64Value

API documentation for monitoring_v3.types.Int64Value class.

InternalChecker

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

The checker’s human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.

The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.

The current operational state of the internal checker.

LabelDescriptor

API documentation for monitoring_v3.types.LabelDescriptor class.

LabelValue

A label value.

A bool label value.

A string label value.

ListAlertPoliciesRequest

The protocol for the ListAlertPolicies request.

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 <https://cloud.google.com/monitoring/api/v3/sorting-and- filtering>__.

The maximum number of results to return in a single response.

ListAlertPoliciesResponse

The protocol for the ListAlertPolicies response.

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.

ListGroupMembersRequest

The ListGroupMembers request.

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

An optional list filter <https://cloud.google.com/monitoring/ api/learn_more#filtering>__ 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"

ListGroupMembersResponse

The ListGroupMembers response.

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.

ListGroupsRequest

The ListGroup request.

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.

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.

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

ListGroupsResponse

The ListGroups response.

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.

If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter <https://cloud.google.com/monitoring/api/v3/filters> specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics <https://cloud.google.com/monitoring/custom-metrics>: :: metric.type = starts_with("custom.googleapis.com/")

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.

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.

An optional filter <https://cloud.google.com/monitoring/api/v3/filters>__ 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

ListMonitoredResourceDescriptorsResponse

The ListMonitoredResourceDescriptors response.

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.

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.

ListNotificationChannelDescriptorsResponse

The ListNotificationChannelDescriptors response.

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.

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 <https://cloud.google.com/monitoring/api/v3/sorting-and- filtering>__.

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.

ListNotificationChannelsResponse

The ListNotificationChannels response.

ListServiceLevelObjectivesRequest

The ListServiceLevelObjectives request.

A filter specifying what ServiceLevelObjective\ s to return.

ListServiceLevelObjectivesResponse

The ListServiceLevelObjectives response.

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.

A filter specifying what Service\ s to return. The filter currently supports the following fields: :: - identifier_case - app_engine.module_id - cloud_endpoints.service - cluster_istio.location - cluster_istio.cluster_name - cluster_istio.service_namespace - cluster_istio.service_name identifier_case refers to which option in the identifier oneof is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options are “CUSTOM”, “APP_ENGINE”, “CLOUD_ENDPOINTS”, and “CLUSTER_ISTIO”.

ListServicesResponse

The ListServices response.

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.

ListTimeSeriesRequest

The ListTimeSeries request.

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

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.

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

ListTimeSeriesResponse

The ListTimeSeries response.

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.

ListUptimeCheckConfigsRequest

The protocol for the ListUptimeCheckConfigs request.

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.

ListUptimeCheckConfigsResponse

The protocol for the ListUptimeCheckConfigs response.

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

ListUptimeCheckIpsRequest

The protocol for the ListUptimeCheckIps request.

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.

ListValue

API documentation for monitoring_v3.types.ListValue class.

Metric

API documentation for monitoring_v3.types.Metric class.

MetricDescriptor

API documentation for monitoring_v3.types.MetricDescriptor class.

MonitoredResource

API documentation for monitoring_v3.types.MonitoredResource class.

MonitoredResourceDescriptor

API documentation for monitoring_v3.types.MonitoredResourceDescriptor class.

MonitoredResourceMetadata

API documentation for monitoring_v3.types.MonitoredResourceMetadata class.

MutationRecord

Describes a change made to a configuration.

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.

The full REST resource name for this channel. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[C HANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.

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.

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.

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.

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.

The type of notification channel, such as “email”, “sms”, etc. Notification channel types are globally unique.

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.

The tiers that support this notification channel; the project service tier must be one of the supported_tiers.

Point

A single data point in a time series.

The value of the data point.

QueryError

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

The error message.

QueryErrorList

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

A summary of all the errors.

QueryTimeSeriesRequest

The QueryTimeSeries request.

Required. The query in the monitoring query language format. The default time zone is in UTC.

QueryTimeSeriesResponse

The QueryTimeSeries response.

The time series data.

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, inclusive of min and exclusive of max. If the open range “< range.max” is desired, set range.min = -infinity. If the open range “>= range.min” is desired, set range.max = infinity.

Range maximum.

RequestBasedSli

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

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

SendNotificationChannelVerificationCodeRequest

The SendNotificationChannelVerificationCode request.

Service

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia <https://en.wikipedia.org/wiki/Service-orientation>__). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

Name used for UI elements listing this Service.

Custom service type.

Type used for Cloud Endpoints services.

Type used for Istio services scoped to an Istio mesh.

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.

Basic SLI on a well-known service type.

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

Name used for UI elements listing this SLO.

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.

A rolling time period, semantically “in the past <rolling_period>”. Must be an integer multiple of 1 day no larger than 30 days.

SpanContext

The context of a span, attached to Exemplars][google.api.Distribution.Exemplars] in Distribution][google.api.Distribution] values during aggregation.

It contains the name of a span with format:

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

Status

API documentation for monitoring_v3.types.Status class.

StringValue

API documentation for monitoring_v3.types.StringValue class.

Struct

API documentation for monitoring_v3.types.Struct class.

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

The position of the first byte within the text.

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.

TimeInterval

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 </monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind>`__ of the metric value. In no case can the end time be earlier than the start time.

For a GAUGE metric, 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.
For DELTA and CUMULATIVE metrics, the start time must be earlier than the end time.
In all cases, the start time of the next interval must be at least a millisecond after the end time of the previous interval. Because the interval is closed, if the start time of a new interval is the same as the end time of the previous interval, data written at the new start time could overwrite data written at the previous end 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.

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

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series. When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric’s descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

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

TimeSeriesData

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

The points in the time series.

TimeSeriesDescriptor

A descriptor for the labels and points in a timeseries.

Descriptors for the point data value columns.

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.

A monitoring filter <https://cloud.google.com/monitoring/api/v3/filters>__ 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.

Timestamp

API documentation for monitoring_v3.types.Timestamp class.

TypedValue

A single strongly-typed value.

A Boolean value: true or false.

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

A distribution value.

UInt32Value

API documentation for monitoring_v3.types.UInt32Value class.

UInt64Value

API documentation for monitoring_v3.types.UInt64Value class.

UpdateAlertPolicyRequest

The protocol for the UpdateAlertPolicy request.

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.

UpdateGroupRequest

The UpdateGroup request.

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

UpdateNotificationChannelRequest

The UpdateNotificationChannel request.

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.

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

UpdateServiceRequest

The UpdateService request.

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

UpdateUptimeCheckConfigRequest

The protocol for the UpdateUptimeCheckConfig request.

Required. If an updateMask has been specified, this field gives the values for the set of fields mentioned in the updateMask. If an updateMask has not been given, this Uptime check configuration replaces the current configuration. If a field is mentioned in updateMask but the corresonding field is omitted in this partial Uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server. The following fields can be updated: display_name, http_check, tcp_check, timeout, content_matchers, and selected_regions.

UptimeCheckConfig

This message configures which resources and services to monitor for availability.

A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

The monitored resource <https://cloud.google.com/monitoring/api/resources>__ associated with the configuration. The following monitored resource types are supported for Uptime checks: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer

The type of Uptime check request.

Contains information needed to make a TCP check.

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

UptimeCheckIp

Contains the region, location, and list of IP addresses where checkers in the location run from.

A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.

Value

API documentation for monitoring_v3.types.Value class.

VerifyNotificationChannelRequest

The VerifyNotificationChannel request.

Required. The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have “G-123456” or “TKNZGhhd2EyN3I1MnRnMjRv” (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code).

WindowsBasedSli

A WindowsBasedSli defines good_service as the count of time windows for which the provided service was of good quality. Criteria for determining if service was good are embedded in the window_criterion.

A monitoring filter <https://cloud.google.com/monitoring/api/v3/filters>__ specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

A window is good if the metric’s value is in a good range, averaged across returned streams.

Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.