Module types (0.35.0)

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>__. .. attribute:: alignment_period

The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.

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

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/>__. .. attribute:: name

Required if the policy exists. The resource name for this policy. The format is: :: projects/[PROJECT_ID_OR_NUMBER ]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the [alertPolicies.create][google.monitoring.v3.A lertPolicyService.CreateAlertPolicy] method, do not include the name field in the alerting policy passed as part of the request.

Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition.

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the [NotificationChannel][google.monitoring.v3.NotificationCha nnel] objects that are returned from the [ListNotificationCh annels][google.monitoring.v3.NotificationChannelService.List NotificationChannels] method. The format of the entries in this field is: :: projects/[PROJECT_ID_OR_NUMBER]/notifi cationChannels/[CHANNEL_ID]

A read-only record of the most recent change to 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. .. attribute:: method

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.

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.

Good service is defined to be the count of requests made to this service that return successfully.

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. .. attribute:: name

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

CreateGroupRequest

The CreateGroup request. .. attribute:: name

Required. The project in which to create the group. The format is: :: projects/[PROJECT_ID_OR_NUMBER]

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

CreateMetricDescriptorRequest

The CreateMetricDescriptor request. .. attribute:: name

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

CreateNotificationChannelRequest

The CreateNotificationChannel request. .. attribute:: name

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.

CreateServiceLevelObjectiveRequest

The CreateServiceLevelObjective request. .. attribute:: parent

Required. Resource name of the parent Service. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

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

CreateServiceRequest

The CreateService request. .. attribute:: parent

Required. Resource name of the parent workspace. The format is: :: projects/[PROJECT_ID_OR_NUMBER]

Required. The Service to create.

CreateTimeSeriesError

DEPRECATED. Used to hold per-time-series error status. .. attribute:: time_series

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

CreateTimeSeriesRequest

The CreateTimeSeries request. .. attribute:: name

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

CreateTimeSeriesSummary

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

The number of points in the request.

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

CreateUptimeCheckConfigRequest

The protocol for the CreateUptimeCheckConfig request. .. attribute:: parent

Required. The project in which to create the Uptime check. The format is: :: projects/[PROJECT_ID_OR_NUMBER]

DeleteAlertPolicyRequest

The protocol for the DeleteAlertPolicy request. .. attribute:: name

Required. The alerting policy to delete. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID ] For more information, see AlertPolicy][google.monitoring.v3.AlertPolicy].

DeleteGroupRequest

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

Required. The group to delete. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

DeleteMetricDescriptorRequest

The DeleteMetricDescriptor request. .. attribute:: name

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. .. attribute:: name

Required. The channel for which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notificati onChannels/[CHANNEL_ID]

DeleteServiceLevelObjectiveRequest

The DeleteServiceLevelObjective request. .. attribute:: name

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. .. attribute:: name

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. .. attribute:: name

Required. The Uptime check configuration to delete. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfig s/[UPTIME_CHECK_ID]

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. .. attribute:: distribution_filter

A monitoring filter <https://cloud.google.com/monitoring/api/v3/filters>__ specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE.

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. .. attribute:: label

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

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. .. attribute:: name

Required. The alerting policy to retrieve. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID ]

GetGroupRequest

The GetGroup request. .. attribute:: name

Required. The group to retrieve. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

GetMetricDescriptorRequest

The GetMetricDescriptor request. .. attribute:: name

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. .. attribute:: name

Required. The monitored resource descriptor to get. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/monitoredResource Descriptors/[RESOURCE_TYPE] The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database.

GetNotificationChannelDescriptorRequest

The GetNotificationChannelDescriptor response. .. attribute:: name

Required. The channel type for which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notifi cationChannelDescriptors/[CHANNEL_TYPE]

GetNotificationChannelRequest

The GetNotificationChannel request. .. attribute:: name

Required. The channel for which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notificati onChannels/[CHANNEL_ID]

GetNotificationChannelVerificationCodeRequest

The GetNotificationChannelVerificationCode request. .. attribute:: name

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.

GetNotificationChannelVerificationCodeResponse

The GetNotificationChannelVerificationCode request. .. attribute:: code

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

GetServiceLevelObjectiveRequest

The GetServiceLevelObjective request. .. attribute:: name

Required. Resource name of the ServiceLevelObjective to get. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/s ervices/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

GetServiceRequest

The GetService request. .. attribute:: name

Required. Resource name of the Service. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

GetUptimeCheckConfigRequest

The protocol for the GetUptimeCheckConfig request. .. attribute:: name

Required. The Uptime check configuration to retrieve. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/uptimeChec kConfigs/[UPTIME_CHECK_ID]

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. .. attribute:: name

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.

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

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

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. .. attribute:: name

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 Stackdriver Workspace project for the Uptime check config associated with the internal checker.

The GCP VPC network <https://cloud.google.com/vpc/docs/vpc>__ where the internal resource lives (ex: "default").

The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.

LabelDescriptor

API documentation for monitoring_v3.types.LabelDescriptor class.

LabelValue

A label value. .. attribute:: value

The label value can be a bool, int64, or string.

An int64 label value.

ListAlertPoliciesRequest

The protocol for the ListAlertPolicies request. .. attribute:: name

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][googl e.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation, instead.

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

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. .. attribute:: alert_policies

The returned alert policies.

ListGroupMembersRequest

The ListGroupMembers request. .. attribute:: name

Required. The group whose members are listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

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.

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. .. attribute:: members

A set of monitored resources in the group.

The total number of elements matching this request.

ListGroupsRequest

The ListGroup request. .. attribute:: name

Required. The project whose groups are to be listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER]

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.

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. .. attribute:: group

The groups that match the specified filters.

ListMetricDescriptorsRequest

The ListMetricDescriptors request. .. attribute:: name

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

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

ListMetricDescriptorsResponse

The ListMetricDescriptors response. .. attribute:: metric_descriptors

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

ListMonitoredResourceDescriptorsRequest

The ListMonitoredResourceDescriptors request. .. attribute:: name

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

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

ListMonitoredResourceDescriptorsResponse

The ListMonitoredResourceDescriptors response. .. attribute:: resource_descriptors

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

ListNotificationChannelDescriptorsRequest

The ListNotificationChannelDescriptors request. .. attribute:: name

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][google.monitoring.v3.Notifi cationChannelService.GetNotificationChannelDescriptor] operation, instead.

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. .. attribute:: channel_descriptors

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

ListNotificationChannelsRequest

The ListNotificationChannels request. .. attribute:: name

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 [GetNotifica tionChannel][google.monitoring.v3.NotificationChannelService .GetNotificationChannel] operation.

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

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. .. attribute:: notification_channels

The notification channels defined for the specified project.

ListServiceLevelObjectivesRequest

The ListServiceLevelObjectives request. .. attribute:: parent

Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-

A non-negative number that is the maximum number of results to return. When 0, use default page size.

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. .. attribute:: service_level_objectives

The ServiceLevelObjective\ s matching the specified filter.

ListServicesRequest

The ListServices request. .. attribute:: parent

Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: :: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]

A non-negative number that is the maximum number of results to return. When 0, use default page size.

ListServicesResponse

The ListServices response. .. attribute:: services

The Service\ s matching the specified filter.

ListTimeSeriesRequest

The ListTimeSeries request. .. attribute:: name

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

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.

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

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.

ListTimeSeriesResponse

The ListTimeSeries response. .. attribute:: time_series

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

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

ListUptimeCheckConfigsRequest

The protocol for the ListUptimeCheckConfigs request. .. attribute:: parent

Required. The project whose Uptime check configurations are listed. The format is: :: projects/[PROJECT_ID_OR_NUMBER]

ListUptimeCheckConfigsResponse

The protocol for the ListUptimeCheckConfigs response. .. attribute:: uptime_check_configs

The returned Uptime check configurations.

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

ListUptimeCheckIpsRequest

The protocol for the ListUptimeCheckIps request. .. attribute:: page_size

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

ListUptimeCheckIpsResponse

The protocol for the ListUptimeCheckIps response. .. attribute:: uptime_check_ips

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

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. .. attribute:: mutate_time

When the change occurred.

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. .. attribute:: type

The type of the notification channel. This field matches the value of the [NotificationChannelDescriptor.type][google.monit oring.v3.NotificationChannelDescriptor.type] field.

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.

Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the [Noti ficationChannelDescriptor.labels][google.monitoring.v3.Notific ationChannelDescriptor.labels] of the NotificationChannelDescriptor corresponding to the type field.

Indicates whether this channel has been verified or not. On a [ListNotificationChannels][google.monitoring.v3.Notificati onChannelService.ListNotificationChannels] or [GetNotificati onChannel][google.monitoring.v3.NotificationChannelService.G etNotificationChannel] 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][google.monitoring.v3. NotificationChannelService.UpdateNotificationChannel] operation. To change the value of this field, you must call [`VerifyNotificationChannel][google.monitoring.v3.Notificatio nChannelService.VerifyNotificationChannel].

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. .. attribute:: name

The full REST resource name for this descriptor. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/notificationChann elDescriptors/[TYPE] In the above, [TYPE] is the value of the type field.

A human-readable name for the notification channel type. This form of the name is suitable for a user interface.

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.

The product launch stage for channels of this type.

Point

A single data point in a time series. .. attribute:: interval

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.

QueryError

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

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

QueryErrorList

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

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

QueryTimeSeriesRequest

The QueryTimeSeries request. .. attribute:: name

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

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

QueryTimeSeriesResponse

The QueryTimeSeries response. .. attribute:: time_series_descriptor

The descriptor for the time series data.

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.

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. .. attribute:: min

Range minimum.

RequestBasedSli

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

The means to compute a ratio of good_service to total_service.

\ 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. .. attribute:: name

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

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. .. attribute:: name

Resource name for this Service. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

REQUIRED. Service-identifying atoms specifying the underlying service.

Type used for App Engine services.

Type used for Istio services that live in a Kubernetes cluster.

Configuration for how to query telemetry on a Service.

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. .. attribute:: 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

Request-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." .. attribute:: name

Resource name for this ServiceLevelObjective. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE _ID]/serviceLevelObjectives/[SLO_NAME]

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.

The time period over which the objective will be evaluated.

A calendar period, semantically "since the start of the current <calendar_period>". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.

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] .. attribute:: span_name

The resource name of the span. The format is: :: project s/[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.

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". .. attribute:: source

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

The position of the last byte within the text.

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.

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/v 3/projects.metricDescriptors#MetricKind>__ of the metric value. In no case can the end time be earlier than the start time. - For aGAUGEmetric, thestartTimevalue 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 forGAUGEmetrics, which are point-in-time measurements. - ForDELTAandCUMULATIVE` 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. .. attribute:: end_time

Required. The end of the time interval.

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. .. attribute:: metric

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

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

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

TimeSeriesData

Represents the values of a time series associated with a TimeSeriesDescriptor. .. attribute:: label_values

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.

TimeSeriesDescriptor

A descriptor for the labels and points in a timeseries. .. attribute:: label_descriptors

Descriptors for the labels.

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. .. attribute:: good_service_filter

A monitoring filter <https://cloud.google.com/monitoring/api/v3/filters>__ specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.

A monitoring filter <https://cloud.google.com/monitoring/api/v3/filters>__ specifying a TimeSeries quantifying total demanded service. 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. .. attribute:: value

The typed value field.

A 64-bit integer. Its range is approximately ±9.2x1018.

A variable-length string 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. .. attribute:: 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.

UpdateGroupRequest

The UpdateGroup request. .. attribute:: 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.

UpdateNotificationChannelRequest

The UpdateNotificationChannel request. .. attribute:: update_mask

The fields to update.

UpdateServiceLevelObjectiveRequest

The UpdateServiceLevelObjective request. .. attribute:: service_level_objective

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

UpdateServiceRequest

The UpdateService request. .. attribute:: service

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

UpdateUptimeCheckConfigRequest

The protocol for the UpdateUptimeCheckConfig request. .. attribute:: update_mask

Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.

UptimeCheckConfig

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

A unique resource name for this Uptime check configuration. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/uptim eCheckConfigs/[UPTIME_CHECK_ID] This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

The resource the check is checking. Required.

The group resource associated with the configuration.

Contains information needed to make an HTTP or HTTPS check.

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

UptimeCheckIp

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

A broad region category in which the IP address is located.

The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format.

A window is good if its performance is high enough.

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