Movatterモバイル変換


[0]ホーム

URL:


monitoring

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:585

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package monitoring provides access to the Cloud Monitoring API.

This package is DEPRECATED. Use package cloud.google.com/go/monitoring/apiv3 instead.

For product documentation, see:https://cloud.google.com/monitoring/api/

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/monitoring/v3"...ctx := context.Background()monitoringService, err := monitoring.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

monitoringService, err := monitoring.NewService(ctx, option.WithScopes(monitoring.MonitoringWriteScope))

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

monitoringService, err := monitoring.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)monitoringService, err := monitoring.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"// View and write monitoring data for all of your Google and third-party Cloud// and API projectsMonitoringScope = "https://www.googleapis.com/auth/monitoring"// View monitoring data for all of your Google Cloud and third-party projectsMonitoringReadScope = "https://www.googleapis.com/auth/monitoring.read"// Publish metric data to your Google Cloud projectsMonitoringWriteScope = "https://www.googleapis.com/auth/monitoring.write")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAggregation

type Aggregation struct {// AlignmentPeriod: The alignment_period specifies a time interval, in seconds,// that is used to divide the data in all the time series into consistent// blocks of time. This will be done before the per-series aligner can be// applied to the data.The value must be at least 60 seconds. If a per-series// aligner other than ALIGN_NONE is specified, this field is required or an// error is returned. If no per-series aligner is specified, or the aligner// ALIGN_NONE is specified, then this field is ignored.The maximum value of the// alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25// hours) for alerting policies.AlignmentPeriodstring `json:"alignmentPeriod,omitempty"`// CrossSeriesReducer: 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.//// Possible values://   "REDUCE_NONE" - No cross-time series reduction. The output of the Aligner// is returned.//   "REDUCE_MEAN" - Reduce by computing the mean value across time series for// each alignment period. This reducer is valid for DELTA and GAUGE metrics// with numeric or distribution values. The value_type of the output is DOUBLE.//   "REDUCE_MIN" - Reduce by computing the minimum value across time series// for each alignment period. This reducer is valid for DELTA and GAUGE metrics// with numeric values. The value_type of the output is the same as the// value_type of the input.//   "REDUCE_MAX" - Reduce by computing the maximum value across time series// for each alignment period. This reducer is valid for DELTA and GAUGE metrics// with numeric values. The value_type of the output is the same as the// value_type of the input.//   "REDUCE_SUM" - Reduce by computing the sum across time series for each// alignment period. This reducer is valid for DELTA and GAUGE metrics with// numeric and distribution values. The value_type of the output is the same as// the value_type of the input.//   "REDUCE_STDDEV" - Reduce by computing the standard deviation across time// series for each alignment period. This reducer is valid for DELTA and GAUGE// metrics with numeric or distribution values. The value_type of the output is// DOUBLE.//   "REDUCE_COUNT" - Reduce by computing the number of data points across time// series for each alignment period. This reducer is valid for DELTA and GAUGE// metrics of numeric, Boolean, distribution, and string value_type. The// value_type of the output is INT64.//   "REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data// points across time series for each alignment period. This reducer is valid// for DELTA and GAUGE metrics of Boolean value_type. The value_type of the// output is INT64.//   "REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data// points across time series for each alignment period. This reducer is valid// for DELTA and GAUGE metrics of Boolean value_type. The value_type of the// output is INT64.//   "REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of// True-valued data points to the total number of data points for each// alignment period. This reducer is valid for DELTA and GAUGE metrics of// Boolean value_type. The output value is in the range 0.0, 1.0 and has// value_type DOUBLE.//   "REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile// (https://en.wikipedia.org/wiki/Percentile) of data points across time series// for each alignment period. This reducer is valid for GAUGE and DELTA metrics// of numeric and distribution type. The value of the output is DOUBLE.//   "REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile// (https://en.wikipedia.org/wiki/Percentile) of data points across time series// for each alignment period. This reducer is valid for GAUGE and DELTA metrics// of numeric and distribution type. The value of the output is DOUBLE.//   "REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile// (https://en.wikipedia.org/wiki/Percentile) of data points across time series// for each alignment period. This reducer is valid for GAUGE and DELTA metrics// of numeric and distribution type. The value of the output is DOUBLE.//   "REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile// (https://en.wikipedia.org/wiki/Percentile) of data points across time series// for each alignment period. This reducer is valid for GAUGE and DELTA metrics// of numeric and distribution type. The value of the output is DOUBLE.CrossSeriesReducerstring `json:"crossSeriesReducer,omitempty"`// GroupByFields: 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.GroupByFields []string `json:"groupByFields,omitempty"`// PerSeriesAligner: 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.//// Possible values://   "ALIGN_NONE" - No alignment. Raw data is returned. Not valid if// cross-series reduction is requested. The value_type of the result is the// same as the value_type of the input.//   "ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -// y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected// alignment period results in periods with no data, then the aligned value for// such a period is created by interpolation. The value_type of the aligned// result is the same as the value_type of the input.//   "ALIGN_RATE" - Align and convert to a rate. The result is computed as rate// = (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner as// providing the slope of the line that passes through the value at the start// and at the end of the alignment_period.This aligner is valid for CUMULATIVE// and DELTA metrics with numeric values. If the selected alignment period// results in periods with no data, then the aligned value for such a period is// created by interpolation. The output is a GAUGE metric with value_type// DOUBLE.If, by "rate", you mean "percentage change", see the// ALIGN_PERCENT_CHANGE aligner instead.//   "ALIGN_INTERPOLATE" - Align by interpolating between adjacent points// around the alignment period boundary. This aligner is valid for GAUGE// metrics with numeric values. The value_type of the aligned result is the// same as the value_type of the input.//   "ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the// end of the alignment period to the boundary at the end of the alignment// period. This aligner is valid for GAUGE metrics. The value_type of the// aligned result is the same as the value_type of the input.//   "ALIGN_MIN" - Align the time series by returning the minimum value in each// alignment period. This aligner is valid for GAUGE and DELTA metrics with// numeric values. The value_type of the aligned result is the same as the// value_type of the input.//   "ALIGN_MAX" - Align the time series by returning the maximum value in each// alignment period. This aligner is valid for GAUGE and DELTA metrics with// numeric values. The value_type of the aligned result is the same as the// value_type of the input.//   "ALIGN_MEAN" - Align the time series by returning the mean value in each// alignment period. This aligner is valid for GAUGE and DELTA metrics with// numeric values. The value_type of the aligned result is DOUBLE.//   "ALIGN_COUNT" - Align the time series by returning the number of values in// each alignment period. This aligner is valid for GAUGE and DELTA metrics// with numeric or Boolean values. The value_type of the aligned result is// INT64.//   "ALIGN_SUM" - Align the time series by returning the sum of the values in// each alignment period. This aligner is valid for GAUGE and DELTA metrics// with numeric and distribution values. The value_type of the aligned result// is the same as the value_type of the input.//   "ALIGN_STDDEV" - Align the time series by returning the standard deviation// of the values in each alignment period. This aligner is valid for GAUGE and// DELTA metrics with numeric values. The value_type of the output is DOUBLE.//   "ALIGN_COUNT_TRUE" - Align the time series by returning the number of True// values in each alignment period. This aligner is valid for GAUGE metrics// with Boolean values. The value_type of the output is INT64.//   "ALIGN_COUNT_FALSE" - Align the time series by returning the number of// False values in each alignment period. This aligner is valid for GAUGE// metrics with Boolean values. The value_type of the output is INT64.//   "ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of// the number of True values to the total number of values in each alignment// period. This aligner is valid for GAUGE metrics with Boolean values. The// output value is in the range 0.0, 1.0 and has value_type DOUBLE.//   "ALIGN_PERCENTILE_99" - Align the time series by using percentile// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data// point in each alignment period is the 99th percentile of all data points in// the period. This aligner is valid for GAUGE and DELTA metrics with// distribution values. The output is a GAUGE metric with value_type DOUBLE.//   "ALIGN_PERCENTILE_95" - Align the time series by using percentile// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data// point in each alignment period is the 95th percentile of all data points in// the period. This aligner is valid for GAUGE and DELTA metrics with// distribution values. The output is a GAUGE metric with value_type DOUBLE.//   "ALIGN_PERCENTILE_50" - Align the time series by using percentile// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data// point in each alignment period is the 50th percentile of all data points in// the period. This aligner is valid for GAUGE and DELTA metrics with// distribution values. The output is a GAUGE metric with value_type DOUBLE.//   "ALIGN_PERCENTILE_05" - Align the time series by using percentile// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data// point in each alignment period is the 5th percentile of all data points in// the period. This aligner is valid for GAUGE and DELTA metrics with// distribution values. The output is a GAUGE metric with value_type DOUBLE.//   "ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This// aligner is valid for GAUGE and DELTA metrics with numeric values. This// alignment returns ((current - previous)/previous) * 100, where the value of// previous is determined based on the alignment_period.If the values of// current and previous are both 0, then the returned value is 0. If only// previous is 0, the returned value is infinity.A 10-minute moving mean is// computed at each point of the alignment period prior to the above// calculation to smooth the metric and prevent false positives from very// short-lived spikes. The moving mean is only applicable for data whose values// are >= 0. Any values < 0 are treated as a missing datapoint, and are// ignored. While DELTA metrics are accepted by this alignment, special care// should be taken that the values for the metric will always be positive. The// output is a GAUGE metric with value_type DOUBLE.PerSeriesAlignerstring `json:"perSeriesAligner,omitempty"`// ForceSendFields is a list of field names (e.g. "AlignmentPeriod") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlignmentPeriod") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Aggregation: Describes how to combine multiple time series to provide adifferent 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 intervalboundaries, then the set of time series is optionally reduced innumber.Alignment consists of applying the per_series_aligner operation toeach time series after its data has been divided into regularalignment_period time intervals. This process takes all of the data pointsin an alignment period, applies a mathematical transformation such asaveraging, minimum, maximum, delta, etc., and converts them into a singledata point per period.Reduction is when the aligned and transformed timeseries can optionally be combined, reducing the number of time seriesthrough similar mathematical transformations. Reduction involves applying across_series_reducer to all the time series, optionally sorting the timeseries into subsets with group_by_fields, and applying the reducer to eachsubset.The raw time series data can contain a huge amount of informationfrom multiple sources. Alignment and reduction transforms this mass of datainto a more manageable and representative collection of data, for example"the 95% latency across the average of all tasks in a cluster". Thisrepresentative data can be more easily graphed and comprehended, and theindividual time series data is still available for later drilldown. For moredetails, see Filtering and aggregation(https://cloud.google.com/monitoring/api/v3/aggregation).

func (Aggregation)MarshalJSON

func (sAggregation) MarshalJSON() ([]byte,error)

typeAlertadded inv0.253.0

type Alert struct {// CloseTime: The time when the alert was closed.CloseTimestring `json:"closeTime,omitempty"`// Log: The log information associated with the alert. This field is only// populated for log-based alerts.Log *LogMetadata `json:"log,omitempty"`// Metadata: The metadata of the monitored resource.Metadata *MonitoredResourceMetadata `json:"metadata,omitempty"`// Metric: The metric type and any metric labels preserved from the incident's// generating condition.Metric *Metric `json:"metric,omitempty"`// Name: Identifier. The name of the alert.The format is:// projects/[PROJECT_ID_OR_NUMBER]/alerts/[ALERT_ID] The [ALERT_ID] is a// system-assigned unique identifier for the alert.Namestring `json:"name,omitempty"`// OpenTime: The time when the alert was opened.OpenTimestring `json:"openTime,omitempty"`// Policy: The snapshot of the alert policy that generated this alert.Policy *PolicySnapshot `json:"policy,omitempty"`// Resource: The monitored resource type and any monitored resource labels// preserved from the incident's generating condition.Resource *MonitoredResource `json:"resource,omitempty"`// State: Output only. The current state of the alert.//// Possible values://   "STATE_UNSPECIFIED" - The alert state is unspecified.//   "OPEN" - The alert is open.//   "CLOSED" - The alert is closed.Statestring `json:"state,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CloseTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CloseTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Alert: An alert is the representation of a violation of an alert policy. Itis a read-only resource that cannot be modified by the accompanied API.

func (Alert)MarshalJSONadded inv0.253.0

func (sAlert) MarshalJSON() ([]byte,error)

typeAlertPolicy

type AlertPolicy struct {// AlertStrategy: Control over how this alerting policy's notification channels// are notified.AlertStrategy *AlertStrategy `json:"alertStrategy,omitempty"`// Combiner: 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.//// Possible values://   "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.Combinerstring `json:"combiner,omitempty"`// Conditions: 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. If condition_monitoring_query_language is present, it// must be the only condition.Conditions []*Condition `json:"conditions,omitempty"`// CreationRecord: 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.CreationRecord *MutationRecord `json:"creationRecord,omitempty"`// DisplayName: 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.The convention for the display_name of a// PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where// the {rule group name} and {alert name} should be taken from the// corresponding Prometheus configuration file. This convention is not// enforced. In any case the display_name is not a unique key of the// AlertPolicy.DisplayNamestring `json:"displayName,omitempty"`// Documentation: 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.Documentation *Documentation `json:"documentation,omitempty"`// Enabled: 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.Enabledbool `json:"enabled,omitempty"`// MutationRecord: 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.MutationRecord *MutationRecord `json:"mutationRecord,omitempty"`// Name: Identifier. 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 Cloud Monitoring when the policy is// created. When calling the alertPolicies.create method, do not include the// name field in the alerting policy passed as part of the request.Namestring `json:"name,omitempty"`// NotificationChannels: 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 objects// that are returned from the ListNotificationChannels method. The format of// the entries in this field is:// projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]NotificationChannels []string `json:"notificationChannels,omitempty"`// Severity: Optional. The severity of an alerting policy indicates how// important incidents generated by that policy are. The severity level will be// displayed on the Incident detail page and in notifications.//// Possible values://   "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.Severitystring `json:"severity,omitempty"`// UserLabels: 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.Note that// Prometheus {alert name} is a valid Prometheus label names// (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels),// whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means// that they cannot be stored as-is in user labels, because they may contain// characters that are not allowed in user-label values.UserLabels map[string]string `json:"userLabels,omitempty"`// Validity: Read-only description of how the alerting policy is invalid. This// field is only set when the alerting policy is invalid. An invalid alerting// policy will not generate incidents.Validity *Status `json:"validity,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AlertStrategy") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlertStrategy") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AlertPolicy: A description of the conditions under which some aspect of yoursystem is considered to be "unhealthy" and the ways to notify people orservices about this state. For an overview of alerting policies, seeIntroduction to Alerting (https://cloud.google.com/monitoring/alerts/).

func (AlertPolicy)MarshalJSON

func (sAlertPolicy) MarshalJSON() ([]byte,error)

typeAlertStrategyadded inv0.51.0

type AlertStrategy struct {// AutoClose: If an alerting policy that was active has no data for this long,// any open incidents will closeAutoClosestring `json:"autoClose,omitempty"`// NotificationChannelStrategy: Control how notifications will be sent out, on// a per-channel basis.NotificationChannelStrategy []*NotificationChannelStrategy `json:"notificationChannelStrategy,omitempty"`// NotificationPrompts: For log-based alert policies, the notification prompts// is always OPENED. For non log-based alert policies, the notification prompts// can be OPENED or OPENED, CLOSED.//// Possible values://   "NOTIFICATION_PROMPT_UNSPECIFIED" - No strategy specified. Treated as// error.//   "OPENED" - Notify when an incident is opened.//   "CLOSED" - Notify when an incident is closed.NotificationPrompts []string `json:"notificationPrompts,omitempty"`// NotificationRateLimit: Required for log-based alerting policies, i.e.// policies with a LogMatch condition.This limit is not implemented for// alerting policies that do not have a LogMatch condition.NotificationRateLimit *NotificationRateLimit `json:"notificationRateLimit,omitempty"`// ForceSendFields is a list of field names (e.g. "AutoClose") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutoClose") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AlertStrategy: Control over how the notification channels innotification_channels are notified when this alert fires.

func (AlertStrategy)MarshalJSONadded inv0.51.0

func (sAlertStrategy) MarshalJSON() ([]byte,error)

typeAppEngineadded inv0.14.0

type AppEngine struct {// ModuleId: The ID of the App Engine module underlying this service.// Corresponds to the module_id resource label in the gae_app monitored// resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app).ModuleIdstring `json:"moduleId,omitempty"`// ForceSendFields is a list of field names (e.g. "ModuleId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ModuleId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

AppEngine: App Engine service. Learn more athttps://cloud.google.com/appengine.

func (AppEngine)MarshalJSONadded inv0.14.0

func (sAppEngine) MarshalJSON() ([]byte,error)

typeAvailabilityCriteriaadded inv0.14.0

type AvailabilityCriteria struct {}

AvailabilityCriteria: Future parameters for the availability SLI.

typeBasicAuthentication

type BasicAuthentication struct {// Password: The password to use when authenticating with the HTTP server.Passwordstring `json:"password,omitempty"`// Username: The username to use when authenticating with the HTTP server.Usernamestring `json:"username,omitempty"`// ForceSendFields is a list of field names (e.g. "Password") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Password") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BasicAuthentication: The authentication parameters to provide to thespecified resource or URL that requires a username and password. Currently,only Basic HTTP authentication (https://tools.ietf.org/html/rfc7617) issupported in Uptime checks.

func (BasicAuthentication)MarshalJSON

func (sBasicAuthentication) MarshalJSON() ([]byte,error)

typeBasicServiceadded inv0.100.0

type BasicService struct {// ServiceLabels: 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// (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).ServiceLabels map[string]string `json:"serviceLabels,omitempty"`// ServiceType: The type of service that this basic service defines, e.g.// APP_ENGINE service type. Documentation and valid values here// (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).ServiceTypestring `json:"serviceType,omitempty"`// ForceSendFields is a list of field names (e.g. "ServiceLabels") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ServiceLabels") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BasicService: A well-known service type, defined by its service type andservice labels. Documentation and examples here(https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).

func (BasicService)MarshalJSONadded inv0.100.0

func (sBasicService) MarshalJSON() ([]byte,error)

typeBasicSliadded inv0.14.0

type BasicSli struct {// Availability: Good service is defined to be the count of requests made to// this service that return successfully.Availability *AvailabilityCriteria `json:"availability,omitempty"`// Latency: Good service is defined to be the count of requests made to this// service that are fast enough with respect to latency.threshold.Latency *LatencyCriteria `json:"latency,omitempty"`// Location: 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.Location []string `json:"location,omitempty"`// 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.Method []string `json:"method,omitempty"`// Version: 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.Version []string `json:"version,omitempty"`// ForceSendFields is a list of field names (e.g. "Availability") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Availability") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (BasicSli)MarshalJSONadded inv0.14.0

func (sBasicSli) MarshalJSON() ([]byte,error)

typeBooleanTestadded inv0.200.0

type BooleanTest struct {// Column: Required. The name of the column containing the boolean value. If// the value in a row is NULL, that row is ignored.Columnstring `json:"column,omitempty"`// ForceSendFields is a list of field names (e.g. "Column") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Column") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BooleanTest: A test that uses an alerting result in a boolean columnproduced by the SQL query.

func (BooleanTest)MarshalJSONadded inv0.200.0

func (sBooleanTest) MarshalJSON() ([]byte,error)

typeBucketOptions

type BucketOptions struct {// ExplicitBuckets: The explicit buckets.ExplicitBuckets *Explicit `json:"explicitBuckets,omitempty"`// ExponentialBuckets: The exponential buckets.ExponentialBuckets *Exponential `json:"exponentialBuckets,omitempty"`// LinearBuckets: The linear bucket.LinearBuckets *Linear `json:"linearBuckets,omitempty"`// ForceSendFields is a list of field names (e.g. "ExplicitBuckets") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExplicitBuckets") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

BucketOptions: BucketOptions describes the bucket boundaries used to createa histogram for the distribution. The buckets can be in a linear sequence,an exponential sequence, or each bucket can be specified explicitly.BucketOptions does not include the number of values in each bucket.A buckethas an inclusive lower bound and exclusive upper bound for the values thatare counted for that bucket. The upper bound of a bucket must be strictlygreater than the lower bound. The sequence of N buckets for a distributionconsists of an underflow bucket (number 0), zero or more finite buckets(number 1 through N - 2) and an overflow bucket (number N - 1). The bucketsare contiguous: the lower bound of bucket i (i > 0) is the same as the upperbound of bucket i - 1. The buckets span the whole range of finite values:lower bound of the underflow bucket is -infinity and the upper bound of theoverflow bucket is +infinity. The finite buckets are so-called because bothbounds are finite.

func (BucketOptions)MarshalJSON

func (sBucketOptions) MarshalJSON() ([]byte,error)

typeCloudEndpointsadded inv0.14.0

type CloudEndpoints struct {// Service: The name of the Cloud Endpoints service underlying this service.// Corresponds to the service resource label in the api monitored resource// (https://cloud.google.com/monitoring/api/resources#tag_api).Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "Service") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Service") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudEndpoints: Cloud Endpoints service. Learn more athttps://cloud.google.com/endpoints.

func (CloudEndpoints)MarshalJSONadded inv0.14.0

func (sCloudEndpoints) MarshalJSON() ([]byte,error)

typeCloudFunctionV2Targetadded inv0.133.0

type CloudFunctionV2Target struct {// CloudRunRevision: 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.CloudRunRevision *MonitoredResource `json:"cloudRunRevision,omitempty"`// Name: Required. Fully qualified GCFv2 resource name i.e.// projects/{project}/locations/{location}/functions/{function} Required.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "CloudRunRevision") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CloudRunRevision") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudFunctionV2Target: A Synthetic Monitor deployed to a Cloud Functions V2instance.

func (CloudFunctionV2Target)MarshalJSONadded inv0.133.0

func (sCloudFunctionV2Target) MarshalJSON() ([]byte,error)

typeCloudRunadded inv0.80.0

type CloudRun struct {// Location: The location the service is run. Corresponds to the location// resource label in the cloud_run_revision monitored resource// (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).Locationstring `json:"location,omitempty"`// ServiceName: The name of the Cloud Run service. Corresponds to the// service_name resource label in the cloud_run_revision monitored resource// (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).ServiceNamestring `json:"serviceName,omitempty"`// ForceSendFields is a list of field names (e.g. "Location") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Location") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CloudRun: Cloud Run service. Learn more athttps://cloud.google.com/run.

func (CloudRun)MarshalJSONadded inv0.80.0

func (sCloudRun) MarshalJSON() ([]byte,error)

typeClusterIstioadded inv0.14.0

type ClusterIstio struct {// ClusterName: The name of the Kubernetes cluster in which this Istio service// is defined. Corresponds to the cluster_name resource label in k8s_cluster// resources.ClusterNamestring `json:"clusterName,omitempty"`// Location: The location of the Kubernetes cluster in which this Istio service// is defined. Corresponds to the location resource label in k8s_cluster// resources.Locationstring `json:"location,omitempty"`// ServiceName: The name of the Istio service underlying this service.// Corresponds to the destination_service_name metric label in Istio metrics.ServiceNamestring `json:"serviceName,omitempty"`// ServiceNamespace: The namespace of the Istio service underlying this// service. Corresponds to the destination_service_namespace metric label in// Istio metrics.ServiceNamespacestring `json:"serviceNamespace,omitempty"`// ForceSendFields is a list of field names (e.g. "ClusterName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClusterName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ClusterIstio: Istio service scoped to a single Kubernetes cluster. Learnmore athttps://istio.io. Clusters running OSS Istio will have theirservices ingested as this type.

func (ClusterIstio)MarshalJSONadded inv0.14.0

func (sClusterIstio) MarshalJSON() ([]byte,error)

typeCollectdPayload

type CollectdPayload struct {// EndTime: The end time of the interval.EndTimestring `json:"endTime,omitempty"`// Metadata: The measurement metadata. Example: "process_id" -> 12345Metadata map[string]TypedValue `json:"metadata,omitempty"`// Plugin: The name of the plugin. Example: "disk".Pluginstring `json:"plugin,omitempty"`// PluginInstance: The instance name of the plugin Example: "hdcl".PluginInstancestring `json:"pluginInstance,omitempty"`// StartTime: The start time of the interval.StartTimestring `json:"startTime,omitempty"`// Type: The measurement type. Example: "memory".Typestring `json:"type,omitempty"`// TypeInstance: The measurement type instance. Example: "used".TypeInstancestring `json:"typeInstance,omitempty"`// Values: The measured values during this time interval. Each value must have// a different data_source_name.Values []*CollectdValue `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CollectdPayload: A collection of data points sent from a collectd-basedplugin. See the collectd documentation for more information.

func (CollectdPayload)MarshalJSON

func (sCollectdPayload) MarshalJSON() ([]byte,error)

typeCollectdPayloadError

type CollectdPayloadError struct {// Error: Records the error status for the payload. If this field is present,// the partial errors for nested values won't be populated.Error *Status `json:"error,omitempty"`// Index: The zero-based index in// CreateCollectdTimeSeriesRequest.collectd_payloads.Indexint64 `json:"index,omitempty"`// ValueErrors: Records the error status for values that were not written due// to an error.Failed payloads for which nothing is written will not include// partial value errors.ValueErrors []*CollectdValueError `json:"valueErrors,omitempty"`// ForceSendFields is a list of field names (e.g. "Error") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Error") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CollectdPayloadError: Describes the error status for payloads that were notwritten.

func (CollectdPayloadError)MarshalJSON

func (sCollectdPayloadError) MarshalJSON() ([]byte,error)

typeCollectdValue

type CollectdValue struct {// DataSourceName: The data source for the collectd value. For example, there// are two data sources for network measurements: "rx" and "tx".DataSourceNamestring `json:"dataSourceName,omitempty"`// DataSourceType: The type of measurement.//// Possible values://   "UNSPECIFIED_DATA_SOURCE_TYPE" - An unspecified data source type. This// corresponds to// google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.//   "GAUGE" - An instantaneous measurement of a varying quantity. This// corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.//   "COUNTER" - A cumulative value over time. This corresponds to// google.api.MetricDescriptor.MetricKind.CUMULATIVE.//   "DERIVE" - A rate of change of the measurement.//   "ABSOLUTE" - An amount of change since the last measurement interval. This// corresponds to google.api.MetricDescriptor.MetricKind.DELTA.DataSourceTypestring `json:"dataSourceType,omitempty"`// Value: The measurement value.Value *TypedValue `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "DataSourceName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataSourceName") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CollectdValue: A single data point from a collectd-based plugin.

func (CollectdValue)MarshalJSON

func (sCollectdValue) MarshalJSON() ([]byte,error)

typeCollectdValueError

type CollectdValueError struct {// Error: Records the error status for the value.Error *Status `json:"error,omitempty"`// Index: The zero-based index in CollectdPayload.values within the parent// CreateCollectdTimeSeriesRequest.collectd_payloads.Indexint64 `json:"index,omitempty"`// ForceSendFields is a list of field names (e.g. "Error") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Error") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CollectdValueError: Describes the error status for values that were notwritten.

func (CollectdValueError)MarshalJSON

func (sCollectdValueError) MarshalJSON() ([]byte,error)

typeCondition

type Condition struct {// ConditionAbsent: A condition that checks that a time series continues to// receive new data points.ConditionAbsent *MetricAbsence `json:"conditionAbsent,omitempty"`// ConditionMatchedLog: A condition that checks for log messages matching given// constraints. If set, no other conditions can be present.ConditionMatchedLog *LogMatch `json:"conditionMatchedLog,omitempty"`// ConditionMonitoringQueryLanguage: A condition that uses the Monitoring Query// Language to define alerts.ConditionMonitoringQueryLanguage *MonitoringQueryLanguageCondition `json:"conditionMonitoringQueryLanguage,omitempty"`// ConditionPrometheusQueryLanguage: A condition that uses the Prometheus query// language to define alerts.ConditionPrometheusQueryLanguage *PrometheusQueryLanguageCondition `json:"conditionPrometheusQueryLanguage,omitempty"`// ConditionSql: A condition that periodically evaluates a SQL query result.ConditionSql *SqlCondition `json:"conditionSql,omitempty"`// ConditionThreshold: A condition that compares a time series against a// threshold.ConditionThreshold *MetricThreshold `json:"conditionThreshold,omitempty"`// DisplayName: 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.DisplayNamestring `json:"displayName,omitempty"`// Name: Required if the condition exists. The unique resource name for this// condition. Its format is:// projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITI// ON_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.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "ConditionAbsent") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConditionAbsent") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Condition: A condition is a true/false test that determines when an alertingpolicy should open an incident. If a condition evaluates to true, itsignifies that something is wrong.

func (Condition)MarshalJSON

func (sCondition) MarshalJSON() ([]byte,error)

typeContentMatcher

type ContentMatcher struct {// Content: String, regex or JSON content to match. Maximum 1024 bytes. An// empty content string indicates no content matching is to be performed.Contentstring `json:"content,omitempty"`// JsonPathMatcher: Matcher information for MATCHES_JSON_PATH and// NOT_MATCHES_JSON_PATHJsonPathMatcher *JsonPathMatcher `json:"jsonPathMatcher,omitempty"`// Matcher: The type of content matcher that will be applied to the server// output, compared to the content string when the check is run.//// Possible values://   "CONTENT_MATCHER_OPTION_UNSPECIFIED" - No content matcher type specified// (maintained for backward compatibility, but deprecated for future use).// Treated as CONTAINS_STRING.//   "CONTAINS_STRING" - Selects substring matching. The match succeeds if the// output contains the content string. This is the default value for checks// without a matcher option, or where the value of matcher is// CONTENT_MATCHER_OPTION_UNSPECIFIED.//   "NOT_CONTAINS_STRING" - Selects negation of substring matching. The match// succeeds if the output does NOT contain the content string.//   "MATCHES_REGEX" - Selects regular-expression matching. The match succeeds// if the output matches the regular expression specified in the content// string. Regex matching is only supported for HTTP/HTTPS checks.//   "NOT_MATCHES_REGEX" - Selects negation of regular-expression matching. The// match succeeds if the output does NOT match the regular expression specified// in the content string. Regex matching is only supported for HTTP/HTTPS// checks.//   "MATCHES_JSON_PATH" - Selects JSONPath matching. See JsonPathMatcher for// details on when the match succeeds. JSONPath matching is only supported for// HTTP/HTTPS checks.//   "NOT_MATCHES_JSON_PATH" - Selects JSONPath matching. See JsonPathMatcher// for details on when the match succeeds. Succeeds when output does NOT match// as specified. JSONPath is only supported for HTTP/HTTPS checks.Matcherstring `json:"matcher,omitempty"`// ForceSendFields is a list of field names (e.g. "Content") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Content") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ContentMatcher: Optional. Used to perform content matching. This allowsmatching based on substrings and regular expressions, together with theirnegations. Only the first 4 MB of an HTTP or HTTPS check's response (and thefirst 1 MB of a TCP check's response) are examined for purposes of contentmatching.

func (ContentMatcher)MarshalJSON

func (sContentMatcher) MarshalJSON() ([]byte,error)

typeCreateCollectdTimeSeriesRequest

type CreateCollectdTimeSeriesRequest struct {// CollectdPayloads: The collectd payloads representing the time series data.// You must not include more than a single point for each time series, so no// two payloads can have the same values for all of the fields plugin,// plugin_instance, type, and type_instance.CollectdPayloads []*CollectdPayload `json:"collectdPayloads,omitempty"`// CollectdVersion: The version of collectd that collected the data. Example:// "5.3.0-192.el6".CollectdVersionstring `json:"collectdVersion,omitempty"`// Resource: The monitored resource associated with the time series.Resource *MonitoredResource `json:"resource,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectdPayloads") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CollectdPayloads") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CreateCollectdTimeSeriesRequest: The CreateCollectdTimeSeries request.

func (CreateCollectdTimeSeriesRequest)MarshalJSON

func (sCreateCollectdTimeSeriesRequest) MarshalJSON() ([]byte,error)

typeCreateCollectdTimeSeriesResponse

type CreateCollectdTimeSeriesResponse struct {// PayloadErrors: Records the error status for points that were not written due// to an error in the request.Failed requests for which nothing is written will// return an error response instead. Requests where data points were rejected// by the backend will set summary instead.PayloadErrors []*CollectdPayloadError `json:"payloadErrors,omitempty"`// Summary: Aggregate statistics from writing the payloads. This field is// omitted if all points were successfully written, so that the response is// empty. This is for backwards compatibility with clients that log errors on// any non-empty response.Summary *CreateTimeSeriesSummary `json:"summary,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "PayloadErrors") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PayloadErrors") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CreateCollectdTimeSeriesResponse: The CreateCollectdTimeSeries response.

func (CreateCollectdTimeSeriesResponse)MarshalJSON

func (sCreateCollectdTimeSeriesResponse) MarshalJSON() ([]byte,error)

typeCreateTimeSeriesRequest

type CreateTimeSeriesRequest struct {// 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.TimeSeries []*TimeSeries `json:"timeSeries,omitempty"`// ForceSendFields is a list of field names (e.g. "TimeSeries") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TimeSeries") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CreateTimeSeriesRequest: The CreateTimeSeries request.

func (CreateTimeSeriesRequest)MarshalJSON

func (sCreateTimeSeriesRequest) MarshalJSON() ([]byte,error)

typeCreateTimeSeriesSummaryadded inv0.14.0

type CreateTimeSeriesSummary struct {// Errors: The number of points that failed to be written. Order is not// guaranteed.Errors []*Error `json:"errors,omitempty"`// SuccessPointCount: The number of points that were successfully written.SuccessPointCountint64 `json:"successPointCount,omitempty"`// TotalPointCount: The number of points in the request.TotalPointCountint64 `json:"totalPointCount,omitempty"`// ForceSendFields is a list of field names (e.g. "Errors") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Errors") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CreateTimeSeriesSummary: Summary of the result of a failed request to writedata to a time series.

func (CreateTimeSeriesSummary)MarshalJSONadded inv0.14.0

func (sCreateTimeSeriesSummary) MarshalJSON() ([]byte,error)

typeCriteriaadded inv0.105.0

type Criteria struct {// Filter: Optional. When you define a snooze, you can also define a filter for// that snooze. The filter is a string containing one or more key-value pairs.// The string uses the standardhttps://google.aip.dev/160 filter syntax. If// you define a filter for a snooze, then the snooze can only apply to one// alert policy. When the snooze is active, incidents won't be created when the// incident would have key-value pairs (labels) that match those specified by// the filter in the snooze.Snooze filters support resource, metric, and// metadata labels. If multiple labels are used, then they must be connected// with an AND operator. For example, the following filter applies the snooze// to incidents that have a resource label with an instance ID of 1234567890, a// metric label with an instance name of test_group, a metadata user label with// a key of foo and a value of bar, and a metadata system label with a key of// region and a value of us-central1: "filter":// "resource.labels.instance_id=\"1234567890\" AND// metric.labels.instance_name=\"test_group\" AND// metadata.user_labels.foo=\"bar\" AND// metadata.system_labels.region=\"us-central1\""Filterstring `json:"filter,omitempty"`// Policies: 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.// Exactly 1 alert policy is required if filter is specified at the same time.Policies []string `json:"policies,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Criteria)MarshalJSONadded inv0.105.0

func (sCriteria) MarshalJSON() ([]byte,error)

typeCustomadded inv0.14.0

type Custom struct {}

Custom: Use a custom service to designate a service that you want to monitorwhen none of the other service types (like App Engine, Cloud Run, or a GKEtype) matches your intended service.

typeDailyadded inv0.200.0

type Daily struct {// ExecutionTime: 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.ExecutionTime *TimeOfDay `json:"executionTime,omitempty"`// Periodicity: Required. The number of days between runs. Must be greater than// or equal to 1 day and less than or equal to 31 days.Periodicityint64 `json:"periodicity,omitempty"`// ForceSendFields is a list of field names (e.g. "ExecutionTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExecutionTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Daily)MarshalJSONadded inv0.200.0

func (sDaily) MarshalJSON() ([]byte,error)

typeDistribution

type Distribution struct {// BucketCounts: Required in the Cloud Monitoring API v3. The values for each// bucket specified in bucket_options. The sum of the values in bucketCounts// must equal the value in the count field of the Distribution object. The// order of the bucket counts follows the numbering schemes described for the// three bucket types. The underflow bucket has number 0; the finite buckets,// if any, have numbers 1 through N-2; and the overflow bucket has number N-1.// The size of bucket_counts must not be greater than N. If the size is less// than N, then the remaining buckets are assigned values of zero.BucketCountsgoogleapi.Int64s `json:"bucketCounts,omitempty"`// BucketOptions: Required in the Cloud Monitoring API v3. Defines the// histogram bucket boundaries.BucketOptions *BucketOptions `json:"bucketOptions,omitempty"`// Count: The number of values in the population. Must be non-negative. This// value must equal the sum of the values in bucket_counts if a histogram is// provided.Countint64 `json:"count,omitempty,string"`// Exemplars: Must be in increasing order of value field.Exemplars []*Exemplar `json:"exemplars,omitempty"`// Mean: The arithmetic mean of the values in the population. If count is zero// then this field must be zero.Meanfloat64 `json:"mean,omitempty"`// Range: If specified, contains the range of the population values. The field// must not be present if the count is zero. This field is presently ignored by// the Cloud Monitoring API v3.Range *Range `json:"range,omitempty"`// SumOfSquaredDeviation: The sum of squared deviations from the mean of the// values in the population. For values x_i this is: Sumi=1..n ((x_i - mean)^2)// Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition// describes Welford's method for accumulating this sum in one pass.If count is// zero then this field must be zero.SumOfSquaredDeviationfloat64 `json:"sumOfSquaredDeviation,omitempty"`// ForceSendFields is a list of field names (e.g. "BucketCounts") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BucketCounts") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Distribution: Distribution contains summary statistics for a population ofvalues. It optionally contains a histogram representing the distribution ofthose values across a set of buckets.The summary statistics are the count,mean, sum of the squared deviation from the mean, the minimum, and themaximum of the set of population of values. The histogram is based on asequence of buckets and gives a count of values that fall into each bucket.The boundaries of the buckets are given either explicitly or by formulas forbuckets of fixed or exponentially increasing widths.Although it is notforbidden, it is generally a bad idea to include non-finite values(infinities or NaNs) in the population of values, as this will render themean and sum_of_squared_deviation fields meaningless.

func (Distribution)MarshalJSON

func (sDistribution) MarshalJSON() ([]byte,error)

func (*Distribution)UnmarshalJSON

func (s *Distribution) UnmarshalJSON(data []byte)error

typeDistributionCutadded inv0.14.0

type DistributionCut struct {// DistributionFilter: 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.DistributionFilterstring `json:"distributionFilter,omitempty"`// Range: Range of values considered "good." For a one-sided range, set one// bound to an infinite value.Range *GoogleMonitoringV3Range `json:"range,omitempty"`// ForceSendFields is a list of field names (e.g. "DistributionFilter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DistributionFilter") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (DistributionCut)MarshalJSONadded inv0.14.0

func (sDistributionCut) MarshalJSON() ([]byte,error)

typeDocumentation

type Documentation struct {// Content: 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// (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).Contentstring `json:"content,omitempty"`// Links: Optional. Links to content such as playbooks, repositories, and other// resources. This field can contain up to 3 entries.Links []*Link `json:"links,omitempty"`// MimeType: The format of the content field. Presently, only the value// "text/markdown" is supported. See Markdown// (https://en.wikipedia.org/wiki/Markdown) for more information.MimeTypestring `json:"mimeType,omitempty"`// Subject: 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// (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit).// 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// (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). If this// field is missing or empty, a default subject line will be generated.Subjectstring `json:"subject,omitempty"`// ForceSendFields is a list of field names (e.g. "Content") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Content") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Documentation: Documentation that is included in the notifications andincidents pertaining to this policy.

func (Documentation)MarshalJSON

func (sDocumentation) MarshalJSON() ([]byte,error)

typeDroppedLabels

type DroppedLabels struct {// Label: Map from label to its value, for all labels dropped in any// aggregation.Label map[string]string `json:"label,omitempty"`// ForceSendFields is a list of field names (e.g. "Label") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Label") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DroppedLabels: A set of (label, value) pairs that were removed from aDistribution time series during aggregation and then added as an attachmentto a Distribution.Exemplar.The full label set for the exemplars isconstructed by using the dropped pairs in combination with the label valuesthat remain on the aggregated Distribution time series. The constructed fulllabel set can be used to identify the specific entity, such as the instanceor job, which might be contributing to a long-tail. However, with droppedlabels, the storage requirements are reduced because only the aggregateddistribution values for a large group of time series are stored.Note thatthere are no guarantees on ordering of the labels from exemplar-to-exemplarand from distribution-to-distribution in the same stream, and there may beduplicates. It is up to clients to resolve any ambiguities.

func (DroppedLabels)MarshalJSON

func (sDroppedLabels) MarshalJSON() ([]byte,error)

typeEmpty

type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeErroradded inv0.14.0

type Error struct {// PointCount: The number of points that couldn't be written because of status.PointCountint64 `json:"pointCount,omitempty"`// Status: The status of the requested write operation.Status *Status `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "PointCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PointCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Error: Detailed information about an error category.

func (Error)MarshalJSONadded inv0.14.0

func (sError) MarshalJSON() ([]byte,error)

typeExemplar

type Exemplar struct {// Attachments: Contextual information about the example value. Examples// are:Trace: type.googleapis.com/google.monitoring.v3.SpanContextLiteral// string: type.googleapis.com/google.protobuf.StringValueLabels dropped during// aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere may// be only a single attachment of any given message type in a single exemplar,// and this is enforced by the system.Attachments []googleapi.RawMessage `json:"attachments,omitempty"`// Timestamp: The observation (sampling) time of the above value.Timestampstring `json:"timestamp,omitempty"`// Value: Value of the exemplar point. This value determines to which bucket// the exemplar belongs.Valuefloat64 `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Attachments") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attachments") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Exemplar: Exemplars are example points that may be used to annotateaggregated distribution values. They are metadata that gives informationabout a particular value added to a Distribution bucket, such as a trace IDthat was active when a value was added. They may contain furtherinformation, such as a example values and timestamps, origin, etc.

func (Exemplar)MarshalJSON

func (sExemplar) MarshalJSON() ([]byte,error)

func (*Exemplar)UnmarshalJSON

func (s *Exemplar) UnmarshalJSON(data []byte)error

typeExplicit

type Explicit struct {// Bounds: The values must be monotonically increasing.Bounds []float64 `json:"bounds,omitempty"`// ForceSendFields is a list of field names (e.g. "Bounds") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Bounds") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Explicit: Specifies a set of buckets with arbitrary widths.There aresize(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upperbound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1Thebounds field must contain at least one element. If bounds has only oneelement, then there are no finite buckets, and that single element is thecommon boundary of the overflow and underflow buckets.

func (Explicit)MarshalJSON

func (sExplicit) MarshalJSON() ([]byte,error)

func (*Explicit)UnmarshalJSONadded inv0.122.0

func (s *Explicit) UnmarshalJSON(data []byte)error

typeExponential

type Exponential struct {// GrowthFactor: Must be greater than 1.GrowthFactorfloat64 `json:"growthFactor,omitempty"`// NumFiniteBuckets: Must be greater than 0.NumFiniteBucketsint64 `json:"numFiniteBuckets,omitempty"`// Scale: Must be greater than 0.Scalefloat64 `json:"scale,omitempty"`// ForceSendFields is a list of field names (e.g. "GrowthFactor") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GrowthFactor") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Exponential: Specifies an exponential sequence of buckets that have a widththat is proportional to the value of the lower bound. Each bucket representsa constant relative uncertainty on a specific value in the bucket.There arenum_finite_buckets + 2 (= N) buckets. Bucket i has the followingboundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).Lowerbound (1 <= i < N): scale * (growth_factor ^ (i - 1)).

func (Exponential)MarshalJSON

func (sExponential) MarshalJSON() ([]byte,error)

func (*Exponential)UnmarshalJSON

func (s *Exponential) UnmarshalJSON(data []byte)error

typeField

type Field struct {// Cardinality: The field cardinality.//// Possible values://   "CARDINALITY_UNKNOWN" - For fields with unknown cardinality.//   "CARDINALITY_OPTIONAL" - For optional fields.//   "CARDINALITY_REQUIRED" - For required fields. Proto2 syntax only.//   "CARDINALITY_REPEATED" - For repeated fields.Cardinalitystring `json:"cardinality,omitempty"`// DefaultValue: The string value of the default value of this field. Proto2// syntax only.DefaultValuestring `json:"defaultValue,omitempty"`// JsonName: The field JSON name.JsonNamestring `json:"jsonName,omitempty"`// Kind: The field type.//// Possible values://   "TYPE_UNKNOWN" - Field type unknown.//   "TYPE_DOUBLE" - Field type double.//   "TYPE_FLOAT" - Field type float.//   "TYPE_INT64" - Field type int64.//   "TYPE_UINT64" - Field type uint64.//   "TYPE_INT32" - Field type int32.//   "TYPE_FIXED64" - Field type fixed64.//   "TYPE_FIXED32" - Field type fixed32.//   "TYPE_BOOL" - Field type bool.//   "TYPE_STRING" - Field type string.//   "TYPE_GROUP" - Field type group. Proto2 syntax only, and deprecated.//   "TYPE_MESSAGE" - Field type message.//   "TYPE_BYTES" - Field type bytes.//   "TYPE_UINT32" - Field type uint32.//   "TYPE_ENUM" - Field type enum.//   "TYPE_SFIXED32" - Field type sfixed32.//   "TYPE_SFIXED64" - Field type sfixed64.//   "TYPE_SINT32" - Field type sint32.//   "TYPE_SINT64" - Field type sint64.Kindstring `json:"kind,omitempty"`// Name: The field name.Namestring `json:"name,omitempty"`// Number: The field number.Numberint64 `json:"number,omitempty"`// OneofIndex: The index of the field type in Type.oneofs, for message or// enumeration types. The first type has index 1; zero means the type is not in// the list.OneofIndexint64 `json:"oneofIndex,omitempty"`// Options: The protocol buffer options.Options []*Option `json:"options,omitempty"`// Packed: Whether to use alternative packed wire representation.Packedbool `json:"packed,omitempty"`// TypeUrl: The field type URL, without the scheme, for message or enumeration// types. Example: "type.googleapis.com/google.protobuf.Timestamp".TypeUrlstring `json:"typeUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "Cardinality") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cardinality") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Field: A single field of a message type.New usages of this message as analternative to FieldDescriptorProto are strongly discouraged. This messagedoes not reliability preserve all information necessary to model the schemaand preserve semantics. Instead make use of FileDescriptorSet whichpreserves the necessary information.

func (Field)MarshalJSON

func (sField) MarshalJSON() ([]byte,error)

typeFoldersServiceadded inv0.37.0

type FoldersService struct {TimeSeries *FoldersTimeSeriesService// contains filtered or unexported fields}

funcNewFoldersServiceadded inv0.37.0

func NewFoldersService(s *Service) *FoldersService

typeFoldersTimeSeriesListCalladded inv0.37.0

type FoldersTimeSeriesListCall struct {// contains filtered or unexported fields}

func (*FoldersTimeSeriesListCall)AggregationAlignmentPeriodadded inv0.37.0

func (c *FoldersTimeSeriesListCall) AggregationAlignmentPeriod(aggregationAlignmentPeriodstring) *FoldersTimeSeriesListCall

AggregationAlignmentPeriod sets the optional parameter"aggregation.alignmentPeriod": The alignment_period specifies a timeinterval, in seconds, that is used to divide the data in all the time seriesinto consistent blocks of time. This will be done before the per-seriesaligner can be applied to the data.The value must be at least 60 seconds. Ifa per-series aligner other than ALIGN_NONE is specified, this field isrequired or an error is returned. If no per-series aligner is specified, orthe aligner ALIGN_NONE is specified, then this field is ignored.The maximumvalue of the alignment_period is 104 weeks (2 years) for charts, and 90,000seconds (25 hours) for alerting policies.

func (*FoldersTimeSeriesListCall)AggregationCrossSeriesReduceradded inv0.37.0

func (c *FoldersTimeSeriesListCall) AggregationCrossSeriesReducer(aggregationCrossSeriesReducerstring) *FoldersTimeSeriesListCall

AggregationCrossSeriesReducer sets the optional parameter"aggregation.crossSeriesReducer": The reduction operation to be used tocombine time series into a single time series, where the value of each datapoint in the resulting series is a function of all the already alignedvalues in the input time series.Not all reducer operations can be applied toall time series. The valid choices depend on the metric_kind and thevalue_type of the original time series. Reduction can yield a time serieswith a different metric_kind or value_type than the input time series.Timeseries data must first be aligned (see per_series_aligner) in order toperform cross-time series reduction. If cross_series_reducer is specified,then per_series_aligner must be specified, and must not be ALIGN_NONE. Analignment_period must also be specified; otherwise, an error is returned.

Possible values:

"REDUCE_NONE" - No cross-time series reduction. The output of the Aligner

is returned.

"REDUCE_MEAN" - Reduce by computing the mean value across time series for

each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric or distribution values. The value_type of the output is DOUBLE.

"REDUCE_MIN" - Reduce by computing the minimum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_MAX" - Reduce by computing the maximum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_SUM" - Reduce by computing the sum across time series for each

alignment period. This reducer is valid for DELTA and GAUGE metrics withnumeric and distribution values. The value_type of the output is the same asthe value_type of the input.

"REDUCE_STDDEV" - Reduce by computing the standard deviation across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics with numeric or distribution values. The value_type of the output isDOUBLE.

"REDUCE_COUNT" - Reduce by computing the number of data points across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics of numeric, Boolean, distribution, and string value_type. Thevalue_type of the output is INT64.

"REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of

True-valued data points to the total number of data points for eachalignment period. This reducer is valid for DELTA and GAUGE metrics ofBoolean value_type. The output value is in the range 0.0, 1.0 and hasvalue_type DOUBLE.

"REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

func (*FoldersTimeSeriesListCall)AggregationGroupByFieldsadded inv0.37.0

func (c *FoldersTimeSeriesListCall) AggregationGroupByFields(aggregationGroupByFields ...string) *FoldersTimeSeriesListCall

AggregationGroupByFields sets the optional parameter"aggregation.groupByFields": The set of fields to preserve whencross_series_reducer is specified. The group_by_fields determine how thetime series are partitioned into subsets prior to applying the aggregationoperation. Each subset contains time series that have the same value foreach of the grouping fields. Each individual time series is a member ofexactly one subset. The cross_series_reducer is applied to each subset oftime series. It is not possible to reduce across different resource types,so this field implicitly contains resource.type. Fields not specified ingroup_by_fields are aggregated away. If group_by_fields is not specified andall the time series have the same resource type, then the time series areaggregated into a single output time series. If cross_series_reducer is notdefined, this field is ignored.

func (*FoldersTimeSeriesListCall)AggregationPerSeriesAligneradded inv0.37.0

func (c *FoldersTimeSeriesListCall) AggregationPerSeriesAligner(aggregationPerSeriesAlignerstring) *FoldersTimeSeriesListCall

AggregationPerSeriesAligner sets the optional parameter"aggregation.perSeriesAligner": An Aligner describes how to bring the datapoints in a single time series into temporal alignment. Except forALIGN_NONE, all alignments cause all the data points in an alignment_periodto be mathematically grouped together, resulting in a single data point foreach alignment_period with end timestamp at the end of the period.Not allalignment operations may be applied to all time series. The valid choicesdepend on the metric_kind and value_type of the original time series.Alignment can change the metric_kind or the value_type of the timeseries.Time series data must be aligned in order to perform cross-timeseries reduction. If cross_series_reducer is specified, thenper_series_aligner must be specified and not equal to ALIGN_NONE andalignment_period must be specified; otherwise, an error is returned.

Possible values:

"ALIGN_NONE" - No alignment. Raw data is returned. Not valid if

cross-series reduction is requested. The value_type of the result is thesame as the value_type of the input.

"ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -

y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selectedalignment period results in periods with no data, then the aligned value forsuch a period is created by interpolation. The value_type of the alignedresult is the same as the value_type of the input.

"ALIGN_RATE" - Align and convert to a rate. The result is computed as rate

= (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner asproviding the slope of the line that passes through the value at the startand at the end of the alignment_period.This aligner is valid for CUMULATIVEand DELTA metrics with numeric values. If the selected alignment periodresults in periods with no data, then the aligned value for such a period iscreated by interpolation. The output is a GAUGE metric with value_typeDOUBLE.If, by "rate", you mean "percentage change", see theALIGN_PERCENT_CHANGE aligner instead.

"ALIGN_INTERPOLATE" - Align by interpolating between adjacent points

around the alignment period boundary. This aligner is valid for GAUGEmetrics with numeric values. The value_type of the aligned result is thesame as the value_type of the input.

"ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the

end of the alignment period to the boundary at the end of the alignmentperiod. This aligner is valid for GAUGE metrics. The value_type of thealigned result is the same as the value_type of the input.

"ALIGN_MIN" - Align the time series by returning the minimum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MAX" - Align the time series by returning the maximum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MEAN" - Align the time series by returning the mean value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is DOUBLE.

"ALIGN_COUNT" - Align the time series by returning the number of values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric or Boolean values. The value_type of the aligned result isINT64.

"ALIGN_SUM" - Align the time series by returning the sum of the values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric and distribution values. The value_type of the aligned resultis the same as the value_type of the input.

"ALIGN_STDDEV" - Align the time series by returning the standard deviation

of the values in each alignment period. This aligner is valid for GAUGE andDELTA metrics with numeric values. The value_type of the output is DOUBLE.

"ALIGN_COUNT_TRUE" - Align the time series by returning the number of True

values in each alignment period. This aligner is valid for GAUGE metricswith Boolean values. The value_type of the output is INT64.

"ALIGN_COUNT_FALSE" - Align the time series by returning the number of

False values in each alignment period. This aligner is valid for GAUGEmetrics with Boolean values. The value_type of the output is INT64.

"ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of

the number of True values to the total number of values in each alignmentperiod. This aligner is valid for GAUGE metrics with Boolean values. Theoutput value is in the range 0.0, 1.0 and has value_type DOUBLE.

"ALIGN_PERCENTILE_99" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 99th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_95" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 95th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_50" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 50th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_05" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 5th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This

aligner is valid for GAUGE and DELTA metrics with numeric values. Thisalignment returns ((current - previous)/previous) * 100, where the value ofprevious is determined based on the alignment_period.If the values ofcurrent and previous are both 0, then the returned value is 0. If onlyprevious is 0, the returned value is infinity.A 10-minute moving mean iscomputed at each point of the alignment period prior to the abovecalculation to smooth the metric and prevent false positives from veryshort-lived spikes. The moving mean is only applicable for data whose valuesare >= 0. Any values < 0 are treated as a missing datapoint, and areignored. While DELTA metrics are accepted by this alignment, special careshould be taken that the values for the metric will always be positive. Theoutput is a GAUGE metric with value_type DOUBLE.

func (*FoldersTimeSeriesListCall)Contextadded inv0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersTimeSeriesListCall)Doadded inv0.37.0

Do executes the "monitoring.folders.timeSeries.list" call.Any non-2xx status code is an error. Response headers are in either*ListTimeSeriesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*FoldersTimeSeriesListCall)Fieldsadded inv0.37.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersTimeSeriesListCall)Filteradded inv0.37.0

Filter sets the optional parameter "filter": Required. A monitoring filter(https://cloud.google.com/monitoring/api/v3/filters) that specifies whichtime series should be returned. The filter must specify a single metrictype, and can additionally specify metric labels and other information. Forexample: metric.type = "compute.googleapis.com/instance/cpu/usage_time" ANDmetric.labels.instance_name = "my-instance-name"

func (*FoldersTimeSeriesListCall)Headeradded inv0.37.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*FoldersTimeSeriesListCall)IfNoneMatchadded inv0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*FoldersTimeSeriesListCall)IntervalEndTimeadded inv0.37.0

func (c *FoldersTimeSeriesListCall) IntervalEndTime(intervalEndTimestring) *FoldersTimeSeriesListCall

IntervalEndTime sets the optional parameter "interval.endTime": Required.The end of the time interval.

func (*FoldersTimeSeriesListCall)IntervalStartTimeadded inv0.37.0

func (c *FoldersTimeSeriesListCall) IntervalStartTime(intervalStartTimestring) *FoldersTimeSeriesListCall

IntervalStartTime sets the optional parameter "interval.startTime": Thebeginning of the time interval. The default value for the start time is theend time. The start time must not be later than the end time.

func (*FoldersTimeSeriesListCall)OrderByadded inv0.37.0

OrderBy sets the optional parameter "orderBy": Unsupported: must be leftblank. The points in each time series are currently returned in reverse timeorder (most recent to oldest).

func (*FoldersTimeSeriesListCall)PageSizeadded inv0.37.0

PageSize sets the optional parameter "pageSize": A positive number that isthe maximum number of results to return. If page_size is empty or more than100,000 results, the effective page_size is 100,000 results. If view is setto FULL, this is the maximum number of Points returned. If view is set toHEADERS, this is the maximum number of TimeSeries returned.

func (*FoldersTimeSeriesListCall)PageTokenadded inv0.37.0

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*FoldersTimeSeriesListCall)Pagesadded inv0.37.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*FoldersTimeSeriesListCall)SecondaryAggregationAlignmentPeriodadded inv0.37.0

func (c *FoldersTimeSeriesListCall) SecondaryAggregationAlignmentPeriod(secondaryAggregationAlignmentPeriodstring) *FoldersTimeSeriesListCall

SecondaryAggregationAlignmentPeriod sets the optional parameter"secondaryAggregation.alignmentPeriod": The alignment_period specifies atime interval, in seconds, that is used to divide the data in all the timeseries into consistent blocks of time. This will be done before theper-series aligner can be applied to the data.The value must be at least 60seconds. If a per-series aligner other than ALIGN_NONE is specified, thisfield is required or an error is returned. If no per-series aligner isspecified, or the aligner ALIGN_NONE is specified, then this field isignored.The maximum value of the alignment_period is 104 weeks (2 years) forcharts, and 90,000 seconds (25 hours) for alerting policies.

func (*FoldersTimeSeriesListCall)SecondaryAggregationCrossSeriesReduceradded inv0.37.0

func (c *FoldersTimeSeriesListCall) SecondaryAggregationCrossSeriesReducer(secondaryAggregationCrossSeriesReducerstring) *FoldersTimeSeriesListCall

SecondaryAggregationCrossSeriesReducer sets the optional parameter"secondaryAggregation.crossSeriesReducer": The reduction operation to beused to combine time series into a single time series, where the value ofeach data point in the resulting series is a function of all the alreadyaligned values in the input time series.Not all reducer operations can beapplied to all time series. The valid choices depend on the metric_kind andthe value_type of the original time series. Reduction can yield a timeseries with a different metric_kind or value_type than the input timeseries.Time series data must first be aligned (see per_series_aligner) inorder to perform cross-time series reduction. If cross_series_reducer isspecified, then per_series_aligner must be specified, and must not beALIGN_NONE. An alignment_period must also be specified; otherwise, an erroris returned.

Possible values:

"REDUCE_NONE" - No cross-time series reduction. The output of the Aligner

is returned.

"REDUCE_MEAN" - Reduce by computing the mean value across time series for

each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric or distribution values. The value_type of the output is DOUBLE.

"REDUCE_MIN" - Reduce by computing the minimum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_MAX" - Reduce by computing the maximum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_SUM" - Reduce by computing the sum across time series for each

alignment period. This reducer is valid for DELTA and GAUGE metrics withnumeric and distribution values. The value_type of the output is the same asthe value_type of the input.

"REDUCE_STDDEV" - Reduce by computing the standard deviation across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics with numeric or distribution values. The value_type of the output isDOUBLE.

"REDUCE_COUNT" - Reduce by computing the number of data points across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics of numeric, Boolean, distribution, and string value_type. Thevalue_type of the output is INT64.

"REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of

True-valued data points to the total number of data points for eachalignment period. This reducer is valid for DELTA and GAUGE metrics ofBoolean value_type. The output value is in the range 0.0, 1.0 and hasvalue_type DOUBLE.

"REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

func (*FoldersTimeSeriesListCall)SecondaryAggregationGroupByFieldsadded inv0.37.0

func (c *FoldersTimeSeriesListCall) SecondaryAggregationGroupByFields(secondaryAggregationGroupByFields ...string) *FoldersTimeSeriesListCall

SecondaryAggregationGroupByFields sets the optional parameter"secondaryAggregation.groupByFields": The set of fields to preserve whencross_series_reducer is specified. The group_by_fields determine how thetime series are partitioned into subsets prior to applying the aggregationoperation. Each subset contains time series that have the same value foreach of the grouping fields. Each individual time series is a member ofexactly one subset. The cross_series_reducer is applied to each subset oftime series. It is not possible to reduce across different resource types,so this field implicitly contains resource.type. Fields not specified ingroup_by_fields are aggregated away. If group_by_fields is not specified andall the time series have the same resource type, then the time series areaggregated into a single output time series. If cross_series_reducer is notdefined, this field is ignored.

func (*FoldersTimeSeriesListCall)SecondaryAggregationPerSeriesAligneradded inv0.37.0

func (c *FoldersTimeSeriesListCall) SecondaryAggregationPerSeriesAligner(secondaryAggregationPerSeriesAlignerstring) *FoldersTimeSeriesListCall

SecondaryAggregationPerSeriesAligner sets the optional parameter"secondaryAggregation.perSeriesAligner": An Aligner describes how to bringthe data points in a single time series into temporal alignment. Except forALIGN_NONE, all alignments cause all the data points in an alignment_periodto be mathematically grouped together, resulting in a single data point foreach alignment_period with end timestamp at the end of the period.Not allalignment operations may be applied to all time series. The valid choicesdepend on the metric_kind and value_type of the original time series.Alignment can change the metric_kind or the value_type of the timeseries.Time series data must be aligned in order to perform cross-timeseries reduction. If cross_series_reducer is specified, thenper_series_aligner must be specified and not equal to ALIGN_NONE andalignment_period must be specified; otherwise, an error is returned.

Possible values:

"ALIGN_NONE" - No alignment. Raw data is returned. Not valid if

cross-series reduction is requested. The value_type of the result is thesame as the value_type of the input.

"ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -

y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selectedalignment period results in periods with no data, then the aligned value forsuch a period is created by interpolation. The value_type of the alignedresult is the same as the value_type of the input.

"ALIGN_RATE" - Align and convert to a rate. The result is computed as rate

= (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner asproviding the slope of the line that passes through the value at the startand at the end of the alignment_period.This aligner is valid for CUMULATIVEand DELTA metrics with numeric values. If the selected alignment periodresults in periods with no data, then the aligned value for such a period iscreated by interpolation. The output is a GAUGE metric with value_typeDOUBLE.If, by "rate", you mean "percentage change", see theALIGN_PERCENT_CHANGE aligner instead.

"ALIGN_INTERPOLATE" - Align by interpolating between adjacent points

around the alignment period boundary. This aligner is valid for GAUGEmetrics with numeric values. The value_type of the aligned result is thesame as the value_type of the input.

"ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the

end of the alignment period to the boundary at the end of the alignmentperiod. This aligner is valid for GAUGE metrics. The value_type of thealigned result is the same as the value_type of the input.

"ALIGN_MIN" - Align the time series by returning the minimum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MAX" - Align the time series by returning the maximum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MEAN" - Align the time series by returning the mean value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is DOUBLE.

"ALIGN_COUNT" - Align the time series by returning the number of values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric or Boolean values. The value_type of the aligned result isINT64.

"ALIGN_SUM" - Align the time series by returning the sum of the values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric and distribution values. The value_type of the aligned resultis the same as the value_type of the input.

"ALIGN_STDDEV" - Align the time series by returning the standard deviation

of the values in each alignment period. This aligner is valid for GAUGE andDELTA metrics with numeric values. The value_type of the output is DOUBLE.

"ALIGN_COUNT_TRUE" - Align the time series by returning the number of True

values in each alignment period. This aligner is valid for GAUGE metricswith Boolean values. The value_type of the output is INT64.

"ALIGN_COUNT_FALSE" - Align the time series by returning the number of

False values in each alignment period. This aligner is valid for GAUGEmetrics with Boolean values. The value_type of the output is INT64.

"ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of

the number of True values to the total number of values in each alignmentperiod. This aligner is valid for GAUGE metrics with Boolean values. Theoutput value is in the range 0.0, 1.0 and has value_type DOUBLE.

"ALIGN_PERCENTILE_99" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 99th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_95" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 95th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_50" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 50th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_05" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 5th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This

aligner is valid for GAUGE and DELTA metrics with numeric values. Thisalignment returns ((current - previous)/previous) * 100, where the value ofprevious is determined based on the alignment_period.If the values ofcurrent and previous are both 0, then the returned value is 0. If onlyprevious is 0, the returned value is infinity.A 10-minute moving mean iscomputed at each point of the alignment period prior to the abovecalculation to smooth the metric and prevent false positives from veryshort-lived spikes. The moving mean is only applicable for data whose valuesare >= 0. Any values < 0 are treated as a missing datapoint, and areignored. While DELTA metrics are accepted by this alignment, special careshould be taken that the values for the metric will always be positive. Theoutput is a GAUGE metric with value_type DOUBLE.

func (*FoldersTimeSeriesListCall)Viewadded inv0.37.0

View sets the optional parameter "view": Required. Specifies whichinformation is returned about the time series.

Possible values:

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

typeFoldersTimeSeriesServiceadded inv0.37.0

type FoldersTimeSeriesService struct {// contains filtered or unexported fields}

funcNewFoldersTimeSeriesServiceadded inv0.37.0

func NewFoldersTimeSeriesService(s *Service) *FoldersTimeSeriesService

func (*FoldersTimeSeriesService)Listadded inv0.37.0

List: Lists time series that match a filter.

typeForecastOptionsadded inv0.105.0

type ForecastOptions struct {// ForecastHorizon: 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.ForecastHorizonstring `json:"forecastHorizon,omitempty"`// ForceSendFields is a list of field names (e.g. "ForecastHorizon") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ForecastHorizon") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ForecastOptions: Options used when forecasting the time series and testingthe predicted value against the threshold.

func (ForecastOptions)MarshalJSONadded inv0.105.0

func (sForecastOptions) MarshalJSON() ([]byte,error)

typeGetNotificationChannelVerificationCodeRequest

type GetNotificationChannelVerificationCodeRequest struct {// ExpireTime: 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).ExpireTimestring `json:"expireTime,omitempty"`// ForceSendFields is a list of field names (e.g. "ExpireTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExpireTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GetNotificationChannelVerificationCodeRequest: TheGetNotificationChannelVerificationCode request.

func (GetNotificationChannelVerificationCodeRequest)MarshalJSON

typeGetNotificationChannelVerificationCodeResponse

type GetNotificationChannelVerificationCodeResponse struct {// 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).Codestring `json:"code,omitempty"`// ExpireTime: 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.ExpireTimestring `json:"expireTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GetNotificationChannelVerificationCodeResponse: TheGetNotificationChannelVerificationCode request.

func (GetNotificationChannelVerificationCodeResponse)MarshalJSON

typeGkeNamespaceadded inv0.80.0

type GkeNamespace struct {// ClusterName: The name of the parent cluster.ClusterNamestring `json:"clusterName,omitempty"`// Location: The location of the parent cluster. This may be a zone or region.Locationstring `json:"location,omitempty"`// NamespaceName: The name of this namespace.NamespaceNamestring `json:"namespaceName,omitempty"`// ProjectId: 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.ProjectIdstring `json:"projectId,omitempty"`// ForceSendFields is a list of field names (e.g. "ClusterName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClusterName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GkeNamespace: GKE Namespace. The field names correspond to the resourcemetadata labels on monitored resources that fall under a namespace (forexample, k8s_container or k8s_pod).

func (GkeNamespace)MarshalJSONadded inv0.80.0

func (sGkeNamespace) MarshalJSON() ([]byte,error)

typeGkeServiceadded inv0.80.0

type GkeService struct {// ClusterName: The name of the parent cluster.ClusterNamestring `json:"clusterName,omitempty"`// Location: The location of the parent cluster. This may be a zone or region.Locationstring `json:"location,omitempty"`// NamespaceName: The name of the parent namespace.NamespaceNamestring `json:"namespaceName,omitempty"`// ProjectId: 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.ProjectIdstring `json:"projectId,omitempty"`// ServiceName: The name of this service.ServiceNamestring `json:"serviceName,omitempty"`// ForceSendFields is a list of field names (e.g. "ClusterName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClusterName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GkeService: GKE Service. The "service" here represents a Kubernetes serviceobject (https://kubernetes.io/docs/concepts/services-networking/service).The field names correspond to the resource labels on k8s_service monitoredresources(https://cloud.google.com/monitoring/api/resources#tag_k8s_service).

func (GkeService)MarshalJSONadded inv0.80.0

func (sGkeService) MarshalJSON() ([]byte,error)

typeGkeWorkloadadded inv0.80.0

type GkeWorkload struct {// ClusterName: The name of the parent cluster.ClusterNamestring `json:"clusterName,omitempty"`// Location: The location of the parent cluster. This may be a zone or region.Locationstring `json:"location,omitempty"`// NamespaceName: The name of the parent namespace.NamespaceNamestring `json:"namespaceName,omitempty"`// ProjectId: 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.ProjectIdstring `json:"projectId,omitempty"`// TopLevelControllerName: The name of this workload.TopLevelControllerNamestring `json:"topLevelControllerName,omitempty"`// TopLevelControllerType: The type of this workload (for example, "Deployment"// or "DaemonSet")TopLevelControllerTypestring `json:"topLevelControllerType,omitempty"`// ForceSendFields is a list of field names (e.g. "ClusterName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClusterName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GkeWorkload: A GKE Workload (Deployment, StatefulSet, etc). The field namescorrespond to the metadata labels on monitored resources that fall under aworkload (for example, k8s_container or k8s_pod).

func (GkeWorkload)MarshalJSONadded inv0.80.0

func (sGkeWorkload) MarshalJSON() ([]byte,error)

typeGoogleMonitoringV3Rangeadded inv0.14.0

type GoogleMonitoringV3Range struct {// Max: Range maximum.Maxfloat64 `json:"max,omitempty"`// Min: Range minimum.Minfloat64 `json:"min,omitempty"`// ForceSendFields is a list of field names (e.g. "Max") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Max") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleMonitoringV3Range: Range of numerical values within min and max.

func (GoogleMonitoringV3Range)MarshalJSONadded inv0.14.0

func (sGoogleMonitoringV3Range) MarshalJSON() ([]byte,error)

func (*GoogleMonitoringV3Range)UnmarshalJSONadded inv0.14.0

func (s *GoogleMonitoringV3Range) UnmarshalJSON(data []byte)error

typeGroup

type Group struct {// DisplayName: A user-assigned name for this group, used only for display// purposes.DisplayNamestring `json:"displayName,omitempty"`// Filter: The filter used to determine which monitored resources belong to// this group.Filterstring `json:"filter,omitempty"`// IsCluster: If true, the members of this group are considered to be a// cluster. The system can perform additional analysis on groups that are// clusters.IsClusterbool `json:"isCluster,omitempty"`// 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.Namestring `json:"name,omitempty"`// ParentName: 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, "".ParentNamestring `json:"parentName,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Group: The description of a dynamic collection of monitored resources. Eachgroup has a filter that is matched against monitored resources and theirassociated metadata. If a group's filter matches an available monitoredresource, then that resource is a member of that group. Groups can containany number of monitored resources, and each monitored resource can be amember of any number of groups.Groups can be nested in parent-childhierarchies. The parentName field identifies an optional parent for eachgroup. If a group has a parent, then the only monitored resources availableto be matched by the group's filter are the resources contained in theparent group. In other words, a group contains the monitored resources thatmatch its filter and the filters of all the group's ancestors. A groupwithout a parent can contain any monitored resource.For example, consider aninfrastructure 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 productionenvironment, regardless of their roles. The child group contains instancesthat have the transcoder role and are in the production environment.Themonitored resources contained in a group can change at any moment, dependingon what resources exist and what filters are associated with the group andits ancestors.

func (Group)MarshalJSON

func (sGroup) MarshalJSON() ([]byte,error)

typeHourlyadded inv0.200.0

type Hourly struct {// MinuteOffset: 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.MinuteOffsetint64 `json:"minuteOffset,omitempty"`// Periodicity: Required. The number of hours between runs. Must be greater// than or equal to 1 hour and less than or equal to 48 hours.Periodicityint64 `json:"periodicity,omitempty"`// ForceSendFields is a list of field names (e.g. "MinuteOffset") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MinuteOffset") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Hourly)MarshalJSONadded inv0.200.0

func (sHourly) MarshalJSON() ([]byte,error)

typeHttpCheck

type HttpCheck struct {// AcceptedResponseStatusCodes: If present, the check will only pass if the// HTTP response status code is in this set of status codes. If empty, the HTTP// status code will only pass if the HTTP status code is 200-299.AcceptedResponseStatusCodes []*ResponseStatusCode `json:"acceptedResponseStatusCodes,omitempty"`// AuthInfo: The authentication information. Optional when creating an HTTP// check; defaults to empty. Do not set both auth_method and auth_info.AuthInfo *BasicAuthentication `json:"authInfo,omitempty"`// Body: The request body associated with the HTTP POST request. If// content_type is URL_ENCODED, the body passed in must be URL-encoded. Users// can provide a Content-Length header via the headers field or the API will do// so. If the request_method is GET and body is not empty, the API will return// an error. The maximum byte size is 1 megabyte.Note: If client libraries// aren't used (which performs the conversion automatically) base64 encode your// body data since the field is of bytes type.Bodystring `json:"body,omitempty"`// ContentType: The content type header to use for the check. The following// configurations result in errors: 1. Content type is specified in both the// headers field and the content_type field. 2. Request method is GET and// content_type is not TYPE_UNSPECIFIED 3. Request method is POST and// content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a// "Content-Type" header is provided via headers field. The content_type field// should be used instead.//// Possible values://   "TYPE_UNSPECIFIED" - No content type specified.//   "URL_ENCODED" - body is in URL-encoded form. Equivalent to setting the// Content-Type to application/x-www-form-urlencoded in the HTTP request.//   "USER_PROVIDED" - body is in custom_content_type form. Equivalent to// setting the Content-Type to the contents of custom_content_type in the HTTP// request.ContentTypestring `json:"contentType,omitempty"`// CustomContentType: A user provided content type header to use for the check.// The invalid configurations outlined in the content_type field apply to// custom_content_type, as well as the following: 1. content_type is// URL_ENCODED and custom_content_type is set. 2. content_type is USER_PROVIDED// and custom_content_type is not set.CustomContentTypestring `json:"customContentType,omitempty"`// Headers: The list of headers to send as part of the Uptime check request. If// two headers have the same key and different values, they should be entered// as a single header, with the value being a comma-separated list of all the// desired values as described at//https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two// separate headers with the same key in a Create call will cause the first to// be overwritten by the second. The maximum number of headers allowed is 100.Headers map[string]string `json:"headers,omitempty"`// MaskHeaders: Boolean specifying whether to encrypt the header information.// Encryption should be specified for any headers related to authentication// that you do not wish to be seen when retrieving the configuration. The// server will be responsible for encrypting the headers. On Get/List calls, if// mask_headers is set to true then the headers will be obscured with ******.MaskHeadersbool `json:"maskHeaders,omitempty"`// Path: Optional (defaults to "/"). The path to the page against which to run// the check. Will be combined with the host (specified within the// monitored_resource) and port to construct the full URL. If the provided path// does not begin with "/", a "/" will be prepended automatically.Pathstring `json:"path,omitempty"`// PingConfig: Contains information needed to add pings to an HTTP check.PingConfig *PingConfig `json:"pingConfig,omitempty"`// Port: Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl// is true). The TCP port on the HTTP server against which to run the check.// Will be combined with host (specified within the monitored_resource) and// path to construct the full URL.Portint64 `json:"port,omitempty"`// RequestMethod: The HTTP request method to use for the check. If set to// METHOD_UNSPECIFIED then request_method defaults to GET.//// Possible values://   "METHOD_UNSPECIFIED" - No request method specified.//   "GET" - GET request.//   "POST" - POST request.RequestMethodstring `json:"requestMethod,omitempty"`// ServiceAgentAuthentication: If specified, Uptime will generate and attach an// OIDC JWT token for the Monitoring service agent service account as an// Authorization header in the HTTP request when probing.ServiceAgentAuthentication *ServiceAgentAuthentication `json:"serviceAgentAuthentication,omitempty"`// UseSsl: If true, use HTTPS instead of HTTP to run the check.UseSslbool `json:"useSsl,omitempty"`// ValidateSsl: Boolean specifying whether to include SSL certificate// validation as a part of the Uptime check. Only applies to checks where// monitored_resource is set to uptime_url. If use_ssl is false, setting// validate_ssl to true has no effect.ValidateSslbool `json:"validateSsl,omitempty"`// ForceSendFields is a list of field names (e.g.// "AcceptedResponseStatusCodes") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AcceptedResponseStatusCodes") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

HttpCheck: Information involved in an HTTP/HTTPS Uptime check request.

func (HttpCheck)MarshalJSON

func (sHttpCheck) MarshalJSON() ([]byte,error)

typeInternalChecker

type InternalChecker struct {// DisplayName: 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.DisplayNamestring `json:"displayName,omitempty"`// GcpZone: The GCP zone the Uptime check should egress from. Only respected// for internal Uptime checks, where internal_network is specified.GcpZonestring `json:"gcpZone,omitempty"`// 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 Cloud Monitoring Metrics Scope project for the// Uptime check config associated with the internal checker.Namestring `json:"name,omitempty"`// Network: The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where// the internal resource lives (ex: "default").Networkstring `json:"network,omitempty"`// PeerProjectId: The GCP project ID where the internal checker lives. Not// necessary the same as the Metrics Scope project.PeerProjectIdstring `json:"peerProjectId,omitempty"`// State: The current operational state of the internal checker.//// Possible values://   "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// (https://cloud.google.com/apis/design/design_patterns#long_running_operations)// 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// (https://cloud.google.com/apis/design/design_patterns#long_running_operations)// that created it. If a checker is being torn down, it is neither visible nor// usable, so there is no "deleting" or "down" state.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

InternalChecker: An internal checker allows Uptime checks to run onprivate/internal GCP resources.

func (InternalChecker)MarshalJSON

func (sInternalChecker) MarshalJSON() ([]byte,error)

typeIstioCanonicalServiceadded inv0.37.0

type IstioCanonicalService struct {// CanonicalService: The name of the canonical service underlying this service.// Corresponds to the destination_canonical_service_name metric label in label// in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).CanonicalServicestring `json:"canonicalService,omitempty"`// CanonicalServiceNamespace: The namespace of the canonical service underlying// this service. Corresponds to the destination_canonical_service_namespace// metric label in Istio metrics// (https://cloud.google.com/monitoring/api/metrics_istio).CanonicalServiceNamespacestring `json:"canonicalServiceNamespace,omitempty"`// MeshUid: Identifier for the Istio mesh in which this canonical service is// defined. Corresponds to the mesh_uid metric label in Istio metrics// (https://cloud.google.com/monitoring/api/metrics_istio).MeshUidstring `json:"meshUid,omitempty"`// ForceSendFields is a list of field names (e.g. "CanonicalService") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CanonicalService") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

IstioCanonicalService: Canonical service scoped to an Istio mesh. Anthosclusters running ASM >= 1.6.8 will have their services ingested as thistype.

func (IstioCanonicalService)MarshalJSONadded inv0.37.0

func (sIstioCanonicalService) MarshalJSON() ([]byte,error)

typeJsonPathMatcheradded inv0.81.0

type JsonPathMatcher struct {// JsonMatcher: The type of JSONPath match that will be applied to the JSON// output (ContentMatcher.content)//// Possible values://   "JSON_PATH_MATCHER_OPTION_UNSPECIFIED" - No JSONPath matcher type// specified (not valid).//   "EXACT_MATCH" - Selects 'exact string' matching. The match succeeds if the// content at the json_path within the output is exactly the same as the// content string.//   "REGEX_MATCH" - Selects regular-expression matching. The match succeeds if// the content at the json_path within the output matches the regular// expression specified in the content string.JsonMatcherstring `json:"jsonMatcher,omitempty"`// JsonPath: JSONPath within the response output pointing to the expected// ContentMatcher::content to match against.JsonPathstring `json:"jsonPath,omitempty"`// ForceSendFields is a list of field names (e.g. "JsonMatcher") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "JsonMatcher") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

JsonPathMatcher: Information needed to perform a JSONPath content match.Used for ContentMatcherOption::MATCHES_JSON_PATH andContentMatcherOption::NOT_MATCHES_JSON_PATH.

func (JsonPathMatcher)MarshalJSONadded inv0.81.0

func (sJsonPathMatcher) MarshalJSON() ([]byte,error)

typeLabelDescriptor

type LabelDescriptor struct {// Description: A human-readable description for the label.Descriptionstring `json:"description,omitempty"`// Key: The key for this label. The key must meet the following criteria: Does// not exceed 100 characters. Matches the following regular expression:// [a-zA-Z][a-zA-Z0-9_]* The first character must be an upper- or lower-case// letter. The remaining characters must be letters, digits, or underscores.Keystring `json:"key,omitempty"`// ValueType: The type of data that can be assigned to the label.//// Possible values://   "STRING" - A variable-length string, not to exceed 1,024 characters. This// is the default value type.//   "BOOL" - Boolean; true or false.//   "INT64" - A 64-bit signed integer.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LabelDescriptor: A description of a label.

func (LabelDescriptor)MarshalJSON

func (sLabelDescriptor) MarshalJSON() ([]byte,error)

typeLabelValueadded inv0.22.0

type LabelValue struct {// BoolValue: A bool label value.BoolValuebool `json:"boolValue,omitempty"`// Int64Value: An int64 label value.Int64Valueint64 `json:"int64Value,omitempty,string"`// StringValue: A string label value.StringValuestring `json:"stringValue,omitempty"`// ForceSendFields is a list of field names (e.g. "BoolValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoolValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LabelValue: A label value.

func (LabelValue)MarshalJSONadded inv0.22.0

func (sLabelValue) MarshalJSON() ([]byte,error)

typeLatencyCriteriaadded inv0.14.0

type LatencyCriteria struct {// Threshold: Good service is defined to be the count of requests made to this// service that return in no more than threshold.Thresholdstring `json:"threshold,omitempty"`// ForceSendFields is a list of field names (e.g. "Threshold") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Threshold") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LatencyCriteria: Parameters for a latency threshold SLI.

func (LatencyCriteria)MarshalJSONadded inv0.14.0

func (sLatencyCriteria) MarshalJSON() ([]byte,error)

typeLinear

type Linear struct {// NumFiniteBuckets: Must be greater than 0.NumFiniteBucketsint64 `json:"numFiniteBuckets,omitempty"`// Offset: Lower bound of the first bucket.Offsetfloat64 `json:"offset,omitempty"`// Width: Must be greater than 0.Widthfloat64 `json:"width,omitempty"`// ForceSendFields is a list of field names (e.g. "NumFiniteBuckets") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NumFiniteBuckets") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Linear: Specifies a linear sequence of buckets that all have the same width(except overflow and underflow). Each bucket represents a constant absoluteuncertainty on the specific value in the bucket.There are num_finite_buckets+ 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i< N-1): offset + (width * i).Lower bound (1 <= i < N): offset + (width * (i- 1)).

func (Linear)MarshalJSON

func (sLinear) MarshalJSON() ([]byte,error)

func (*Linear)UnmarshalJSON

func (s *Linear) UnmarshalJSON(data []byte)error

typeLinkadded inv0.186.0

type Link struct {// DisplayName: A short display name for the link. The display name must not be// empty or exceed 63 characters. Example: "playbook".DisplayNamestring `json:"displayName,omitempty"`// Url: 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}"Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Link)MarshalJSONadded inv0.186.0

func (sLink) MarshalJSON() ([]byte,error)

typeListAlertPoliciesResponse

type ListAlertPoliciesResponse struct {// AlertPolicies: The returned alert policies.AlertPolicies []*AlertPolicy `json:"alertPolicies,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// TotalSize: The total number of alert policies in all pages. This number is// only an estimate, and may change in subsequent pages.https://aip.dev/158TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AlertPolicies") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlertPolicies") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListAlertPoliciesResponse: The protocol for the ListAlertPolicies response.

func (ListAlertPoliciesResponse)MarshalJSON

func (sListAlertPoliciesResponse) MarshalJSON() ([]byte,error)

typeListAlertsResponseadded inv0.253.0

type ListAlertsResponse struct {// Alerts: The list of alerts.Alerts []*Alert `json:"alerts,omitempty"`// NextPageToken: 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. The token is encrypted and only// guaranteed to return correct results for 72 hours after it is created. If// empty, all results have been returned.NextPageTokenstring `json:"nextPageToken,omitempty"`// TotalSize: The estimated total number of matching results for this query.TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Alerts") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Alerts") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListAlertsResponse: The ListAlerts response.

func (ListAlertsResponse)MarshalJSONadded inv0.253.0

func (sListAlertsResponse) MarshalJSON() ([]byte,error)

typeListGroupMembersResponse

type ListGroupMembersResponse struct {// Members: A set of monitored resources in the group.Members []*MonitoredResource `json:"members,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// TotalSize: The total number of elements matching this request.TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Members") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Members") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListGroupMembersResponse: The ListGroupMembers response.

func (ListGroupMembersResponse)MarshalJSON

func (sListGroupMembersResponse) MarshalJSON() ([]byte,error)

typeListGroupsResponse

type ListGroupsResponse struct {// Group: The groups that match the specified filters.Group []*Group `json:"group,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Group") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Group") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListGroupsResponse: The ListGroups response.

func (ListGroupsResponse)MarshalJSON

func (sListGroupsResponse) MarshalJSON() ([]byte,error)

typeListMetricDescriptorsResponse

type ListMetricDescriptorsResponse struct {// MetricDescriptors: The metric descriptors that are available to the project// and that match the value of filter, if present.MetricDescriptors []*MetricDescriptor `json:"metricDescriptors,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "MetricDescriptors") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MetricDescriptors") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListMetricDescriptorsResponse: The ListMetricDescriptors response.

func (ListMetricDescriptorsResponse)MarshalJSON

func (sListMetricDescriptorsResponse) MarshalJSON() ([]byte,error)

typeListMonitoredResourceDescriptorsResponse

type ListMonitoredResourceDescriptorsResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ResourceDescriptors: The monitored resource descriptors that are available// to this project and that match filter, if present.ResourceDescriptors []*MonitoredResourceDescriptor `json:"resourceDescriptors,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListMonitoredResourceDescriptorsResponse: TheListMonitoredResourceDescriptors response.

func (ListMonitoredResourceDescriptorsResponse)MarshalJSON

typeListNotificationChannelDescriptorsResponse

type ListNotificationChannelDescriptorsResponse struct {// ChannelDescriptors: The monitored resource descriptors supported for the// specified project, optionally filtered.ChannelDescriptors []*NotificationChannelDescriptor `json:"channelDescriptors,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ChannelDescriptors") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChannelDescriptors") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListNotificationChannelDescriptorsResponse: TheListNotificationChannelDescriptors response.

func (ListNotificationChannelDescriptorsResponse)MarshalJSON

typeListNotificationChannelsResponse

type ListNotificationChannelsResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// NotificationChannels: The notification channels defined for the specified// project.NotificationChannels []*NotificationChannel `json:"notificationChannels,omitempty"`// TotalSize: The total number of notification channels in all pages. This// number is only an estimate, and may change in subsequent pages.//https://aip.dev/158TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListNotificationChannelsResponse: The ListNotificationChannels response.

func (ListNotificationChannelsResponse)MarshalJSON

func (sListNotificationChannelsResponse) MarshalJSON() ([]byte,error)

typeListServiceLevelObjectivesResponseadded inv0.14.0

type ListServiceLevelObjectivesResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServiceLevelObjectives: The ServiceLevelObjectives matching the specified// filter.ServiceLevelObjectives []*ServiceLevelObjective `json:"serviceLevelObjectives,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListServiceLevelObjectivesResponse: The ListServiceLevelObjectives response.

func (ListServiceLevelObjectivesResponse)MarshalJSONadded inv0.14.0

typeListServicesResponseadded inv0.14.0

type ListServicesResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// Services: The Services matching the specified filter.Services []*MService `json:"services,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListServicesResponse: The ListServices response.

func (ListServicesResponse)MarshalJSONadded inv0.14.0

func (sListServicesResponse) MarshalJSON() ([]byte,error)

typeListSnoozesResponseadded inv0.105.0

type ListSnoozesResponse struct {// NextPageToken: Page token for repeated calls to ListSnoozes, to fetch// additional pages of results. If this is empty or missing, there are no more// pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// Snoozes: Snoozes matching this list call.Snoozes []*Snooze `json:"snoozes,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (ListSnoozesResponse)MarshalJSONadded inv0.105.0

func (sListSnoozesResponse) MarshalJSON() ([]byte,error)

typeListTimeSeriesResponse

type ListTimeSeriesResponse struct {// ExecutionErrors: Query execution errors that may have caused the time series// data returned to be incomplete.ExecutionErrors []*Status `json:"executionErrors,omitempty"`// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// TimeSeries: One or more time series that match the filter included in the// request.TimeSeries []*TimeSeries `json:"timeSeries,omitempty"`// Unit: 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}".Unitstring `json:"unit,omitempty"`// Unreachable: Cloud regions that were unreachable which may have caused// incomplete data to be returned.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ExecutionErrors") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExecutionErrors") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListTimeSeriesResponse: The ListTimeSeries response.

func (ListTimeSeriesResponse)MarshalJSON

func (sListTimeSeriesResponse) MarshalJSON() ([]byte,error)

typeListUptimeCheckConfigsResponse

type ListUptimeCheckConfigsResponse struct {// NextPageToken: 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).NextPageTokenstring `json:"nextPageToken,omitempty"`// TotalSize: The total number of Uptime check configurations for the project,// irrespective of any pagination.TotalSizeint64 `json:"totalSize,omitempty"`// UptimeCheckConfigs: The returned Uptime check configurations.UptimeCheckConfigs []*UptimeCheckConfig `json:"uptimeCheckConfigs,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListUptimeCheckConfigsResponse: The protocol for the ListUptimeCheckConfigsresponse.

func (ListUptimeCheckConfigsResponse)MarshalJSON

func (sListUptimeCheckConfigsResponse) MarshalJSON() ([]byte,error)

typeListUptimeCheckIpsResponse

type ListUptimeCheckIpsResponse struct {// NextPageToken: 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). NOTE: this field is not yet implementedNextPageTokenstring `json:"nextPageToken,omitempty"`// UptimeCheckIps: The returned list of IP addresses (including region and// location) that the checkers run from.UptimeCheckIps []*UptimeCheckIp `json:"uptimeCheckIps,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListUptimeCheckIpsResponse: The protocol for the ListUptimeCheckIpsresponse.

func (ListUptimeCheckIpsResponse)MarshalJSON

func (sListUptimeCheckIpsResponse) MarshalJSON() ([]byte,error)

typeLogMatchadded inv0.51.0

type LogMatch struct {// Filter: Required. A logs-based filter. See Advanced Logs Queries// (https://cloud.google.com/logging/docs/view/advanced-queries) for how this// filter should be constructed.Filterstring `json:"filter,omitempty"`// LabelExtractors: 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// (https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric.FIELDS.value_extractor)// for syntax and examples.LabelExtractors map[string]string `json:"labelExtractors,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LogMatch: A condition type that checks whether a log message in the scopingproject (https://cloud.google.com/monitoring/api/v3#project_name) satisfiesthe given filter. Logs from other projects in the metrics scope are notevaluated.

func (LogMatch)MarshalJSONadded inv0.51.0

func (sLogMatch) MarshalJSON() ([]byte,error)

typeLogMetadataadded inv0.253.0

type LogMetadata struct {// ExtractedLabels: The labels extracted from the log.ExtractedLabels map[string]string `json:"extractedLabels,omitempty"`// ForceSendFields is a list of field names (e.g. "ExtractedLabels") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExtractedLabels") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

LogMetadata: Information about the log for log-based alerts.

func (LogMetadata)MarshalJSONadded inv0.253.0

func (sLogMetadata) MarshalJSON() ([]byte,error)

typeMServiceadded inv0.15.0

type MService struct {// AppEngine: Type used for App Engine services.AppEngine *AppEngine `json:"appEngine,omitempty"`// BasicService: Message that contains the service type and service labels of// this service if it is a basic service. Documentation and examples here// (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).BasicService *BasicService `json:"basicService,omitempty"`// CloudEndpoints: Type used for Cloud Endpoints services.CloudEndpoints *CloudEndpoints `json:"cloudEndpoints,omitempty"`// CloudRun: Type used for Cloud Run services.CloudRun *CloudRun `json:"cloudRun,omitempty"`// ClusterIstio: Type used for Istio services that live in a Kubernetes// cluster.ClusterIstio *ClusterIstio `json:"clusterIstio,omitempty"`// Custom: Custom service type.Custom *Custom `json:"custom,omitempty"`// DisplayName: Name used for UI elements listing this Service.DisplayNamestring `json:"displayName,omitempty"`// GkeNamespace: Type used for GKE Namespaces.GkeNamespace *GkeNamespace `json:"gkeNamespace,omitempty"`// GkeService: Type used for GKE Services (the Kubernetes concept of a// service).GkeService *GkeService `json:"gkeService,omitempty"`// GkeWorkload: Type used for GKE Workloads.GkeWorkload *GkeWorkload `json:"gkeWorkload,omitempty"`// IstioCanonicalService: Type used for canonical services scoped to an Istio// mesh. Metrics for Istio are documented here// (https://istio.io/latest/docs/reference/config/metrics/)IstioCanonicalService *IstioCanonicalService `json:"istioCanonicalService,omitempty"`// MeshIstio: Type used for Istio services scoped to an Istio mesh.MeshIstio *MeshIstio `json:"meshIstio,omitempty"`// Name: Identifier. Resource name for this Service. The format is:// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]Namestring `json:"name,omitempty"`// Telemetry: Configuration for how to query telemetry on a Service.Telemetry *Telemetry `json:"telemetry,omitempty"`// UserLabels: 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.UserLabels map[string]string `json:"userLabels,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AppEngine") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppEngine") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MService: 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, aService acts as the root resource under which operational aspects of theservice are accessible.

func (MService)MarshalJSONadded inv0.15.0

func (sMService) MarshalJSON() ([]byte,error)

typeMeshIstioadded inv0.18.0

type MeshIstio struct {// MeshUid: Identifier for the mesh in which this Istio service is defined.// Corresponds to the mesh_uid metric label in Istio metrics.MeshUidstring `json:"meshUid,omitempty"`// ServiceName: The name of the Istio service underlying this service.// Corresponds to the destination_service_name metric label in Istio metrics.ServiceNamestring `json:"serviceName,omitempty"`// ServiceNamespace: The namespace of the Istio service underlying this// service. Corresponds to the destination_service_namespace metric label in// Istio metrics.ServiceNamespacestring `json:"serviceNamespace,omitempty"`// ForceSendFields is a list of field names (e.g. "MeshUid") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MeshUid") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MeshIstio: Istio service scoped to an Istio mesh. Anthos clusters runningASM < 1.6.8 will have their services ingested as this type.

func (MeshIstio)MarshalJSONadded inv0.18.0

func (sMeshIstio) MarshalJSON() ([]byte,error)

typeMetric

type Metric struct {// Labels: The set of label values that uniquely identify this metric. All// labels listed in the MetricDescriptor must be assigned values.Labels map[string]string `json:"labels,omitempty"`// Type: An existing metric type, see google.api.MetricDescriptor. For example,// custom.googleapis.com/invoice/paid/amount.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Labels") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Metric: A specific metric, identified by specifying values for all of thelabels of a MetricDescriptor.

func (Metric)MarshalJSON

func (sMetric) MarshalJSON() ([]byte,error)

typeMetricAbsence

type MetricAbsence struct {// Aggregations: 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// (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).// It is advisable to use the ListTimeSeries method when debugging this field.Aggregations []*Aggregation `json:"aggregations,omitempty"`// Duration: Required. 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.Durationstring `json:"duration,omitempty"`// Filter: Required. A filter// (https://cloud.google.com/monitoring/api/v3/filters) 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// (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)// (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.Filterstring `json:"filter,omitempty"`// 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.Trigger *Trigger `json:"trigger,omitempty"`// ForceSendFields is a list of field names (e.g. "Aggregations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Aggregations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricAbsence: A condition type that checks that monitored resources arereporting data. The configuration defines a metric and a set of monitoredresources. The predicate is considered in violation when a time series forthe specified metric of a monitored resource does not include any data inthe specified duration.

func (MetricAbsence)MarshalJSON

func (sMetricAbsence) MarshalJSON() ([]byte,error)

typeMetricDescriptor

type MetricDescriptor struct {// Description: A detailed description of the metric, which can be used in// documentation.Descriptionstring `json:"description,omitempty"`// DisplayName: A concise name for the metric, which can be displayed in user// interfaces. Use sentence case without an ending period, for example "Request// count". This field is optional but it is recommended to be set for any// metrics associated with user-visible concepts, such as Quota.DisplayNamestring `json:"displayName,omitempty"`// Labels: The set of labels that can be used to describe a specific instance// of this metric type. For example, the// appengine.googleapis.com/http/server/response_latencies metric type has a// label for the HTTP response code, response_code, so you can look at// latencies for successful responses or just for responses that failed.Labels []*LabelDescriptor `json:"labels,omitempty"`// LaunchStage: Optional. The launch stage of the metric definition.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// Terms of Service (https://cloud.google.com/terms/) and the Google Cloud// Platform Subject to the Deprecation Policy// (https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// Metadata: Optional. Metadata which can be used to guide usage of the metric.Metadata *MetricDescriptorMetadata `json:"metadata,omitempty"`// MetricKind: Whether the metric records instantaneous values, changes to a// value, etc. Some combinations of metric_kind and value_type might not be// supported.//// Possible values://   "METRIC_KIND_UNSPECIFIED" - Do not use this default value.//   "GAUGE" - An instantaneous measurement of a value.//   "DELTA" - The change in a value during a time interval.//   "CUMULATIVE" - A value accumulated over a time interval. Cumulative// measurements in a time series should have the same start time and increasing// end times, until an event resets the cumulative value to zero and sets a new// start time for the following points.MetricKindstring `json:"metricKind,omitempty"`// MonitoredResourceTypes: Read-only. If present, then a time series, which is// identified partially by a metric type and a MonitoredResourceDescriptor,// that is associated with this metric type can only be associated with one of// the monitored resource types listed here.MonitoredResourceTypes []string `json:"monitoredResourceTypes,omitempty"`// Name: The resource name of the metric descriptor.Namestring `json:"name,omitempty"`// Type: The metric type, including its DNS name prefix. The type is not// URL-encoded. All user-defined metric types have the DNS name// custom.googleapis.com or external.googleapis.com. Metric types should use a// natural hierarchical grouping. For example:// "custom.googleapis.com/invoice/paid/amount"// "external.googleapis.com/prometheus/up"// "appengine.googleapis.com/http/server/response_latencies"Typestring `json:"type,omitempty"`// Unit: 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.Different systems might scale the// values to be more easily displayed (so a value of 0.02kBy might be displayed// as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if// the unit is kBy, then the value of the metric is always in thousands of// bytes, no matter how it might be displayed.If you want a custom metric to// record the exact number of CPU-seconds used by a job, you can create an// INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or// just s). If the job uses 12,005 CPU-seconds, then the value is written as// 12005.Alternatively, if you want a custom metric to record data in a more// granular way, you can create a DOUBLE CUMULATIVE metric whose unit is// ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use// Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a// subset of The Unified Code for Units of Measure// (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit// By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k// kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa// (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n// nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto// (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti// tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors:// / division or ratio (as an infix operator). For examples, kBy/{email} or// MiBy/10ms (although you should almost never have /s in a metric unit; rates// should always be computed at query time from the underlying cumulative or// delta value). . multiplication or composition (as an infix operator). For// examples, GBy.d or k{watt}.h.The grammar for a unit is as follows:// Expression = Component { "." Component } { "/" Component } ; Component = ( [// PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{"// NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the// annotation is used alone, then the unit is equivalent to 1. For examples,// {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of// non-blank printable ASCII characters not containing { or }. 1 represents a// unitary dimensionless unit// (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s.// It is typically used when none of the basic units are appropriate. For// example, "new users per day" can be represented as 1/d or {new-users}/d (and// a metric value 5 would mean "5 new users). Alternatively, "thousands of page// views per day" would be represented as 1000/d or k1/d or k{page_views}/d// (and a metric value of 5.3 would mean "5300 page views per day"). %// represents dimensionless value of 1/100, and annotates values giving a// percentage (so the metric values are typically in the range of 0..100, and a// metric value 3 means "3 percent"). 10^2.% indicates a metric contains a// ratio, typically in the range 0..1, that will be multiplied by 100 and// displayed as a percentage (so a metric value 0.03 means "3 percent").Unitstring `json:"unit,omitempty"`// ValueType: Whether the measurement is an integer, a floating-point number,// etc. Some combinations of metric_kind and value_type might not be supported.//// Possible values://   "VALUE_TYPE_UNSPECIFIED" - Do not use this default value.//   "BOOL" - The value is a boolean. This value type can be used only if the// metric kind is GAUGE.//   "INT64" - The value is a signed 64-bit integer.//   "DOUBLE" - The value is a double precision floating point number.//   "STRING" - The value is a text string. This value type can be used only if// the metric kind is GAUGE.//   "DISTRIBUTION" - The value is a Distribution.//   "MONEY" - The value is money.ValueTypestring `json:"valueType,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricDescriptor: Defines a metric type and its schema. Once a metricdescriptor is created, deleting or altering it stops data collection andmakes the metric type's existing data unusable.

func (MetricDescriptor)MarshalJSON

func (sMetricDescriptor) MarshalJSON() ([]byte,error)

typeMetricDescriptorMetadata

type MetricDescriptorMetadata struct {// IngestDelay: The delay of data points caused by ingestion. Data points older// than this age are guaranteed to be ingested and available to be read,// excluding data loss due to errors.IngestDelaystring `json:"ingestDelay,omitempty"`// LaunchStage: Deprecated. Must use the MetricDescriptor.launch_stage instead.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// Terms of Service (https://cloud.google.com/terms/) and the Google Cloud// Platform Subject to the Deprecation Policy// (https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// SamplePeriod: The sampling period of metric data points. For metrics which// are written periodically, consecutive data points are stored at this time// interval, excluding data loss due to errors. Metrics with a higher// granularity have a smaller sampling period.SamplePeriodstring `json:"samplePeriod,omitempty"`// TimeSeriesResourceHierarchyLevel: The scope of the timeseries data of the// metric.//// Possible values://   "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED" - Do not use this// default value.//   "PROJECT" - Scopes a metric to a project.//   "ORGANIZATION" - Scopes a metric to an organization.//   "FOLDER" - Scopes a metric to a folder.TimeSeriesResourceHierarchyLevel []string `json:"timeSeriesResourceHierarchyLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "IngestDelay") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IngestDelay") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricDescriptorMetadata: Additional annotations that can be used to guidethe usage of a metric.

func (MetricDescriptorMetadata)MarshalJSON

func (sMetricDescriptorMetadata) MarshalJSON() ([]byte,error)

typeMetricRangeadded inv0.14.0

type MetricRange struct {// Range: Range of values considered "good." For a one-sided range, set one// bound to an infinite value.Range *GoogleMonitoringV3Range `json:"range,omitempty"`// TimeSeries: A monitoring filter// (https://cloud.google.com/monitoring/api/v3/filters) specifying the// TimeSeries to use for evaluating window quality.TimeSeriesstring `json:"timeSeries,omitempty"`// ForceSendFields is a list of field names (e.g. "Range") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Range") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricRange: A MetricRange is used when each window is good when the value xof a single TimeSeries satisfies range.min <= x <= range.max. The providedTimeSeries must have ValueType = INT64 or ValueType = DOUBLE and MetricKind= GAUGE.

func (MetricRange)MarshalJSONadded inv0.14.0

func (sMetricRange) MarshalJSON() ([]byte,error)

typeMetricThreshold

type MetricThreshold struct {// Aggregations: 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// (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).// It is advisable to use the ListTimeSeries method when debugging this field.Aggregations []*Aggregation `json:"aggregations,omitempty"`// Comparison: 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.//// Possible values://   "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.Comparisonstring `json:"comparison,omitempty"`// DenominatorAggregations: 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.DenominatorAggregations []*Aggregation `json:"denominatorAggregations,omitempty"`// DenominatorFilter: A filter// (https://cloud.google.com/monitoring/api/v3/filters) 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.DenominatorFilterstring `json:"denominatorFilter,omitempty"`// Duration: Required. 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.Durationstring `json:"duration,omitempty"`// 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.//// Possible values://   "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.EvaluationMissingDatastring `json:"evaluationMissingData,omitempty"`// Filter: Required. A filter// (https://cloud.google.com/monitoring/api/v3/filters) 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// (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)// (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.Filterstring `json:"filter,omitempty"`// 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.ForecastOptions *ForecastOptions `json:"forecastOptions,omitempty"`// ThresholdValue: A value against which to compare the time series.ThresholdValuefloat64 `json:"thresholdValue,omitempty"`// 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.Trigger *Trigger `json:"trigger,omitempty"`// ForceSendFields is a list of field names (e.g. "Aggregations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Aggregations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MetricThreshold: A condition type that compares a collection of time seriesagainst a threshold.

func (MetricThreshold)MarshalJSON

func (sMetricThreshold) MarshalJSON() ([]byte,error)

func (*MetricThreshold)UnmarshalJSON

func (s *MetricThreshold) UnmarshalJSON(data []byte)error

typeMinutesadded inv0.200.0

type Minutes struct {// Periodicity: 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.Periodicityint64 `json:"periodicity,omitempty"`// ForceSendFields is a list of field names (e.g. "Periodicity") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Periodicity") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Minutes)MarshalJSONadded inv0.200.0

func (sMinutes) MarshalJSON() ([]byte,error)

typeMonitoredResource

type MonitoredResource struct {// Labels: Required. Values for all of the labels listed in the associated// monitored resource descriptor. For example, Compute Engine VM instances use// the labels "project_id", "instance_id", and "zone".Labels map[string]string `json:"labels,omitempty"`// Type: Required. The monitored resource type. This field must match the type// field of a MonitoredResourceDescriptor object. For example, the type of a// Compute Engine VM instance is gce_instance. For a list of types, see// Monitoring resource types// (https://cloud.google.com/monitoring/api/resources) and Logging resource// types (https://cloud.google.com/logging/docs/api/v2/resource-list).Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Labels") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Labels") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MonitoredResource: An object representing a resource that can be used formonitoring, logging, billing, or other purposes. Examples include virtualmachine instances, databases, and storage devices such as disks. The typefield identifies a MonitoredResourceDescriptor object that describes theresource's schema. Information in the labels field identifies the actualresource and its attributes according to the schema. For example, aparticular Compute Engine VM instance could be represented by the followingobject, because the MonitoredResourceDescriptor for "gce_instance" haslabels "project_id", "instance_id" and "zone": { "type": "gce_instance","labels": { "project_id": "my-project", "instance_id": "12345678901234","zone": "us-central1-a" }}

func (MonitoredResource)MarshalJSON

func (sMonitoredResource) MarshalJSON() ([]byte,error)

typeMonitoredResourceDescriptor

type MonitoredResourceDescriptor struct {// Description: Optional. A detailed description of the monitored resource type// that might be used in documentation.Descriptionstring `json:"description,omitempty"`// DisplayName: Optional. A concise name for the monitored resource type that// might be displayed in user interfaces. It should be a Title Cased Noun// Phrase, without any article or other determiners. For example, "Google Cloud// SQL Database".DisplayNamestring `json:"displayName,omitempty"`// Labels: Required. A set of labels used to describe instances of this// monitored resource type. For example, an individual Google Cloud SQL// database is identified by values for the labels "database_id" and "zone".Labels []*LabelDescriptor `json:"labels,omitempty"`// LaunchStage: Optional. The launch stage of the monitored resource// definition.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// Terms of Service (https://cloud.google.com/terms/) and the Google Cloud// Platform Subject to the Deprecation Policy// (https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// Name: Optional. The resource name of the monitored resource descriptor:// "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is// the value of the type field in this object and {project_id} is a project ID// that provides API-specific context for accessing the type. APIs that do not// use project information can use the resource name format// "monitoredResourceDescriptors/{type}".Namestring `json:"name,omitempty"`// Type: Required. The monitored resource type. For example, the type// "cloudsql_database" represents databases in Google Cloud SQL. For a list of// types, see Monitored resource types// (https://cloud.google.com/monitoring/api/resources) and Logging resource// types (https://cloud.google.com/logging/docs/api/v2/resource-list).Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MonitoredResourceDescriptor: An object that describes the schema of aMonitoredResource object using a type name and a set of labels. For example,the monitored resource descriptor for Google Compute Engine VM instances hasa type of "gce_instance" and specifies the use of the labels "instance_id"and "zone" to identify particular VM instances.Different APIs can supportdifferent monitored resource types. APIs generally provide a list methodthat returns the monitored resource descriptors used by the API.

func (MonitoredResourceDescriptor)MarshalJSON

func (sMonitoredResourceDescriptor) MarshalJSON() ([]byte,error)

typeMonitoredResourceMetadata

type MonitoredResourceMetadata struct {// SystemLabels: Output only. Values for predefined system metadata labels.// System labels are a kind of metadata extracted by Google, including// "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System// label values can be only strings, Boolean values, or a list of strings. For// example: { "name": "my-test-instance", "security_group": ["a", "b", "c"],// "spot_instance": false }SystemLabelsgoogleapi.RawMessage `json:"systemLabels,omitempty"`// UserLabels: Output only. A map of user-defined metadata labels.UserLabels map[string]string `json:"userLabels,omitempty"`// ForceSendFields is a list of field names (e.g. "SystemLabels") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SystemLabels") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MonitoredResourceMetadata: Auxiliary metadata for a MonitoredResourceobject. MonitoredResource objects contain the minimum set of information touniquely identify a monitored resource instance. There is some other usefulauxiliary metadata. Monitoring and Logging use an ingestion pipeline toextract metadata for cloud resources of all types, and store the metadata inthis message.

func (MonitoredResourceMetadata)MarshalJSON

func (sMonitoredResourceMetadata) MarshalJSON() ([]byte,error)

typeMonitoringQueryLanguageConditionadded inv0.33.0

type MonitoringQueryLanguageCondition struct {// Duration: Optional. 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. The default value is zero.Durationstring `json:"duration,omitempty"`// EvaluationMissingData: A condition control that determines how// metric-threshold conditions are evaluated when data stops arriving.//// Possible values://   "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.EvaluationMissingDatastring `json:"evaluationMissingData,omitempty"`// Query: Monitoring Query Language (https://cloud.google.com/monitoring/mql)// query that outputs a boolean stream.Querystring `json:"query,omitempty"`// 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.Trigger *Trigger `json:"trigger,omitempty"`// ForceSendFields is a list of field names (e.g. "Duration") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Duration") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MonitoringQueryLanguageCondition: A condition type that allows alertingpolicies to be defined using Monitoring Query Language(https://cloud.google.com/monitoring/mql).

func (MonitoringQueryLanguageCondition)MarshalJSONadded inv0.33.0

func (sMonitoringQueryLanguageCondition) MarshalJSON() ([]byte,error)

typeMutationRecord

type MutationRecord struct {// MutateTime: When the change occurred.MutateTimestring `json:"mutateTime,omitempty"`// MutatedBy: The email address of the user making the change.MutatedBystring `json:"mutatedBy,omitempty"`// ForceSendFields is a list of field names (e.g. "MutateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MutateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

MutationRecord: Describes a change made to a configuration.

func (MutationRecord)MarshalJSON

func (sMutationRecord) MarshalJSON() ([]byte,error)

typeNotificationChannel

type NotificationChannel struct {// CreationRecord: Record of the creation of this channel.CreationRecord *MutationRecord `json:"creationRecord,omitempty"`// Description: 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.Descriptionstring `json:"description,omitempty"`// DisplayName: 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.DisplayNamestring `json:"displayName,omitempty"`// Enabled: 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.Enabledbool `json:"enabled,omitempty"`// Labels: 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.Labels map[string]string `json:"labels,omitempty"`// MutationRecords: Records of the modification of this channel.MutationRecords []*MutationRecord `json:"mutationRecords,omitempty"`// Name: 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.Namestring `json:"name,omitempty"`// Type: The type of the notification channel. This field matches the value of// the NotificationChannelDescriptor.type field.Typestring `json:"type,omitempty"`// UserLabels: 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.UserLabels map[string]string `json:"userLabels,omitempty"`// 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.//// Possible values://   "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.VerificationStatusstring `json:"verificationStatus,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreationRecord") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreationRecord") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NotificationChannel: A NotificationChannel is a medium through which analert is delivered when a policy violation is detected. Examples of channelsinclude email, SMS, and third-party messaging applications. Fieldscontaining sensitive information like authentication tokens or contact infoare only partially populated on retrieval.

func (NotificationChannel)MarshalJSON

func (sNotificationChannel) MarshalJSON() ([]byte,error)

typeNotificationChannelDescriptor

type NotificationChannelDescriptor struct {// Description: 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.Descriptionstring `json:"description,omitempty"`// DisplayName: A human-readable name for the notification channel type. This// form of the name is suitable for a user interface.DisplayNamestring `json:"displayName,omitempty"`// Labels: 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.Labels []*LabelDescriptor `json:"labels,omitempty"`// LaunchStage: The product launch stage for channels of this type.//// Possible values://   "LAUNCH_STAGE_UNSPECIFIED" - Do not use this default value.//   "UNIMPLEMENTED" - The feature is not yet implemented. Users can not use// it.//   "PRELAUNCH" - Prelaunch features are hidden from users and are only// visible internally.//   "EARLY_ACCESS" - Early Access features are limited to a closed group of// testers. To use these features, you must sign up in advance and sign a// Trusted Tester agreement (which includes confidentiality provisions). These// features may be unstable, changed in backward-incompatible ways, and are not// guaranteed to be released.//   "ALPHA" - Alpha is a limited availability test for releases before they// are cleared for widespread use. By Alpha, all significant design issues are// resolved and we are in the process of verifying functionality. Alpha// customers need to apply for access, agree to applicable terms, and have// their projects allowlisted. Alpha releases don't have to be feature// complete, no SLAs are provided, and there are no technical support// obligations, but they will be far enough along that customers can actually// use them in test environments or for limited-use tests -- just like they// would in normal production cases.//   "BETA" - Beta is the point at which we are ready to open a release for any// customer to use. There are no SLA or technical support obligations in a Beta// release. Products will be complete from a feature perspective, but may have// some open outstanding issues. Beta releases are suitable for limited// production use cases.//   "GA" - GA features are open to all developers and are considered stable// and fully qualified for production use.//   "DEPRECATED" - Deprecated features are scheduled to be shut down and// removed. For more information, see the "Deprecation Policy" section of our// Terms of Service (https://cloud.google.com/terms/) and the Google Cloud// Platform Subject to the Deprecation Policy// (https://cloud.google.com/terms/deprecation) documentation.LaunchStagestring `json:"launchStage,omitempty"`// Name: 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.Namestring `json:"name,omitempty"`// SupportedTiers: The tiers that support this notification channel; the// project service tier must be one of the supported_tiers.//// Possible values://   "SERVICE_TIER_UNSPECIFIED" - An invalid sentinel value, used to indicate// that a tier has not been provided explicitly.//   "SERVICE_TIER_BASIC" - The Cloud Monitoring Basic tier, a free tier of// service that provides basic features, a moderate allotment of logs, and// access to built-in metrics. A number of features are not available in this// tier. For more details, see the service tiers documentation// (https://cloud.google.com/monitoring/workspaces/tiers).//   "SERVICE_TIER_PREMIUM" - The Cloud Monitoring Premium tier, a higher, more// expensive tier of service that provides access to all Cloud Monitoring// features, lets you use Cloud Monitoring with AWS accounts, and has a larger// allotments for logs and metrics. For more details, see the service tiers// documentation (https://cloud.google.com/monitoring/workspaces/tiers).SupportedTiers []string `json:"supportedTiers,omitempty"`// Type: The type of notification channel, such as "email" and "sms". To view// the full list of channels, see Channel descriptors// (https://cloud.google.com/monitoring/alerts/using-channels-api#ncd).// Notification channel types are globally unique.Typestring `json:"type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NotificationChannelDescriptor: A description of a notification channel. Thedescriptor includes the properties of the channel and the set of labels orfields that must be specified to configure channels of a given type.

func (NotificationChannelDescriptor)MarshalJSON

func (sNotificationChannelDescriptor) MarshalJSON() ([]byte,error)

typeNotificationChannelStrategyadded inv0.115.0

type NotificationChannelStrategy struct {// NotificationChannelNames: The full REST resource name for the notification// channels that these settings apply to. Each of these correspond to the name// field in one of the NotificationChannel objects referenced in the// notification_channels field of this AlertPolicy. The format is:// projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]NotificationChannelNames []string `json:"notificationChannelNames,omitempty"`// RenotifyInterval: The frequency at which to send reminder notifications for// open incidents.RenotifyIntervalstring `json:"renotifyInterval,omitempty"`// ForceSendFields is a list of field names (e.g. "NotificationChannelNames")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NotificationChannelNames") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NotificationChannelStrategy: Control over how the notification channels innotification_channels are notified when this alert fires, on a per-channelbasis.

func (NotificationChannelStrategy)MarshalJSONadded inv0.115.0

func (sNotificationChannelStrategy) MarshalJSON() ([]byte,error)

typeNotificationRateLimitadded inv0.51.0

type NotificationRateLimit struct {// Period: Not more than one notification per period.Periodstring `json:"period,omitempty"`// ForceSendFields is a list of field names (e.g. "Period") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Period") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

NotificationRateLimit: Control over the rate of notifications sent to thisalerting policy's notification channels.

func (NotificationRateLimit)MarshalJSONadded inv0.51.0

func (sNotificationRateLimit) MarshalJSON() ([]byte,error)

typeOperationMetadataadded inv0.49.0

type OperationMetadata struct {// CreateTime: The time when the batch request was received.CreateTimestring `json:"createTime,omitempty"`// State: Current state of the batch operation.//// Possible values://   "STATE_UNSPECIFIED" - Invalid.//   "CREATED" - Request has been received.//   "RUNNING" - Request is actively being processed.//   "DONE" - The batch processing is done.//   "CANCELLED" - The batch processing was cancelled.Statestring `json:"state,omitempty"`// UpdateTime: The time when the operation result was last updated.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OperationMetadata: Contains metadata for longrunning operation for the editMetrics Scope endpoints.

func (OperationMetadata)MarshalJSONadded inv0.49.0

func (sOperationMetadata) MarshalJSON() ([]byte,error)

typeOption

type Option struct {// Name: The option's name. For protobuf built-in options (options defined in// descriptor.proto), this is the short name. For example, "map_entry". For// custom options, it should be the fully-qualified name. For example,// "google.api.http".Namestring `json:"name,omitempty"`// Value: The option's value packed in an Any message. If the value is a// primitive, the corresponding wrapper type defined in// google/protobuf/wrappers.proto should be used. If the value is an enum, it// should be stored as an int32 value using the google.protobuf.Int32Value// type.Valuegoogleapi.RawMessage `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Option: A protocol buffer option, which can be attached to a message, field,enumeration, etc.New usages of this message as an alternative toFileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions,ServiceOptions, or MethodOptions are strongly discouraged.

func (Option)MarshalJSON

func (sOption) MarshalJSON() ([]byte,error)

typeOrganizationsServiceadded inv0.37.0

type OrganizationsService struct {TimeSeries *OrganizationsTimeSeriesService// contains filtered or unexported fields}

funcNewOrganizationsServiceadded inv0.37.0

func NewOrganizationsService(s *Service) *OrganizationsService

typeOrganizationsTimeSeriesListCalladded inv0.37.0

type OrganizationsTimeSeriesListCall struct {// contains filtered or unexported fields}

func (*OrganizationsTimeSeriesListCall)AggregationAlignmentPeriodadded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) AggregationAlignmentPeriod(aggregationAlignmentPeriodstring) *OrganizationsTimeSeriesListCall

AggregationAlignmentPeriod sets the optional parameter"aggregation.alignmentPeriod": The alignment_period specifies a timeinterval, in seconds, that is used to divide the data in all the time seriesinto consistent blocks of time. This will be done before the per-seriesaligner can be applied to the data.The value must be at least 60 seconds. Ifa per-series aligner other than ALIGN_NONE is specified, this field isrequired or an error is returned. If no per-series aligner is specified, orthe aligner ALIGN_NONE is specified, then this field is ignored.The maximumvalue of the alignment_period is 104 weeks (2 years) for charts, and 90,000seconds (25 hours) for alerting policies.

func (*OrganizationsTimeSeriesListCall)AggregationCrossSeriesReduceradded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) AggregationCrossSeriesReducer(aggregationCrossSeriesReducerstring) *OrganizationsTimeSeriesListCall

AggregationCrossSeriesReducer sets the optional parameter"aggregation.crossSeriesReducer": The reduction operation to be used tocombine time series into a single time series, where the value of each datapoint in the resulting series is a function of all the already alignedvalues in the input time series.Not all reducer operations can be applied toall time series. The valid choices depend on the metric_kind and thevalue_type of the original time series. Reduction can yield a time serieswith a different metric_kind or value_type than the input time series.Timeseries data must first be aligned (see per_series_aligner) in order toperform cross-time series reduction. If cross_series_reducer is specified,then per_series_aligner must be specified, and must not be ALIGN_NONE. Analignment_period must also be specified; otherwise, an error is returned.

Possible values:

"REDUCE_NONE" - No cross-time series reduction. The output of the Aligner

is returned.

"REDUCE_MEAN" - Reduce by computing the mean value across time series for

each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric or distribution values. The value_type of the output is DOUBLE.

"REDUCE_MIN" - Reduce by computing the minimum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_MAX" - Reduce by computing the maximum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_SUM" - Reduce by computing the sum across time series for each

alignment period. This reducer is valid for DELTA and GAUGE metrics withnumeric and distribution values. The value_type of the output is the same asthe value_type of the input.

"REDUCE_STDDEV" - Reduce by computing the standard deviation across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics with numeric or distribution values. The value_type of the output isDOUBLE.

"REDUCE_COUNT" - Reduce by computing the number of data points across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics of numeric, Boolean, distribution, and string value_type. Thevalue_type of the output is INT64.

"REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of

True-valued data points to the total number of data points for eachalignment period. This reducer is valid for DELTA and GAUGE metrics ofBoolean value_type. The output value is in the range 0.0, 1.0 and hasvalue_type DOUBLE.

"REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

func (*OrganizationsTimeSeriesListCall)AggregationGroupByFieldsadded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) AggregationGroupByFields(aggregationGroupByFields ...string) *OrganizationsTimeSeriesListCall

AggregationGroupByFields sets the optional parameter"aggregation.groupByFields": The set of fields to preserve whencross_series_reducer is specified. The group_by_fields determine how thetime series are partitioned into subsets prior to applying the aggregationoperation. Each subset contains time series that have the same value foreach of the grouping fields. Each individual time series is a member ofexactly one subset. The cross_series_reducer is applied to each subset oftime series. It is not possible to reduce across different resource types,so this field implicitly contains resource.type. Fields not specified ingroup_by_fields are aggregated away. If group_by_fields is not specified andall the time series have the same resource type, then the time series areaggregated into a single output time series. If cross_series_reducer is notdefined, this field is ignored.

func (*OrganizationsTimeSeriesListCall)AggregationPerSeriesAligneradded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) AggregationPerSeriesAligner(aggregationPerSeriesAlignerstring) *OrganizationsTimeSeriesListCall

AggregationPerSeriesAligner sets the optional parameter"aggregation.perSeriesAligner": An Aligner describes how to bring the datapoints in a single time series into temporal alignment. Except forALIGN_NONE, all alignments cause all the data points in an alignment_periodto be mathematically grouped together, resulting in a single data point foreach alignment_period with end timestamp at the end of the period.Not allalignment operations may be applied to all time series. The valid choicesdepend on the metric_kind and value_type of the original time series.Alignment can change the metric_kind or the value_type of the timeseries.Time series data must be aligned in order to perform cross-timeseries reduction. If cross_series_reducer is specified, thenper_series_aligner must be specified and not equal to ALIGN_NONE andalignment_period must be specified; otherwise, an error is returned.

Possible values:

"ALIGN_NONE" - No alignment. Raw data is returned. Not valid if

cross-series reduction is requested. The value_type of the result is thesame as the value_type of the input.

"ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -

y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selectedalignment period results in periods with no data, then the aligned value forsuch a period is created by interpolation. The value_type of the alignedresult is the same as the value_type of the input.

"ALIGN_RATE" - Align and convert to a rate. The result is computed as rate

= (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner asproviding the slope of the line that passes through the value at the startand at the end of the alignment_period.This aligner is valid for CUMULATIVEand DELTA metrics with numeric values. If the selected alignment periodresults in periods with no data, then the aligned value for such a period iscreated by interpolation. The output is a GAUGE metric with value_typeDOUBLE.If, by "rate", you mean "percentage change", see theALIGN_PERCENT_CHANGE aligner instead.

"ALIGN_INTERPOLATE" - Align by interpolating between adjacent points

around the alignment period boundary. This aligner is valid for GAUGEmetrics with numeric values. The value_type of the aligned result is thesame as the value_type of the input.

"ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the

end of the alignment period to the boundary at the end of the alignmentperiod. This aligner is valid for GAUGE metrics. The value_type of thealigned result is the same as the value_type of the input.

"ALIGN_MIN" - Align the time series by returning the minimum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MAX" - Align the time series by returning the maximum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MEAN" - Align the time series by returning the mean value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is DOUBLE.

"ALIGN_COUNT" - Align the time series by returning the number of values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric or Boolean values. The value_type of the aligned result isINT64.

"ALIGN_SUM" - Align the time series by returning the sum of the values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric and distribution values. The value_type of the aligned resultis the same as the value_type of the input.

"ALIGN_STDDEV" - Align the time series by returning the standard deviation

of the values in each alignment period. This aligner is valid for GAUGE andDELTA metrics with numeric values. The value_type of the output is DOUBLE.

"ALIGN_COUNT_TRUE" - Align the time series by returning the number of True

values in each alignment period. This aligner is valid for GAUGE metricswith Boolean values. The value_type of the output is INT64.

"ALIGN_COUNT_FALSE" - Align the time series by returning the number of

False values in each alignment period. This aligner is valid for GAUGEmetrics with Boolean values. The value_type of the output is INT64.

"ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of

the number of True values to the total number of values in each alignmentperiod. This aligner is valid for GAUGE metrics with Boolean values. Theoutput value is in the range 0.0, 1.0 and has value_type DOUBLE.

"ALIGN_PERCENTILE_99" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 99th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_95" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 95th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_50" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 50th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_05" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 5th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This

aligner is valid for GAUGE and DELTA metrics with numeric values. Thisalignment returns ((current - previous)/previous) * 100, where the value ofprevious is determined based on the alignment_period.If the values ofcurrent and previous are both 0, then the returned value is 0. If onlyprevious is 0, the returned value is infinity.A 10-minute moving mean iscomputed at each point of the alignment period prior to the abovecalculation to smooth the metric and prevent false positives from veryshort-lived spikes. The moving mean is only applicable for data whose valuesare >= 0. Any values < 0 are treated as a missing datapoint, and areignored. While DELTA metrics are accepted by this alignment, special careshould be taken that the values for the metric will always be positive. Theoutput is a GAUGE metric with value_type DOUBLE.

func (*OrganizationsTimeSeriesListCall)Contextadded inv0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsTimeSeriesListCall)Doadded inv0.37.0

Do executes the "monitoring.organizations.timeSeries.list" call.Any non-2xx status code is an error. Response headers are in either*ListTimeSeriesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*OrganizationsTimeSeriesListCall)Fieldsadded inv0.37.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsTimeSeriesListCall)Filteradded inv0.37.0

Filter sets the optional parameter "filter": Required. A monitoring filter(https://cloud.google.com/monitoring/api/v3/filters) that specifies whichtime series should be returned. The filter must specify a single metrictype, and can additionally specify metric labels and other information. Forexample: metric.type = "compute.googleapis.com/instance/cpu/usage_time" ANDmetric.labels.instance_name = "my-instance-name"

func (*OrganizationsTimeSeriesListCall)Headeradded inv0.37.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*OrganizationsTimeSeriesListCall)IfNoneMatchadded inv0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*OrganizationsTimeSeriesListCall)IntervalEndTimeadded inv0.37.0

IntervalEndTime sets the optional parameter "interval.endTime": Required.The end of the time interval.

func (*OrganizationsTimeSeriesListCall)IntervalStartTimeadded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) IntervalStartTime(intervalStartTimestring) *OrganizationsTimeSeriesListCall

IntervalStartTime sets the optional parameter "interval.startTime": Thebeginning of the time interval. The default value for the start time is theend time. The start time must not be later than the end time.

func (*OrganizationsTimeSeriesListCall)OrderByadded inv0.37.0

OrderBy sets the optional parameter "orderBy": Unsupported: must be leftblank. The points in each time series are currently returned in reverse timeorder (most recent to oldest).

func (*OrganizationsTimeSeriesListCall)PageSizeadded inv0.37.0

PageSize sets the optional parameter "pageSize": A positive number that isthe maximum number of results to return. If page_size is empty or more than100,000 results, the effective page_size is 100,000 results. If view is setto FULL, this is the maximum number of Points returned. If view is set toHEADERS, this is the maximum number of TimeSeries returned.

func (*OrganizationsTimeSeriesListCall)PageTokenadded inv0.37.0

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*OrganizationsTimeSeriesListCall)Pagesadded inv0.37.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*OrganizationsTimeSeriesListCall)SecondaryAggregationAlignmentPeriodadded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) SecondaryAggregationAlignmentPeriod(secondaryAggregationAlignmentPeriodstring) *OrganizationsTimeSeriesListCall

SecondaryAggregationAlignmentPeriod sets the optional parameter"secondaryAggregation.alignmentPeriod": The alignment_period specifies atime interval, in seconds, that is used to divide the data in all the timeseries into consistent blocks of time. This will be done before theper-series aligner can be applied to the data.The value must be at least 60seconds. If a per-series aligner other than ALIGN_NONE is specified, thisfield is required or an error is returned. If no per-series aligner isspecified, or the aligner ALIGN_NONE is specified, then this field isignored.The maximum value of the alignment_period is 104 weeks (2 years) forcharts, and 90,000 seconds (25 hours) for alerting policies.

func (*OrganizationsTimeSeriesListCall)SecondaryAggregationCrossSeriesReduceradded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) SecondaryAggregationCrossSeriesReducer(secondaryAggregationCrossSeriesReducerstring) *OrganizationsTimeSeriesListCall

SecondaryAggregationCrossSeriesReducer sets the optional parameter"secondaryAggregation.crossSeriesReducer": The reduction operation to beused to combine time series into a single time series, where the value ofeach data point in the resulting series is a function of all the alreadyaligned values in the input time series.Not all reducer operations can beapplied to all time series. The valid choices depend on the metric_kind andthe value_type of the original time series. Reduction can yield a timeseries with a different metric_kind or value_type than the input timeseries.Time series data must first be aligned (see per_series_aligner) inorder to perform cross-time series reduction. If cross_series_reducer isspecified, then per_series_aligner must be specified, and must not beALIGN_NONE. An alignment_period must also be specified; otherwise, an erroris returned.

Possible values:

"REDUCE_NONE" - No cross-time series reduction. The output of the Aligner

is returned.

"REDUCE_MEAN" - Reduce by computing the mean value across time series for

each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric or distribution values. The value_type of the output is DOUBLE.

"REDUCE_MIN" - Reduce by computing the minimum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_MAX" - Reduce by computing the maximum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_SUM" - Reduce by computing the sum across time series for each

alignment period. This reducer is valid for DELTA and GAUGE metrics withnumeric and distribution values. The value_type of the output is the same asthe value_type of the input.

"REDUCE_STDDEV" - Reduce by computing the standard deviation across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics with numeric or distribution values. The value_type of the output isDOUBLE.

"REDUCE_COUNT" - Reduce by computing the number of data points across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics of numeric, Boolean, distribution, and string value_type. Thevalue_type of the output is INT64.

"REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of

True-valued data points to the total number of data points for eachalignment period. This reducer is valid for DELTA and GAUGE metrics ofBoolean value_type. The output value is in the range 0.0, 1.0 and hasvalue_type DOUBLE.

"REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

func (*OrganizationsTimeSeriesListCall)SecondaryAggregationGroupByFieldsadded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) SecondaryAggregationGroupByFields(secondaryAggregationGroupByFields ...string) *OrganizationsTimeSeriesListCall

SecondaryAggregationGroupByFields sets the optional parameter"secondaryAggregation.groupByFields": The set of fields to preserve whencross_series_reducer is specified. The group_by_fields determine how thetime series are partitioned into subsets prior to applying the aggregationoperation. Each subset contains time series that have the same value foreach of the grouping fields. Each individual time series is a member ofexactly one subset. The cross_series_reducer is applied to each subset oftime series. It is not possible to reduce across different resource types,so this field implicitly contains resource.type. Fields not specified ingroup_by_fields are aggregated away. If group_by_fields is not specified andall the time series have the same resource type, then the time series areaggregated into a single output time series. If cross_series_reducer is notdefined, this field is ignored.

func (*OrganizationsTimeSeriesListCall)SecondaryAggregationPerSeriesAligneradded inv0.37.0

func (c *OrganizationsTimeSeriesListCall) SecondaryAggregationPerSeriesAligner(secondaryAggregationPerSeriesAlignerstring) *OrganizationsTimeSeriesListCall

SecondaryAggregationPerSeriesAligner sets the optional parameter"secondaryAggregation.perSeriesAligner": An Aligner describes how to bringthe data points in a single time series into temporal alignment. Except forALIGN_NONE, all alignments cause all the data points in an alignment_periodto be mathematically grouped together, resulting in a single data point foreach alignment_period with end timestamp at the end of the period.Not allalignment operations may be applied to all time series. The valid choicesdepend on the metric_kind and value_type of the original time series.Alignment can change the metric_kind or the value_type of the timeseries.Time series data must be aligned in order to perform cross-timeseries reduction. If cross_series_reducer is specified, thenper_series_aligner must be specified and not equal to ALIGN_NONE andalignment_period must be specified; otherwise, an error is returned.

Possible values:

"ALIGN_NONE" - No alignment. Raw data is returned. Not valid if

cross-series reduction is requested. The value_type of the result is thesame as the value_type of the input.

"ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -

y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selectedalignment period results in periods with no data, then the aligned value forsuch a period is created by interpolation. The value_type of the alignedresult is the same as the value_type of the input.

"ALIGN_RATE" - Align and convert to a rate. The result is computed as rate

= (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner asproviding the slope of the line that passes through the value at the startand at the end of the alignment_period.This aligner is valid for CUMULATIVEand DELTA metrics with numeric values. If the selected alignment periodresults in periods with no data, then the aligned value for such a period iscreated by interpolation. The output is a GAUGE metric with value_typeDOUBLE.If, by "rate", you mean "percentage change", see theALIGN_PERCENT_CHANGE aligner instead.

"ALIGN_INTERPOLATE" - Align by interpolating between adjacent points

around the alignment period boundary. This aligner is valid for GAUGEmetrics with numeric values. The value_type of the aligned result is thesame as the value_type of the input.

"ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the

end of the alignment period to the boundary at the end of the alignmentperiod. This aligner is valid for GAUGE metrics. The value_type of thealigned result is the same as the value_type of the input.

"ALIGN_MIN" - Align the time series by returning the minimum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MAX" - Align the time series by returning the maximum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MEAN" - Align the time series by returning the mean value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is DOUBLE.

"ALIGN_COUNT" - Align the time series by returning the number of values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric or Boolean values. The value_type of the aligned result isINT64.

"ALIGN_SUM" - Align the time series by returning the sum of the values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric and distribution values. The value_type of the aligned resultis the same as the value_type of the input.

"ALIGN_STDDEV" - Align the time series by returning the standard deviation

of the values in each alignment period. This aligner is valid for GAUGE andDELTA metrics with numeric values. The value_type of the output is DOUBLE.

"ALIGN_COUNT_TRUE" - Align the time series by returning the number of True

values in each alignment period. This aligner is valid for GAUGE metricswith Boolean values. The value_type of the output is INT64.

"ALIGN_COUNT_FALSE" - Align the time series by returning the number of

False values in each alignment period. This aligner is valid for GAUGEmetrics with Boolean values. The value_type of the output is INT64.

"ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of

the number of True values to the total number of values in each alignmentperiod. This aligner is valid for GAUGE metrics with Boolean values. Theoutput value is in the range 0.0, 1.0 and has value_type DOUBLE.

"ALIGN_PERCENTILE_99" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 99th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_95" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 95th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_50" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 50th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_05" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 5th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This

aligner is valid for GAUGE and DELTA metrics with numeric values. Thisalignment returns ((current - previous)/previous) * 100, where the value ofprevious is determined based on the alignment_period.If the values ofcurrent and previous are both 0, then the returned value is 0. If onlyprevious is 0, the returned value is infinity.A 10-minute moving mean iscomputed at each point of the alignment period prior to the abovecalculation to smooth the metric and prevent false positives from veryshort-lived spikes. The moving mean is only applicable for data whose valuesare >= 0. Any values < 0 are treated as a missing datapoint, and areignored. While DELTA metrics are accepted by this alignment, special careshould be taken that the values for the metric will always be positive. Theoutput is a GAUGE metric with value_type DOUBLE.

func (*OrganizationsTimeSeriesListCall)Viewadded inv0.37.0

View sets the optional parameter "view": Required. Specifies whichinformation is returned about the time series.

Possible values:

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

typeOrganizationsTimeSeriesServiceadded inv0.37.0

type OrganizationsTimeSeriesService struct {// contains filtered or unexported fields}

funcNewOrganizationsTimeSeriesServiceadded inv0.37.0

func NewOrganizationsTimeSeriesService(s *Service) *OrganizationsTimeSeriesService

func (*OrganizationsTimeSeriesService)Listadded inv0.37.0

List: Lists time series that match a filter.

typePerformanceThresholdadded inv0.14.0

type PerformanceThreshold struct {// BasicSliPerformance: BasicSli to evaluate to judge window quality.BasicSliPerformance *BasicSli `json:"basicSliPerformance,omitempty"`// Performance: RequestBasedSli to evaluate to judge window quality.Performance *RequestBasedSli `json:"performance,omitempty"`// Threshold: If window performance >= threshold, the window is counted as// good.Thresholdfloat64 `json:"threshold,omitempty"`// ForceSendFields is a list of field names (e.g. "BasicSliPerformance") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BasicSliPerformance") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PerformanceThreshold: A PerformanceThreshold is used when each window isgood when that window has a sufficiently high performance.

func (PerformanceThreshold)MarshalJSONadded inv0.14.0

func (sPerformanceThreshold) MarshalJSON() ([]byte,error)

func (*PerformanceThreshold)UnmarshalJSONadded inv0.14.0

func (s *PerformanceThreshold) UnmarshalJSON(data []byte)error

typePingConfigadded inv0.96.0

type PingConfig struct {// PingsCount: Number of ICMP pings. A maximum of 3 ICMP pings is currently// supported.PingsCountint64 `json:"pingsCount,omitempty"`// ForceSendFields is a list of field names (e.g. "PingsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PingsCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PingConfig: Information involved in sending ICMP pings alongside publicHTTP/TCP checks. For HTTP, the pings are performed for each part of theredirect chain.

func (PingConfig)MarshalJSONadded inv0.96.0

func (sPingConfig) MarshalJSON() ([]byte,error)

typePoint

type Point struct {// 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.Interval *TimeInterval `json:"interval,omitempty"`// Value: The value of the data point.Value *TypedValue `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Interval") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Interval") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Point: A single data point in a time series.

func (Point)MarshalJSON

func (sPoint) MarshalJSON() ([]byte,error)

typePointDataadded inv0.22.0

type PointData struct {// TimeInterval: The time interval associated with the point.TimeInterval *TimeInterval `json:"timeInterval,omitempty"`// Values: The values that make up the point.Values []*TypedValue `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "TimeInterval") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TimeInterval") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (PointData)MarshalJSONadded inv0.22.0

func (sPointData) MarshalJSON() ([]byte,error)

typePolicySnapshotadded inv0.253.0

type PolicySnapshot struct {// DisplayName: The display name of the alert policy.DisplayNamestring `json:"displayName,omitempty"`// Name: The name of the alert policy resource. In the form of// "projects/PROJECT_ID_OR_NUMBER/alertPolicies/ALERT_POLICY_ID".Namestring `json:"name,omitempty"`// Severity: The severity of the alert policy.//// Possible values://   "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.Severitystring `json:"severity,omitempty"`// UserLabels: The user labels for the alert policy.UserLabels map[string]string `json:"userLabels,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PolicySnapshot: The state of the policy at the time the alert was generated.

func (PolicySnapshot)MarshalJSONadded inv0.253.0

func (sPolicySnapshot) MarshalJSON() ([]byte,error)

typeProjectsAlertPoliciesCreateCall

type ProjectsAlertPoliciesCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsAlertPoliciesCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAlertPoliciesCreateCall)Do

Do executes the "monitoring.projects.alertPolicies.create" call.Any non-2xx status code is an error. Response headers are in either*AlertPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAlertPoliciesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsAlertPoliciesCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsAlertPoliciesDeleteCall

type ProjectsAlertPoliciesDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsAlertPoliciesDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAlertPoliciesDeleteCall)Do

Do executes the "monitoring.projects.alertPolicies.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAlertPoliciesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsAlertPoliciesDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsAlertPoliciesGetCall

type ProjectsAlertPoliciesGetCall struct {// contains filtered or unexported fields}

func (*ProjectsAlertPoliciesGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAlertPoliciesGetCall)Do

Do executes the "monitoring.projects.alertPolicies.get" call.Any non-2xx status code is an error. Response headers are in either*AlertPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAlertPoliciesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsAlertPoliciesGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsAlertPoliciesGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsAlertPoliciesListCall

type ProjectsAlertPoliciesListCall struct {// contains filtered or unexported fields}

func (*ProjectsAlertPoliciesListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAlertPoliciesListCall)Do

Do executes the "monitoring.projects.alertPolicies.list" call.Any non-2xx status code is an error. Response headers are in either*ListAlertPoliciesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsAlertPoliciesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsAlertPoliciesListCall)Filter

Filter sets the optional parameter "filter": If provided, this fieldspecifies the criteria that must be met by alert policies to be included inthe response.For more details, see sorting and filtering(https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).

func (*ProjectsAlertPoliciesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsAlertPoliciesListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsAlertPoliciesListCall)OrderBy

OrderBy sets the optional parameter "orderBy": A comma-separated list offields by which to sort the result. Supports the same set of fieldreferences as the filter field. Entries can be prefixed with a minus sign tosort by the field in descending order.For more details, see sorting andfiltering(https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).

func (*ProjectsAlertPoliciesListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return in a single response.

func (*ProjectsAlertPoliciesListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return moreresults from the previous method call.

func (*ProjectsAlertPoliciesListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsAlertPoliciesPatchCall

type ProjectsAlertPoliciesPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsAlertPoliciesPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAlertPoliciesPatchCall)Do

Do executes the "monitoring.projects.alertPolicies.patch" call.Any non-2xx status code is an error. Response headers are in either*AlertPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAlertPoliciesPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsAlertPoliciesPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsAlertPoliciesPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": A list of alertingpolicy field names. If this field is not empty, each listed field in theexisting alerting policy is set to the value of the corresponding field inthe supplied policy (alert_policy), or to the field's default value if thefield is not in the supplied alerting policy. Fields not listed retain theirprevious 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 isempty, then the supplied alerting policy replaces the existing policy. It isthe 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 theformer policy in your notifications and incidents. Conditions in the newpolicy will keep their former [CONDITION_ID] if the supplied conditionincludes the name field with that [CONDITION_ID]. If the supplied conditionomits the name field, then a new [CONDITION_ID] is created.

typeProjectsAlertPoliciesService

type ProjectsAlertPoliciesService struct {// contains filtered or unexported fields}

funcNewProjectsAlertPoliciesService

func NewProjectsAlertPoliciesService(s *Service) *ProjectsAlertPoliciesService

func (*ProjectsAlertPoliciesService)Create

Create: Creates a new alerting policy.Design your application tosingle-thread API calls that modify the state of alerting policies in asingle project. This includes calls to CreateAlertPolicy, DeleteAlertPolicyand UpdateAlertPolicy.

  • name: The project(https://cloud.google.com/monitoring/api/v3#project_name) in which tocreate the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER]Note that this field names the parent container in which the alertingpolicy will be written, not the name of the created policy. |name| must bea host project of a Metrics Scope, otherwise INVALID_ARGUMENT error willreturn. The alerting policy that is returned will have a name thatcontains a normalized representation of this name as a prefix but adds asuffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying thepolicy in the container.

func (*ProjectsAlertPoliciesService)Delete

Delete: Deletes an alerting policy.Design your application to single-threadAPI calls that modify the state of alerting policies in a single project.This includes calls to CreateAlertPolicy, DeleteAlertPolicy andUpdateAlertPolicy.

  • name: The alerting policy to delete. The format is:projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For moreinformation, see AlertPolicy.

func (*ProjectsAlertPoliciesService)Get

Get: Gets a single alerting policy.

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

func (*ProjectsAlertPoliciesService)List

List: Lists the existing alerting policies for the workspace.

  • name: The project(https://cloud.google.com/monitoring/api/v3#project_name) whose alertpolicies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]Note that this field names the parent container in which the alertingpolicies to be listed are stored. To retrieve a single alerting policy byname, use the GetAlertPolicy operation, instead.

func (*ProjectsAlertPoliciesService)Patch

Patch: Updates an alerting policy. You can either replace the entire policywith a new one or replace only certain fields in the current alerting policyby specifying the fields to be updated via updateMask. Returns the updatedalerting policy.Design your application to single-thread API calls thatmodify the state of alerting policies in a single project. This includescalls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

  • name: Identifier. Required if the policy exists. The resource name forthis policy. The format is:projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID][ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy iscreated. When calling the alertPolicies.create method, do not include thename field in the alerting policy passed as part of the request.

typeProjectsAlertsGetCalladded inv0.253.0

type ProjectsAlertsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsAlertsGetCall)Contextadded inv0.253.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAlertsGetCall)Doadded inv0.253.0

Do executes the "monitoring.projects.alerts.get" call.Any non-2xx status code is an error. Response headers are in either*Alert.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAlertsGetCall)Fieldsadded inv0.253.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsAlertsGetCall)Headeradded inv0.253.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsAlertsGetCall)IfNoneMatchadded inv0.253.0

func (c *ProjectsAlertsGetCall) IfNoneMatch(entityTagstring) *ProjectsAlertsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsAlertsListCalladded inv0.253.0

type ProjectsAlertsListCall struct {// contains filtered or unexported fields}

func (*ProjectsAlertsListCall)Contextadded inv0.253.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAlertsListCall)Doadded inv0.253.0

Do executes the "monitoring.projects.alerts.list" call.Any non-2xx status code is an error. Response headers are in either*ListAlertsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsAlertsListCall)Fieldsadded inv0.253.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsAlertsListCall)Filteradded inv0.253.0

Filter sets the optional parameter "filter": An alert is returned if thereis a match on any fields belonging to the alert or its subfields.

func (*ProjectsAlertsListCall)Headeradded inv0.253.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsAlertsListCall)IfNoneMatchadded inv0.253.0

func (c *ProjectsAlertsListCall) IfNoneMatch(entityTagstring) *ProjectsAlertsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsAlertsListCall)OrderByadded inv0.253.0

OrderBy sets the optional parameter "orderBy": A comma-separated list offields in Alert to use for sorting. The default sort direction is ascending.To specify descending order for a field, add a desc modifier. The followingfields are supported: open_time close_timeFor example, close_time desc,open_time will return the alerts closed most recently, with ties broken inthe order of older alerts listed first.If the field is not set, the resultsare sorted by open_time desc.

func (*ProjectsAlertsListCall)PageSizeadded inv0.253.0

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return in a single response. If not set to a positive number, atmost 50 alerts will be returned. The maximum value is 1000; values above1000 will be coerced to 1000.

func (*ProjectsAlertsListCall)PageTokenadded inv0.253.0

PageToken sets the optional parameter "pageToken": If non-empty, page_tokenmust contain a value returned as the next_page_token in a previous responseto request the next set of results.

func (*ProjectsAlertsListCall)Pagesadded inv0.253.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsAlertsServiceadded inv0.253.0

type ProjectsAlertsService struct {// contains filtered or unexported fields}

funcNewProjectsAlertsServiceadded inv0.253.0

func NewProjectsAlertsService(s *Service) *ProjectsAlertsService

func (*ProjectsAlertsService)Getadded inv0.253.0

Get: Gets a single alert.

  • name: The name of the alert.The format is:projects/[PROJECT_ID_OR_NUMBER]/alerts/[ALERT_ID] The [ALERT_ID] is asystem-assigned unique identifier for the alert.

func (*ProjectsAlertsService)Listadded inv0.253.0

List: Lists the existing alerts for the metrics scope of the project.

- parent: The name of the project to list alerts for.

typeProjectsCollectdTimeSeriesCreateCall

type ProjectsCollectdTimeSeriesCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsCollectdTimeSeriesCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsCollectdTimeSeriesCreateCall)Do

Do executes the "monitoring.projects.collectdTimeSeries.create" call.Any non-2xx status code is an error. Response headers are in either*CreateCollectdTimeSeriesResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsCollectdTimeSeriesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsCollectdTimeSeriesCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsCollectdTimeSeriesService

type ProjectsCollectdTimeSeriesService struct {// contains filtered or unexported fields}

funcNewProjectsCollectdTimeSeriesService

func NewProjectsCollectdTimeSeriesService(s *Service) *ProjectsCollectdTimeSeriesService

func (*ProjectsCollectdTimeSeriesService)Create

Create: Cloud Monitoring Agent only: Creates a new time series.This methodis only for use by the Cloud Monitoring Agent. Useprojects.timeSeries.create instead.

typeProjectsGroupsCreateCall

type ProjectsGroupsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsGroupsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsGroupsCreateCall)Do

Do executes the "monitoring.projects.groups.create" call.Any non-2xx status code is an error. Response headers are in either*Group.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGroupsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGroupsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGroupsCreateCall)ValidateOnly

func (c *ProjectsGroupsCreateCall) ValidateOnly(validateOnlybool) *ProjectsGroupsCreateCall

ValidateOnly sets the optional parameter "validateOnly": If true, validatethis request but do not create the group.

typeProjectsGroupsDeleteCall

type ProjectsGroupsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsGroupsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsGroupsDeleteCall)Do

Do executes the "monitoring.projects.groups.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGroupsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGroupsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGroupsDeleteCall)Recursiveadded inv0.2.0

Recursive sets the optional parameter "recursive": 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 nodescendants. The default value is false.

typeProjectsGroupsGetCall

type ProjectsGroupsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsGroupsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsGroupsGetCall)Do

Do executes the "monitoring.projects.groups.get" call.Any non-2xx status code is an error. Response headers are in either*Group.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGroupsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGroupsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGroupsGetCall)IfNoneMatch

func (c *ProjectsGroupsGetCall) IfNoneMatch(entityTagstring) *ProjectsGroupsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsGroupsListCall

type ProjectsGroupsListCall struct {// contains filtered or unexported fields}

func (*ProjectsGroupsListCall)AncestorsOfGroup

func (c *ProjectsGroupsListCall) AncestorsOfGroup(ancestorsOfGroupstring) *ProjectsGroupsListCall

AncestorsOfGroup sets the optional parameter "ancestorsOfGroup": A groupname. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]Returns groups that are ancestors of the specified group. The groups arereturned in order, starting with the immediate parent and ending with themost distant ancestor. If the specified group has no immediate parent, theresults are empty.

func (*ProjectsGroupsListCall)ChildrenOfGroup

func (c *ProjectsGroupsListCall) ChildrenOfGroup(childrenOfGroupstring) *ProjectsGroupsListCall

ChildrenOfGroup sets the optional parameter "childrenOfGroup": A group name.The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returnsgroups whose parent_name field contains the group name. If no groups havethis parent, the results are empty.

func (*ProjectsGroupsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsGroupsListCall)DescendantsOfGroup

func (c *ProjectsGroupsListCall) DescendantsOfGroup(descendantsOfGroupstring) *ProjectsGroupsListCall

DescendantsOfGroup sets the optional parameter "descendantsOfGroup": A groupname. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]Returns the descendants of the specified group. This is a superset of theresults returned by the children_of_group filter, and includeschildren-of-children, and so forth.

func (*ProjectsGroupsListCall)Do

Do executes the "monitoring.projects.groups.list" call.Any non-2xx status code is an error. Response headers are in either*ListGroupsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsGroupsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGroupsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGroupsListCall)IfNoneMatch

func (c *ProjectsGroupsListCall) IfNoneMatch(entityTagstring) *ProjectsGroupsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsGroupsListCall)PageSize

PageSize sets the optional parameter "pageSize": A positive number that isthe maximum number of results to return.

func (*ProjectsGroupsListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the next_page_token value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*ProjectsGroupsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsGroupsMembersListCall

type ProjectsGroupsMembersListCall struct {// contains filtered or unexported fields}

func (*ProjectsGroupsMembersListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsGroupsMembersListCall)Do

Do executes the "monitoring.projects.groups.members.list" call.Any non-2xx status code is an error. Response headers are in either*ListGroupMembersResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsGroupsMembersListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGroupsMembersListCall)Filter

Filter sets the optional parameter "filter": An optional list filter(https://cloud.google.com/monitoring/api/learn_more#filtering) describingthe members to be returned. The filter may reference the type, labels, andmetadata of monitored resources that comprise the group. For example, toreturn only resources representing Compute Engine VM instances, use thisfilter: `resource.type = "gce_instance"

func (*ProjectsGroupsMembersListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGroupsMembersListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsGroupsMembersListCall)IntervalEndTime

func (c *ProjectsGroupsMembersListCall) IntervalEndTime(intervalEndTimestring) *ProjectsGroupsMembersListCall

IntervalEndTime sets the optional parameter "interval.endTime": Required.The end of the time interval.

func (*ProjectsGroupsMembersListCall)IntervalStartTime

func (c *ProjectsGroupsMembersListCall) IntervalStartTime(intervalStartTimestring) *ProjectsGroupsMembersListCall

IntervalStartTime sets the optional parameter "interval.startTime": Thebeginning of the time interval. The default value for the start time is theend time. The start time must not be later than the end time.

func (*ProjectsGroupsMembersListCall)PageSize

PageSize sets the optional parameter "pageSize": A positive number that isthe maximum number of results to return.

func (*ProjectsGroupsMembersListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the next_page_token value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*ProjectsGroupsMembersListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsGroupsMembersService

type ProjectsGroupsMembersService struct {// contains filtered or unexported fields}

funcNewProjectsGroupsMembersService

func NewProjectsGroupsMembersService(s *Service) *ProjectsGroupsMembersService

func (*ProjectsGroupsMembersService)List

List: Lists the monitored resources that are members of a group.

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

typeProjectsGroupsService

type ProjectsGroupsService struct {Members *ProjectsGroupsMembersService// contains filtered or unexported fields}

funcNewProjectsGroupsService

func NewProjectsGroupsService(s *Service) *ProjectsGroupsService

func (*ProjectsGroupsService)Create

Create: Creates a new group.

func (*ProjectsGroupsService)Delete

Delete: Deletes an existing group.

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

func (*ProjectsGroupsService)Get

Get: Gets a single group.

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

func (*ProjectsGroupsService)List

List: Lists the existing groups.

func (*ProjectsGroupsService)Update

Update: Updates an existing group. You can change any group attributesexcept name.

  • 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 projectspecified in the call to CreateGroup and a unique [GROUP_ID] that isgenerated automatically.

typeProjectsGroupsUpdateCall

type ProjectsGroupsUpdateCall struct {// contains filtered or unexported fields}

func (*ProjectsGroupsUpdateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsGroupsUpdateCall)Do

Do executes the "monitoring.projects.groups.update" call.Any non-2xx status code is an error. Response headers are in either*Group.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGroupsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGroupsUpdateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGroupsUpdateCall)ValidateOnly

func (c *ProjectsGroupsUpdateCall) ValidateOnly(validateOnlybool) *ProjectsGroupsUpdateCall

ValidateOnly sets the optional parameter "validateOnly": If true, validatethis request but do not update the existing group.

typeProjectsMetricDescriptorsCreateCall

type ProjectsMetricDescriptorsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsMetricDescriptorsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsMetricDescriptorsCreateCall)Do

Do executes the "monitoring.projects.metricDescriptors.create" call.Any non-2xx status code is an error. Response headers are in either*MetricDescriptor.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsMetricDescriptorsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsMetricDescriptorsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsMetricDescriptorsDeleteCall

type ProjectsMetricDescriptorsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsMetricDescriptorsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsMetricDescriptorsDeleteCall)Do

Do executes the "monitoring.projects.metricDescriptors.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsMetricDescriptorsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsMetricDescriptorsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsMetricDescriptorsGetCall

type ProjectsMetricDescriptorsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsMetricDescriptorsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsMetricDescriptorsGetCall)Do

Do executes the "monitoring.projects.metricDescriptors.get" call.Any non-2xx status code is an error. Response headers are in either*MetricDescriptor.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsMetricDescriptorsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsMetricDescriptorsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsMetricDescriptorsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsMetricDescriptorsListCall

type ProjectsMetricDescriptorsListCall struct {// contains filtered or unexported fields}

func (*ProjectsMetricDescriptorsListCall)ActiveOnlyadded inv0.218.0

ActiveOnly sets the optional parameter "activeOnly": If true, only metricsand monitored resource types that have recent data (within roughly 25 hours)will be included in the response. - If a metric descriptor enumeratesmonitored resource types, only the monitored resource types for which themetric type has recent data will be included in the returned metricdescriptor, and if none of them have recent data, the metric descriptor willnot be returned. - If a metric descriptor does not enumerate the compatiblemonitored resource types, it will be returned only if the metric type hasrecent data for some monitored resource type. The returned descriptor willnot enumerate any monitored resource types.

func (*ProjectsMetricDescriptorsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsMetricDescriptorsListCall)Do

Do executes the "monitoring.projects.metricDescriptors.list" call.Any non-2xx status code is an error. Response headers are in either*ListMetricDescriptorsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsMetricDescriptorsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsMetricDescriptorsListCall)Filter

Filter sets the optional parameter "filter": If this field is empty, allcustom and system-defined metric descriptors are returned. Otherwise, thefilter (https://cloud.google.com/monitoring/api/v3/filters) specifies whichmetric descriptors are to be returned. For example, the following filtermatches all custom metrics(https://cloud.google.com/monitoring/custom-metrics): metric.type =starts_with("custom.googleapis.com/")

func (*ProjectsMetricDescriptorsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsMetricDescriptorsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsMetricDescriptorsListCall)PageSize

PageSize sets the optional parameter "pageSize": A positive number that isthe maximum number of results to return. The default and maximum value is10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return amaximum of 10,000 results.

func (*ProjectsMetricDescriptorsListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*ProjectsMetricDescriptorsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsMetricDescriptorsService

type ProjectsMetricDescriptorsService struct {// contains filtered or unexported fields}

funcNewProjectsMetricDescriptorsService

func NewProjectsMetricDescriptorsService(s *Service) *ProjectsMetricDescriptorsService

func (*ProjectsMetricDescriptorsService)Create

Create: Creates a new metric descriptor. The creation is executedasynchronously. User-created metric descriptors define custom metrics(https://cloud.google.com/monitoring/custom-metrics). The metric descriptoris updated if it already exists, except that metric labels are neverremoved.

func (*ProjectsMetricDescriptorsService)Delete

Delete: Deletes a metric descriptor. Only user-created custom metrics(https://cloud.google.com/monitoring/custom-metrics) can be deleted.

  • name: The metric descriptor on which to execute the request. The formatis: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] Anexample of [METRIC_ID] is: "custom.googleapis.com/my_test_metric".

func (*ProjectsMetricDescriptorsService)Get

Get: Gets a single metric descriptor.

  • name: The metric descriptor on which to execute the request. The formatis: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] Anexample value of [METRIC_ID] is"compute.googleapis.com/instance/disk/read_bytes_count".

func (*ProjectsMetricDescriptorsService)List

List: Lists metric descriptors that match a filter.

typeProjectsMonitoredResourceDescriptorsGetCall

type ProjectsMonitoredResourceDescriptorsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsMonitoredResourceDescriptorsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsMonitoredResourceDescriptorsGetCall)Do

Do executes the "monitoring.projects.monitoredResourceDescriptors.get" call.Any non-2xx status code is an error. Response headers are in either*MonitoredResourceDescriptor.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsMonitoredResourceDescriptorsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsMonitoredResourceDescriptorsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsMonitoredResourceDescriptorsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsMonitoredResourceDescriptorsListCall

type ProjectsMonitoredResourceDescriptorsListCall struct {// contains filtered or unexported fields}

func (*ProjectsMonitoredResourceDescriptorsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsMonitoredResourceDescriptorsListCall)Do

Do executes the "monitoring.projects.monitoredResourceDescriptors.list" call.Any non-2xx status code is an error. Response headers are in either*ListMonitoredResourceDescriptorsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsMonitoredResourceDescriptorsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsMonitoredResourceDescriptorsListCall)Filter

Filter sets the optional parameter "filter": An optional filter(https://cloud.google.com/monitoring/api/v3/filters) describing thedescriptors to be returned. The filter can reference the descriptor's typeand labels. For example, the following filter returns only Google ComputeEngine descriptors that have an id label: resource.type =starts_with("gce_") AND resource.label:id

func (*ProjectsMonitoredResourceDescriptorsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsMonitoredResourceDescriptorsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsMonitoredResourceDescriptorsListCall)PageSize

PageSize sets the optional parameter "pageSize": A positive number that isthe maximum number of results to return.

func (*ProjectsMonitoredResourceDescriptorsListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*ProjectsMonitoredResourceDescriptorsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsMonitoredResourceDescriptorsService

type ProjectsMonitoredResourceDescriptorsService struct {// contains filtered or unexported fields}

func (*ProjectsMonitoredResourceDescriptorsService)Get

Get: Gets a single monitored resource descriptor.

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

func (*ProjectsMonitoredResourceDescriptorsService)List

List: Lists monitored resource descriptors that match a filter.

typeProjectsNotificationChannelDescriptorsGetCall

type ProjectsNotificationChannelDescriptorsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelDescriptorsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelDescriptorsGetCall)Do

Do executes the "monitoring.projects.notificationChannelDescriptors.get" call.Any non-2xx status code is an error. Response headers are in either*NotificationChannelDescriptor.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsNotificationChannelDescriptorsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelDescriptorsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsNotificationChannelDescriptorsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsNotificationChannelDescriptorsListCall

type ProjectsNotificationChannelDescriptorsListCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelDescriptorsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelDescriptorsListCall)Do

Do executes the "monitoring.projects.notificationChannelDescriptors.list" call.Any non-2xx status code is an error. Response headers are in either*ListNotificationChannelDescriptorsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsNotificationChannelDescriptorsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelDescriptorsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsNotificationChannelDescriptorsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsNotificationChannelDescriptorsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return in a single response. If not set to a positive number, areasonable value will be chosen by the service.

func (*ProjectsNotificationChannelDescriptorsListCall)PageToken

PageToken sets the optional parameter "pageToken": If non-empty, page_tokenmust contain a value returned as the next_page_token in a previous responseto request the next set of results.

func (*ProjectsNotificationChannelDescriptorsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsNotificationChannelDescriptorsService

type ProjectsNotificationChannelDescriptorsService struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelDescriptorsService)Get

Get: Gets a single channel descriptor. The descriptor indicates which fieldsare expected / permitted for a notification channel of the given type.

  • name: The channel type for which to execute the request. The format is:projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE].

func (*ProjectsNotificationChannelDescriptorsService)List

List: Lists the descriptors for supported channel types. The use ofdescriptors makes it possible for new channel types to be dynamically added.

  • name: The REST resource name of the parent from which to retrieve thenotification channel descriptors. The expected syntax is:projects/[PROJECT_ID_OR_NUMBER] Note that this names(https://cloud.google.com/monitoring/api/v3#project_name) the parentcontainer in which to look for the descriptors; to retrieve a singledescriptor by name, use the GetNotificationChannelDescriptor operation,instead.

typeProjectsNotificationChannelsCreateCall

type ProjectsNotificationChannelsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsCreateCall)Do

Do executes the "monitoring.projects.notificationChannels.create" call.Any non-2xx status code is an error. Response headers are in either*NotificationChannel.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsNotificationChannelsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsNotificationChannelsDeleteCall

type ProjectsNotificationChannelsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsDeleteCall)Do

Do executes the "monitoring.projects.notificationChannels.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsNotificationChannelsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsDeleteCall)Force

Force sets the optional parameter "force": If true, the notification channelwill be deleted regardless of its use in alert policies (the policies willbe updated to remove the channel). If false, this operation will fail if thenotification channel is referenced by existing alerting policies.

func (*ProjectsNotificationChannelsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsNotificationChannelsGetCall

type ProjectsNotificationChannelsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsGetCall)Do

Do executes the "monitoring.projects.notificationChannels.get" call.Any non-2xx status code is an error. Response headers are in either*NotificationChannel.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsNotificationChannelsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsNotificationChannelsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsNotificationChannelsGetVerificationCodeCall

type ProjectsNotificationChannelsGetVerificationCodeCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsGetVerificationCodeCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsGetVerificationCodeCall)Do

Do executes the "monitoring.projects.notificationChannels.getVerificationCode" call.Any non-2xx status code is an error. Response headers are in either*GetNotificationChannelVerificationCodeResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsNotificationChannelsGetVerificationCodeCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsGetVerificationCodeCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsNotificationChannelsListCall

type ProjectsNotificationChannelsListCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsListCall)Do

Do executes the "monitoring.projects.notificationChannels.list" call.Any non-2xx status code is an error. Response headers are in either*ListNotificationChannelsResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsNotificationChannelsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsListCall)Filter

Filter sets the optional parameter "filter": If provided, this fieldspecifies the criteria that must be met by notification channels to beincluded in the response.For more details, see sorting and filtering(https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).

func (*ProjectsNotificationChannelsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsNotificationChannelsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsNotificationChannelsListCall)OrderBy

OrderBy sets the optional parameter "orderBy": A comma-separated list offields by which to sort the result. Supports the same set of fields as infilter. Entries can be prefixed with a minus sign to sort in descendingrather than ascending order.For more details, see sorting and filtering(https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).

func (*ProjectsNotificationChannelsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return in a single response. If not set to a positive number, areasonable value will be chosen by the service.

func (*ProjectsNotificationChannelsListCall)PageToken

PageToken sets the optional parameter "pageToken": If non-empty, page_tokenmust contain a value returned as the next_page_token in a previous responseto request the next set of results.

func (*ProjectsNotificationChannelsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsNotificationChannelsPatchCall

type ProjectsNotificationChannelsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsPatchCall)Do

Do executes the "monitoring.projects.notificationChannels.patch" call.Any non-2xx status code is an error. Response headers are in either*NotificationChannel.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsNotificationChannelsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsNotificationChannelsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": The fields to update.

typeProjectsNotificationChannelsSendVerificationCodeCall

type ProjectsNotificationChannelsSendVerificationCodeCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsSendVerificationCodeCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsSendVerificationCodeCall)Do

Do executes the "monitoring.projects.notificationChannels.sendVerificationCode" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsNotificationChannelsSendVerificationCodeCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsSendVerificationCodeCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsNotificationChannelsService

type ProjectsNotificationChannelsService struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsService)Create

Create: Creates a new notification channel, representing a singlenotification endpoint such as an email address, SMS number, or PagerDutyservice.Design your application to single-thread API calls that modify thestate of notification channels in a single project. This includes calls toCreateNotificationChannel, DeleteNotificationChannel andUpdateNotificationChannel.

  • name: The project(https://cloud.google.com/monitoring/api/v3#project_name) on which toexecute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] Thisnames the container into which the channel will be written, this does notname the newly created channel. The resulting channel's name will have anormalized version of this field as a prefix, but will add/notificationChannels/[CHANNEL_ID] to identify the channel.

func (*ProjectsNotificationChannelsService)Delete

Delete: Deletes a notification channel.Design your application tosingle-thread API calls that modify the state of notification channels in asingle project. This includes calls to CreateNotificationChannel,DeleteNotificationChannel and UpdateNotificationChannel.

  • name: The channel for which to execute the request. The format is:projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID].

func (*ProjectsNotificationChannelsService)Get

Get: Gets a single notification channel. The channel includes the relevantconfiguration details with which the channel was created. However, theresponse may truncate or omit passwords, API keys, or other private keymatter and thus the response may not be 100% identical to the informationthat was supplied in the call to the create method.

  • name: The channel for which to execute the request. The format is:projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID].

func (*ProjectsNotificationChannelsService)GetVerificationCode

GetVerificationCode: Requests a verification code for an already verifiedchannel that can then be used in a call to VerifyNotificationChannel() on adifferent channel with an equivalent identity in the same or in a differentproject. This makes it possible to copy a channel between projects withoutrequiring manual reverification of the channel. If the channel is not in theverified state, this method will fail (in other words, this may only be usedif the SendNotificationChannelVerificationCode and VerifyNotificationChannelpaths have already been used to put the given channel into the verifiedstate).There is no guarantee that the verification codes returned by thismethod will be of a similar structure or form as the ones that are deliveredto the channel via SendNotificationChannelVerificationCode; whileVerifyNotificationChannel() will recognize both the codes delivered viaSendNotificationChannelVerificationCode() and returned fromGetNotificationChannelVerificationCode(), it is typically the case that theverification codes delivered via SendNotificationChannelVerificationCode()will be shorter and also have a shorter expiration (e.g. codes such as"G-123456") whereas GetVerificationCode() will typically return a muchlonger, websafe base 64 encoded string that has a longer expiration time.

  • name: The notification channel for which a verification code is to begenerated and retrieved. This must name a channel that is alreadyverified; if the specified channel is not verified, the request will fail.

func (*ProjectsNotificationChannelsService)List

List: Lists the notification channels that have been created for theproject. To list the types of notification channels that are supported, usethe ListNotificationChannelDescriptors method.

  • name: The project(https://cloud.google.com/monitoring/api/v3#project_name) on which toexecute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] Thisnames the container in which to look for the notification channels; itdoes not name a specific channel. To query a specific channel by RESTresource name, use the GetNotificationChannel operation.

func (*ProjectsNotificationChannelsService)Patch

Patch: Updates a notification channel. Fields not specified in the fieldmask remain unchanged.Design your application to single-thread API callsthat modify the state of notification channels in a single project. Thisincludes calls to CreateNotificationChannel, DeleteNotificationChannel andUpdateNotificationChannel.

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

func (*ProjectsNotificationChannelsService)SendVerificationCode

SendVerificationCode: Causes a verification code to be delivered to thechannel. The code can then be supplied in VerifyNotificationChannel toverify the channel.

- name: The notification channel to which to send a verification code.

func (*ProjectsNotificationChannelsService)Verify

Verify: Verifies a NotificationChannel by proving receipt of the codedelivered to the channel as a result of callingSendNotificationChannelVerificationCode.

- name: The notification channel to verify.

typeProjectsNotificationChannelsVerifyCall

type ProjectsNotificationChannelsVerifyCall struct {// contains filtered or unexported fields}

func (*ProjectsNotificationChannelsVerifyCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsNotificationChannelsVerifyCall)Do

Do executes the "monitoring.projects.notificationChannels.verify" call.Any non-2xx status code is an error. Response headers are in either*NotificationChannel.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsNotificationChannelsVerifyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsNotificationChannelsVerifyCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsService

type ProjectsService struct {AlertPolicies *ProjectsAlertPoliciesServiceAlerts *ProjectsAlertsServiceCollectdTimeSeries *ProjectsCollectdTimeSeriesServiceGroups *ProjectsGroupsServiceMetricDescriptors *ProjectsMetricDescriptorsServiceMonitoredResourceDescriptors *ProjectsMonitoredResourceDescriptorsServiceNotificationChannelDescriptors *ProjectsNotificationChannelDescriptorsServiceNotificationChannels *ProjectsNotificationChannelsServiceSnoozes *ProjectsSnoozesServiceTimeSeries *ProjectsTimeSeriesServiceUptimeCheckConfigs *ProjectsUptimeCheckConfigsService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeProjectsSnoozesCreateCalladded inv0.105.0

type ProjectsSnoozesCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsSnoozesCreateCall)Contextadded inv0.105.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSnoozesCreateCall)Doadded inv0.105.0

Do executes the "monitoring.projects.snoozes.create" call.Any non-2xx status code is an error. Response headers are in either*Snooze.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSnoozesCreateCall)Fieldsadded inv0.105.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSnoozesCreateCall)Headeradded inv0.105.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsSnoozesGetCalladded inv0.105.0

type ProjectsSnoozesGetCall struct {// contains filtered or unexported fields}

func (*ProjectsSnoozesGetCall)Contextadded inv0.105.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSnoozesGetCall)Doadded inv0.105.0

Do executes the "monitoring.projects.snoozes.get" call.Any non-2xx status code is an error. Response headers are in either*Snooze.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSnoozesGetCall)Fieldsadded inv0.105.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSnoozesGetCall)Headeradded inv0.105.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSnoozesGetCall)IfNoneMatchadded inv0.105.0

func (c *ProjectsSnoozesGetCall) IfNoneMatch(entityTagstring) *ProjectsSnoozesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsSnoozesListCalladded inv0.105.0

type ProjectsSnoozesListCall struct {// contains filtered or unexported fields}

func (*ProjectsSnoozesListCall)Contextadded inv0.105.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSnoozesListCall)Doadded inv0.105.0

Do executes the "monitoring.projects.snoozes.list" call.Any non-2xx status code is an error. Response headers are in either*ListSnoozesResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSnoozesListCall)Fieldsadded inv0.105.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSnoozesListCall)Filteradded inv0.105.0

Filter sets the optional parameter "filter": Optional filter to restrictresults to the given criteria. The following fields are supported.interval.start_time interval.end_timeFor example: interval.start_time >"2022-03-11T00:00:00-08:00" AND interval.end_time <"2022-03-12T00:00:00-08:00"

func (*ProjectsSnoozesListCall)Headeradded inv0.105.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSnoozesListCall)IfNoneMatchadded inv0.105.0

func (c *ProjectsSnoozesListCall) IfNoneMatch(entityTagstring) *ProjectsSnoozesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsSnoozesListCall)PageSizeadded inv0.105.0

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return for a single query. The server may further constrain themaximum number of results returned in a single page. The value should be inthe range 1, 1000. If the value given is outside this range, the server willdecide the number of results to be returned.

func (*ProjectsSnoozesListCall)PageTokenadded inv0.105.0

PageToken sets the optional parameter "pageToken": The next_page_token froma previous call to ListSnoozesRequest to get the next page of results.

func (*ProjectsSnoozesListCall)Pagesadded inv0.105.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsSnoozesPatchCalladded inv0.105.0

type ProjectsSnoozesPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsSnoozesPatchCall)Contextadded inv0.105.0

Context sets the context to be used in this call's Do method.

func (*ProjectsSnoozesPatchCall)Doadded inv0.105.0

Do executes the "monitoring.projects.snoozes.patch" call.Any non-2xx status code is an error. Response headers are in either*Snooze.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSnoozesPatchCall)Fieldsadded inv0.105.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSnoozesPatchCall)Headeradded inv0.105.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsSnoozesPatchCall)UpdateMaskadded inv0.105.0

UpdateMask sets the optional parameter "updateMask": Required. The fields toupdate.For each field listed in update_mask: If the Snooze object suppliedin the UpdateSnoozeRequest has a value for that field, the value of thefield in the existing Snooze will be set to the value of the field in thesupplied 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 notlisted retain their existing value.The following are the field names thatare accepted in update_mask: display_name interval.start_timeinterval.end_timeThat said, the start time and end time of the Snoozedetermines which fields can legally be updated. Before attempting an update,users should consult the documentation for UpdateSnoozeRequest, which talksabout which fields can be updated.

typeProjectsSnoozesServiceadded inv0.105.0

type ProjectsSnoozesService struct {// contains filtered or unexported fields}

funcNewProjectsSnoozesServiceadded inv0.105.0

func NewProjectsSnoozesService(s *Service) *ProjectsSnoozesService

func (*ProjectsSnoozesService)Createadded inv0.105.0

Create: Creates a Snooze that will prevent alerts, which match the providedcriteria, from being opened. The Snooze applies for a specific timeinterval.

func (*ProjectsSnoozesService)Getadded inv0.105.0

Get: Retrieves a Snooze by name.

  • name: The ID of the Snooze to retrieve. The format is:projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID].

func (*ProjectsSnoozesService)Listadded inv0.105.0

List: Lists the Snoozes associated with a project. Can optionally pass infilter, which specifies predicates to match Snoozes.

func (*ProjectsSnoozesService)Patchadded inv0.105.0

Patch: Updates a Snooze, identified by its name, with the parameters in thegiven Snooze object.

  • name: Identifier. The name of the Snooze. The format is:projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snoozewill be generated by the system.

typeProjectsTimeSeriesCreateCall

type ProjectsTimeSeriesCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsTimeSeriesCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsTimeSeriesCreateCall)Do

Do executes the "monitoring.projects.timeSeries.create" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsTimeSeriesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsTimeSeriesCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsTimeSeriesCreateServiceCalladded inv0.59.0

type ProjectsTimeSeriesCreateServiceCall struct {// contains filtered or unexported fields}

func (*ProjectsTimeSeriesCreateServiceCall)Contextadded inv0.59.0

Context sets the context to be used in this call's Do method.

func (*ProjectsTimeSeriesCreateServiceCall)Doadded inv0.59.0

Do executes the "monitoring.projects.timeSeries.createService" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsTimeSeriesCreateServiceCall)Fieldsadded inv0.59.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsTimeSeriesCreateServiceCall)Headeradded inv0.59.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsTimeSeriesListCall

type ProjectsTimeSeriesListCall struct {// contains filtered or unexported fields}

func (*ProjectsTimeSeriesListCall)AggregationAlignmentPeriod

func (c *ProjectsTimeSeriesListCall) AggregationAlignmentPeriod(aggregationAlignmentPeriodstring) *ProjectsTimeSeriesListCall

AggregationAlignmentPeriod sets the optional parameter"aggregation.alignmentPeriod": The alignment_period specifies a timeinterval, in seconds, that is used to divide the data in all the time seriesinto consistent blocks of time. This will be done before the per-seriesaligner can be applied to the data.The value must be at least 60 seconds. Ifa per-series aligner other than ALIGN_NONE is specified, this field isrequired or an error is returned. If no per-series aligner is specified, orthe aligner ALIGN_NONE is specified, then this field is ignored.The maximumvalue of the alignment_period is 104 weeks (2 years) for charts, and 90,000seconds (25 hours) for alerting policies.

func (*ProjectsTimeSeriesListCall)AggregationCrossSeriesReducer

func (c *ProjectsTimeSeriesListCall) AggregationCrossSeriesReducer(aggregationCrossSeriesReducerstring) *ProjectsTimeSeriesListCall

AggregationCrossSeriesReducer sets the optional parameter"aggregation.crossSeriesReducer": The reduction operation to be used tocombine time series into a single time series, where the value of each datapoint in the resulting series is a function of all the already alignedvalues in the input time series.Not all reducer operations can be applied toall time series. The valid choices depend on the metric_kind and thevalue_type of the original time series. Reduction can yield a time serieswith a different metric_kind or value_type than the input time series.Timeseries data must first be aligned (see per_series_aligner) in order toperform cross-time series reduction. If cross_series_reducer is specified,then per_series_aligner must be specified, and must not be ALIGN_NONE. Analignment_period must also be specified; otherwise, an error is returned.

Possible values:

"REDUCE_NONE" - No cross-time series reduction. The output of the Aligner

is returned.

"REDUCE_MEAN" - Reduce by computing the mean value across time series for

each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric or distribution values. The value_type of the output is DOUBLE.

"REDUCE_MIN" - Reduce by computing the minimum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_MAX" - Reduce by computing the maximum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_SUM" - Reduce by computing the sum across time series for each

alignment period. This reducer is valid for DELTA and GAUGE metrics withnumeric and distribution values. The value_type of the output is the same asthe value_type of the input.

"REDUCE_STDDEV" - Reduce by computing the standard deviation across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics with numeric or distribution values. The value_type of the output isDOUBLE.

"REDUCE_COUNT" - Reduce by computing the number of data points across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics of numeric, Boolean, distribution, and string value_type. Thevalue_type of the output is INT64.

"REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of

True-valued data points to the total number of data points for eachalignment period. This reducer is valid for DELTA and GAUGE metrics ofBoolean value_type. The output value is in the range 0.0, 1.0 and hasvalue_type DOUBLE.

"REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

func (*ProjectsTimeSeriesListCall)AggregationGroupByFields

func (c *ProjectsTimeSeriesListCall) AggregationGroupByFields(aggregationGroupByFields ...string) *ProjectsTimeSeriesListCall

AggregationGroupByFields sets the optional parameter"aggregation.groupByFields": The set of fields to preserve whencross_series_reducer is specified. The group_by_fields determine how thetime series are partitioned into subsets prior to applying the aggregationoperation. Each subset contains time series that have the same value foreach of the grouping fields. Each individual time series is a member ofexactly one subset. The cross_series_reducer is applied to each subset oftime series. It is not possible to reduce across different resource types,so this field implicitly contains resource.type. Fields not specified ingroup_by_fields are aggregated away. If group_by_fields is not specified andall the time series have the same resource type, then the time series areaggregated into a single output time series. If cross_series_reducer is notdefined, this field is ignored.

func (*ProjectsTimeSeriesListCall)AggregationPerSeriesAligner

func (c *ProjectsTimeSeriesListCall) AggregationPerSeriesAligner(aggregationPerSeriesAlignerstring) *ProjectsTimeSeriesListCall

AggregationPerSeriesAligner sets the optional parameter"aggregation.perSeriesAligner": An Aligner describes how to bring the datapoints in a single time series into temporal alignment. Except forALIGN_NONE, all alignments cause all the data points in an alignment_periodto be mathematically grouped together, resulting in a single data point foreach alignment_period with end timestamp at the end of the period.Not allalignment operations may be applied to all time series. The valid choicesdepend on the metric_kind and value_type of the original time series.Alignment can change the metric_kind or the value_type of the timeseries.Time series data must be aligned in order to perform cross-timeseries reduction. If cross_series_reducer is specified, thenper_series_aligner must be specified and not equal to ALIGN_NONE andalignment_period must be specified; otherwise, an error is returned.

Possible values:

"ALIGN_NONE" - No alignment. Raw data is returned. Not valid if

cross-series reduction is requested. The value_type of the result is thesame as the value_type of the input.

"ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -

y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selectedalignment period results in periods with no data, then the aligned value forsuch a period is created by interpolation. The value_type of the alignedresult is the same as the value_type of the input.

"ALIGN_RATE" - Align and convert to a rate. The result is computed as rate

= (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner asproviding the slope of the line that passes through the value at the startand at the end of the alignment_period.This aligner is valid for CUMULATIVEand DELTA metrics with numeric values. If the selected alignment periodresults in periods with no data, then the aligned value for such a period iscreated by interpolation. The output is a GAUGE metric with value_typeDOUBLE.If, by "rate", you mean "percentage change", see theALIGN_PERCENT_CHANGE aligner instead.

"ALIGN_INTERPOLATE" - Align by interpolating between adjacent points

around the alignment period boundary. This aligner is valid for GAUGEmetrics with numeric values. The value_type of the aligned result is thesame as the value_type of the input.

"ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the

end of the alignment period to the boundary at the end of the alignmentperiod. This aligner is valid for GAUGE metrics. The value_type of thealigned result is the same as the value_type of the input.

"ALIGN_MIN" - Align the time series by returning the minimum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MAX" - Align the time series by returning the maximum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MEAN" - Align the time series by returning the mean value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is DOUBLE.

"ALIGN_COUNT" - Align the time series by returning the number of values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric or Boolean values. The value_type of the aligned result isINT64.

"ALIGN_SUM" - Align the time series by returning the sum of the values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric and distribution values. The value_type of the aligned resultis the same as the value_type of the input.

"ALIGN_STDDEV" - Align the time series by returning the standard deviation

of the values in each alignment period. This aligner is valid for GAUGE andDELTA metrics with numeric values. The value_type of the output is DOUBLE.

"ALIGN_COUNT_TRUE" - Align the time series by returning the number of True

values in each alignment period. This aligner is valid for GAUGE metricswith Boolean values. The value_type of the output is INT64.

"ALIGN_COUNT_FALSE" - Align the time series by returning the number of

False values in each alignment period. This aligner is valid for GAUGEmetrics with Boolean values. The value_type of the output is INT64.

"ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of

the number of True values to the total number of values in each alignmentperiod. This aligner is valid for GAUGE metrics with Boolean values. Theoutput value is in the range 0.0, 1.0 and has value_type DOUBLE.

"ALIGN_PERCENTILE_99" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 99th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_95" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 95th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_50" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 50th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_05" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 5th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This

aligner is valid for GAUGE and DELTA metrics with numeric values. Thisalignment returns ((current - previous)/previous) * 100, where the value ofprevious is determined based on the alignment_period.If the values ofcurrent and previous are both 0, then the returned value is 0. If onlyprevious is 0, the returned value is infinity.A 10-minute moving mean iscomputed at each point of the alignment period prior to the abovecalculation to smooth the metric and prevent false positives from veryshort-lived spikes. The moving mean is only applicable for data whose valuesare >= 0. Any values < 0 are treated as a missing datapoint, and areignored. While DELTA metrics are accepted by this alignment, special careshould be taken that the values for the metric will always be positive. Theoutput is a GAUGE metric with value_type DOUBLE.

func (*ProjectsTimeSeriesListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsTimeSeriesListCall)Do

Do executes the "monitoring.projects.timeSeries.list" call.Any non-2xx status code is an error. Response headers are in either*ListTimeSeriesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsTimeSeriesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsTimeSeriesListCall)Filter

Filter sets the optional parameter "filter": Required. A monitoring filter(https://cloud.google.com/monitoring/api/v3/filters) that specifies whichtime series should be returned. The filter must specify a single metrictype, and can additionally specify metric labels and other information. Forexample: metric.type = "compute.googleapis.com/instance/cpu/usage_time" ANDmetric.labels.instance_name = "my-instance-name"

func (*ProjectsTimeSeriesListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsTimeSeriesListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsTimeSeriesListCall)IntervalEndTime

func (c *ProjectsTimeSeriesListCall) IntervalEndTime(intervalEndTimestring) *ProjectsTimeSeriesListCall

IntervalEndTime sets the optional parameter "interval.endTime": Required.The end of the time interval.

func (*ProjectsTimeSeriesListCall)IntervalStartTime

func (c *ProjectsTimeSeriesListCall) IntervalStartTime(intervalStartTimestring) *ProjectsTimeSeriesListCall

IntervalStartTime sets the optional parameter "interval.startTime": Thebeginning of the time interval. The default value for the start time is theend time. The start time must not be later than the end time.

func (*ProjectsTimeSeriesListCall)OrderBy

OrderBy sets the optional parameter "orderBy": Unsupported: must be leftblank. The points in each time series are currently returned in reverse timeorder (most recent to oldest).

func (*ProjectsTimeSeriesListCall)PageSize

PageSize sets the optional parameter "pageSize": A positive number that isthe maximum number of results to return. If page_size is empty or more than100,000 results, the effective page_size is 100,000 results. If view is setto FULL, this is the maximum number of Points returned. If view is set toHEADERS, this is the maximum number of TimeSeries returned.

func (*ProjectsTimeSeriesListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*ProjectsTimeSeriesListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsTimeSeriesListCall)SecondaryAggregationAlignmentPeriodadded inv0.34.0

func (c *ProjectsTimeSeriesListCall) SecondaryAggregationAlignmentPeriod(secondaryAggregationAlignmentPeriodstring) *ProjectsTimeSeriesListCall

SecondaryAggregationAlignmentPeriod sets the optional parameter"secondaryAggregation.alignmentPeriod": The alignment_period specifies atime interval, in seconds, that is used to divide the data in all the timeseries into consistent blocks of time. This will be done before theper-series aligner can be applied to the data.The value must be at least 60seconds. If a per-series aligner other than ALIGN_NONE is specified, thisfield is required or an error is returned. If no per-series aligner isspecified, or the aligner ALIGN_NONE is specified, then this field isignored.The maximum value of the alignment_period is 104 weeks (2 years) forcharts, and 90,000 seconds (25 hours) for alerting policies.

func (*ProjectsTimeSeriesListCall)SecondaryAggregationCrossSeriesReduceradded inv0.34.0

func (c *ProjectsTimeSeriesListCall) SecondaryAggregationCrossSeriesReducer(secondaryAggregationCrossSeriesReducerstring) *ProjectsTimeSeriesListCall

SecondaryAggregationCrossSeriesReducer sets the optional parameter"secondaryAggregation.crossSeriesReducer": The reduction operation to beused to combine time series into a single time series, where the value ofeach data point in the resulting series is a function of all the alreadyaligned values in the input time series.Not all reducer operations can beapplied to all time series. The valid choices depend on the metric_kind andthe value_type of the original time series. Reduction can yield a timeseries with a different metric_kind or value_type than the input timeseries.Time series data must first be aligned (see per_series_aligner) inorder to perform cross-time series reduction. If cross_series_reducer isspecified, then per_series_aligner must be specified, and must not beALIGN_NONE. An alignment_period must also be specified; otherwise, an erroris returned.

Possible values:

"REDUCE_NONE" - No cross-time series reduction. The output of the Aligner

is returned.

"REDUCE_MEAN" - Reduce by computing the mean value across time series for

each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric or distribution values. The value_type of the output is DOUBLE.

"REDUCE_MIN" - Reduce by computing the minimum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_MAX" - Reduce by computing the maximum value across time series

for each alignment period. This reducer is valid for DELTA and GAUGE metricswith numeric values. The value_type of the output is the same as thevalue_type of the input.

"REDUCE_SUM" - Reduce by computing the sum across time series for each

alignment period. This reducer is valid for DELTA and GAUGE metrics withnumeric and distribution values. The value_type of the output is the same asthe value_type of the input.

"REDUCE_STDDEV" - Reduce by computing the standard deviation across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics with numeric or distribution values. The value_type of the output isDOUBLE.

"REDUCE_COUNT" - Reduce by computing the number of data points across time

series for each alignment period. This reducer is valid for DELTA and GAUGEmetrics of numeric, Boolean, distribution, and string value_type. Thevalue_type of the output is INT64.

"REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data

points across time series for each alignment period. This reducer is validfor DELTA and GAUGE metrics of Boolean value_type. The value_type of theoutput is INT64.

"REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of

True-valued data points to the total number of data points for eachalignment period. This reducer is valid for DELTA and GAUGE metrics ofBoolean value_type. The output value is in the range 0.0, 1.0 and hasvalue_type DOUBLE.

"REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

"REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile

(https://en.wikipedia.org/wiki/Percentile) of data points across time seriesfor each alignment period. This reducer is valid for GAUGE and DELTA metricsof numeric and distribution type. The value of the output is DOUBLE.

func (*ProjectsTimeSeriesListCall)SecondaryAggregationGroupByFieldsadded inv0.34.0

func (c *ProjectsTimeSeriesListCall) SecondaryAggregationGroupByFields(secondaryAggregationGroupByFields ...string) *ProjectsTimeSeriesListCall

SecondaryAggregationGroupByFields sets the optional parameter"secondaryAggregation.groupByFields": The set of fields to preserve whencross_series_reducer is specified. The group_by_fields determine how thetime series are partitioned into subsets prior to applying the aggregationoperation. Each subset contains time series that have the same value foreach of the grouping fields. Each individual time series is a member ofexactly one subset. The cross_series_reducer is applied to each subset oftime series. It is not possible to reduce across different resource types,so this field implicitly contains resource.type. Fields not specified ingroup_by_fields are aggregated away. If group_by_fields is not specified andall the time series have the same resource type, then the time series areaggregated into a single output time series. If cross_series_reducer is notdefined, this field is ignored.

func (*ProjectsTimeSeriesListCall)SecondaryAggregationPerSeriesAligneradded inv0.34.0

func (c *ProjectsTimeSeriesListCall) SecondaryAggregationPerSeriesAligner(secondaryAggregationPerSeriesAlignerstring) *ProjectsTimeSeriesListCall

SecondaryAggregationPerSeriesAligner sets the optional parameter"secondaryAggregation.perSeriesAligner": An Aligner describes how to bringthe data points in a single time series into temporal alignment. Except forALIGN_NONE, all alignments cause all the data points in an alignment_periodto be mathematically grouped together, resulting in a single data point foreach alignment_period with end timestamp at the end of the period.Not allalignment operations may be applied to all time series. The valid choicesdepend on the metric_kind and value_type of the original time series.Alignment can change the metric_kind or the value_type of the timeseries.Time series data must be aligned in order to perform cross-timeseries reduction. If cross_series_reducer is specified, thenper_series_aligner must be specified and not equal to ALIGN_NONE andalignment_period must be specified; otherwise, an error is returned.

Possible values:

"ALIGN_NONE" - No alignment. Raw data is returned. Not valid if

cross-series reduction is requested. The value_type of the result is thesame as the value_type of the input.

"ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -

y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selectedalignment period results in periods with no data, then the aligned value forsuch a period is created by interpolation. The value_type of the alignedresult is the same as the value_type of the input.

"ALIGN_RATE" - Align and convert to a rate. The result is computed as rate

= (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner asproviding the slope of the line that passes through the value at the startand at the end of the alignment_period.This aligner is valid for CUMULATIVEand DELTA metrics with numeric values. If the selected alignment periodresults in periods with no data, then the aligned value for such a period iscreated by interpolation. The output is a GAUGE metric with value_typeDOUBLE.If, by "rate", you mean "percentage change", see theALIGN_PERCENT_CHANGE aligner instead.

"ALIGN_INTERPOLATE" - Align by interpolating between adjacent points

around the alignment period boundary. This aligner is valid for GAUGEmetrics with numeric values. The value_type of the aligned result is thesame as the value_type of the input.

"ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the

end of the alignment period to the boundary at the end of the alignmentperiod. This aligner is valid for GAUGE metrics. The value_type of thealigned result is the same as the value_type of the input.

"ALIGN_MIN" - Align the time series by returning the minimum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MAX" - Align the time series by returning the maximum value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is the same as thevalue_type of the input.

"ALIGN_MEAN" - Align the time series by returning the mean value in each

alignment period. This aligner is valid for GAUGE and DELTA metrics withnumeric values. The value_type of the aligned result is DOUBLE.

"ALIGN_COUNT" - Align the time series by returning the number of values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric or Boolean values. The value_type of the aligned result isINT64.

"ALIGN_SUM" - Align the time series by returning the sum of the values in

each alignment period. This aligner is valid for GAUGE and DELTA metricswith numeric and distribution values. The value_type of the aligned resultis the same as the value_type of the input.

"ALIGN_STDDEV" - Align the time series by returning the standard deviation

of the values in each alignment period. This aligner is valid for GAUGE andDELTA metrics with numeric values. The value_type of the output is DOUBLE.

"ALIGN_COUNT_TRUE" - Align the time series by returning the number of True

values in each alignment period. This aligner is valid for GAUGE metricswith Boolean values. The value_type of the output is INT64.

"ALIGN_COUNT_FALSE" - Align the time series by returning the number of

False values in each alignment period. This aligner is valid for GAUGEmetrics with Boolean values. The value_type of the output is INT64.

"ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of

the number of True values to the total number of values in each alignmentperiod. This aligner is valid for GAUGE metrics with Boolean values. Theoutput value is in the range 0.0, 1.0 and has value_type DOUBLE.

"ALIGN_PERCENTILE_99" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 99th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_95" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 95th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_50" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 50th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENTILE_05" - Align the time series by using percentile

aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting datapoint in each alignment period is the 5th percentile of all data points inthe period. This aligner is valid for GAUGE and DELTA metrics withdistribution values. The output is a GAUGE metric with value_type DOUBLE.

"ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This

aligner is valid for GAUGE and DELTA metrics with numeric values. Thisalignment returns ((current - previous)/previous) * 100, where the value ofprevious is determined based on the alignment_period.If the values ofcurrent and previous are both 0, then the returned value is 0. If onlyprevious is 0, the returned value is infinity.A 10-minute moving mean iscomputed at each point of the alignment period prior to the abovecalculation to smooth the metric and prevent false positives from veryshort-lived spikes. The moving mean is only applicable for data whose valuesare >= 0. Any values < 0 are treated as a missing datapoint, and areignored. While DELTA metrics are accepted by this alignment, special careshould be taken that the values for the metric will always be positive. Theoutput is a GAUGE metric with value_type DOUBLE.

func (*ProjectsTimeSeriesListCall)View

View sets the optional parameter "view": Required. Specifies whichinformation is returned about the time series.

Possible values:

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

typeProjectsTimeSeriesQueryCalladded inv0.22.0

type ProjectsTimeSeriesQueryCall struct {// contains filtered or unexported fields}

func (*ProjectsTimeSeriesQueryCall)Contextadded inv0.22.0

Context sets the context to be used in this call's Do method.

func (*ProjectsTimeSeriesQueryCall)Doadded inv0.22.0

Do executes the "monitoring.projects.timeSeries.query" call.Any non-2xx status code is an error. Response headers are in either*QueryTimeSeriesResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsTimeSeriesQueryCall)Fieldsadded inv0.22.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsTimeSeriesQueryCall)Headeradded inv0.22.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsTimeSeriesQueryCall)Pagesadded inv0.22.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsTimeSeriesService

type ProjectsTimeSeriesService struct {// contains filtered or unexported fields}

funcNewProjectsTimeSeriesService

func NewProjectsTimeSeriesService(s *Service) *ProjectsTimeSeriesService

func (*ProjectsTimeSeriesService)Create

Create: Creates or adds data to one or more time series. The response isempty if all time series in the request were written. If any time seriescould not be written, a corresponding failure message is included in theerror response. This method does not support resource locations constraintof an organization policy(https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy).

func (*ProjectsTimeSeriesService)CreateServiceadded inv0.59.0

CreateService: Creates or adds data to one or more service time series. Aservice time series is a time series for a metric from a Google Cloudservice. The response is empty if all time series in the request werewritten. If any time series could not be written, a corresponding failuremessage is included in the error response. This endpoint rejects writes touser-defined metrics. This method is only for use by Google Cloud services.Use projects.timeSeries.create instead.

func (*ProjectsTimeSeriesService)List

List: Lists time series that match a filter.

func (*ProjectsTimeSeriesService)Queryadded inv0.22.0

Query: Queries time series by using Monitoring Query Language (MQL). Werecommend using PromQL instead of MQL. For more information about the statusof MQL, see the MQL deprecation notice(https://cloud.google.com/stackdriver/docs/deprecations/mql).

typeProjectsUptimeCheckConfigsCreateCall

type ProjectsUptimeCheckConfigsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsUptimeCheckConfigsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsUptimeCheckConfigsCreateCall)Do

Do executes the "monitoring.projects.uptimeCheckConfigs.create" call.Any non-2xx status code is an error. Response headers are in either*UptimeCheckConfig.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsUptimeCheckConfigsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsUptimeCheckConfigsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsUptimeCheckConfigsDeleteCall

type ProjectsUptimeCheckConfigsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsUptimeCheckConfigsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsUptimeCheckConfigsDeleteCall)Do

Do executes the "monitoring.projects.uptimeCheckConfigs.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsUptimeCheckConfigsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsUptimeCheckConfigsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsUptimeCheckConfigsGetCall

type ProjectsUptimeCheckConfigsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsUptimeCheckConfigsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsUptimeCheckConfigsGetCall)Do

Do executes the "monitoring.projects.uptimeCheckConfigs.get" call.Any non-2xx status code is an error. Response headers are in either*UptimeCheckConfig.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsUptimeCheckConfigsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsUptimeCheckConfigsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsUptimeCheckConfigsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsUptimeCheckConfigsListCall

type ProjectsUptimeCheckConfigsListCall struct {// contains filtered or unexported fields}

func (*ProjectsUptimeCheckConfigsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsUptimeCheckConfigsListCall)Do

Do executes the "monitoring.projects.uptimeCheckConfigs.list" call.Any non-2xx status code is an error. Response headers are in either*ListUptimeCheckConfigsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsUptimeCheckConfigsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsUptimeCheckConfigsListCall)Filteradded inv0.96.0

Filter sets the optional parameter "filter": If provided, this fieldspecifies the criteria that must be met by uptime checks to be included inthe response.For more details, see Filtering syntax(https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).

func (*ProjectsUptimeCheckConfigsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsUptimeCheckConfigsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsUptimeCheckConfigsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return in a single response. The server may further constrain themaximum 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.

func (*ProjectsUptimeCheckConfigsListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return moreresults from the previous method call.

func (*ProjectsUptimeCheckConfigsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsUptimeCheckConfigsPatchCall

type ProjectsUptimeCheckConfigsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsUptimeCheckConfigsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsUptimeCheckConfigsPatchCall)Do

Do executes the "monitoring.projects.uptimeCheckConfigs.patch" call.Any non-2xx status code is an error. Response headers are in either*UptimeCheckConfig.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsUptimeCheckConfigsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsUptimeCheckConfigsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsUptimeCheckConfigsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": If present, only thelisted fields in the current Uptime check configuration are updated withvalues from the new configuration. If this field is empty, then the currentconfiguration is completely replaced with the new configuration.

typeProjectsUptimeCheckConfigsService

type ProjectsUptimeCheckConfigsService struct {// contains filtered or unexported fields}

funcNewProjectsUptimeCheckConfigsService

func NewProjectsUptimeCheckConfigsService(s *Service) *ProjectsUptimeCheckConfigsService

func (*ProjectsUptimeCheckConfigsService)Create

Create: Creates a new Uptime check configuration.

func (*ProjectsUptimeCheckConfigsService)Delete

Delete: Deletes an Uptime check configuration. Note that this method willfail if the Uptime check configuration is referenced by an alert policy orother dependent configs that would be rendered invalid by the deletion.

  • name: The Uptime check configuration to delete. The format is:projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

func (*ProjectsUptimeCheckConfigsService)Get

Get: Gets a single Uptime check configuration.

  • name: The Uptime check configuration to retrieve. The format is:projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

func (*ProjectsUptimeCheckConfigsService)List

List: Lists the existing valid Uptime check configurations for the project(leaving out any invalid configurations).

func (*ProjectsUptimeCheckConfigsService)Patch

Patch: Updates an Uptime check configuration. You can either replace theentire configuration with a new one or replace only certain fields in thecurrent configuration by specifying the fields to be updated via updateMask.Returns the updated configuration.

  • name: Identifier. A unique resource name for this Uptime checkconfiguration. The format is:projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID][PROJECT_ID_OR_NUMBER] is the Workspace host project associated with theUptime check.This field should be omitted when creating the Uptime checkconfiguration; on create, the resource name is assigned by the server andincluded in the response.

typePrometheusQueryLanguageConditionadded inv0.131.0

type PrometheusQueryLanguageCondition struct {// AlertRule: 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// (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).// This field may not exceed 2048 Unicode characters in length.AlertRulestring `json:"alertRule,omitempty"`// DisableMetricValidation: Optional. Whether to disable metric existence// validation for this condition.This allows alerting policies to be defined on// metrics that do not yet exist, improving advanced customer workflows such as// configuring alerting policies using Terraform.Users with the// monitoring.alertPolicyViewer role are able to see the name of the// non-existent metric in the alerting policy condition.DisableMetricValidationbool `json:"disableMetricValidation,omitempty"`// 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.Durationstring `json:"duration,omitempty"`// EvaluationInterval: 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.EvaluationIntervalstring `json:"evaluationInterval,omitempty"`// Labels: Optional. Labels to add to or overwrite in the PromQL query result.// Label names must be valid// (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).// Label values can be templatized by using variables// (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). The// only available variable names are the names of the labels in the PromQL// result, including "__name__" and "value". "labels" may be empty.Labels map[string]string `json:"labels,omitempty"`// Query: 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.Querystring `json:"query,omitempty"`// RuleGroup: 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.RuleGroupstring `json:"ruleGroup,omitempty"`// ForceSendFields is a list of field names (e.g. "AlertRule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlertRule") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PrometheusQueryLanguageCondition: A condition type that allows alertingpolicies to be defined using Prometheus Query Language (PromQL)(https://prometheus.io/docs/prometheus/latest/querying/basics/).ThePrometheusQueryLanguageCondition message contains information from aPrometheus alerting rule and its associated rule group.A Prometheus alertingrule is described here(https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/).The semantics of a Prometheus alerting rule is described here(https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).APrometheus rule group is described here(https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).The semantics of a Prometheus rule group is described here(https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).BecauseCloud Alerting has no representation of a Prometheus rule group resource, wemust embed the information of the parent rule group inside each of theconditions that refer to it. We must also update the contents of allPrometheus alerts in case the information of their rule group changes.ThePrometheusQueryLanguageCondition protocol buffer combines the information ofthe corresponding rule group and alerting rule. The structure of thePrometheusQueryLanguageCondition protocol buffer does NOT mimic thestructure of the Prometheus rule group and alerting rule YAML declarations.The PrometheusQueryLanguageCondition protocol buffer may change in thefuture to support future rule group and/or alerting rule features. There areno new such features at the present time (2023-06-26).

func (PrometheusQueryLanguageCondition)MarshalJSONadded inv0.131.0

func (sPrometheusQueryLanguageCondition) MarshalJSON() ([]byte,error)

typeQueryTimeSeriesRequestadded inv0.22.0

type QueryTimeSeriesRequest struct {// PageSize: A positive number that is the maximum number of time_series_data// to return.PageSizeint64 `json:"pageSize,omitempty"`// PageToken: If this field is not empty then it must contain the nextPageToken// value returned by a previous call to this method. Using this field causes// the method to return additional results from the previous method call.PageTokenstring `json:"pageToken,omitempty"`// Query: Required. The query in the Monitoring Query Language// (https://cloud.google.com/monitoring/mql/reference) format. The default time// zone is in UTC.Querystring `json:"query,omitempty"`// ForceSendFields is a list of field names (e.g. "PageSize") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageSize") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QueryTimeSeriesRequest: The QueryTimeSeries request. For information aboutthe status of Monitoring Query Language (MQL), see the MQL deprecationnotice (https://cloud.google.com/stackdriver/docs/deprecations/mql).

func (QueryTimeSeriesRequest)MarshalJSONadded inv0.22.0

func (sQueryTimeSeriesRequest) MarshalJSON() ([]byte,error)

typeQueryTimeSeriesResponseadded inv0.22.0

type QueryTimeSeriesResponse struct {// NextPageToken: 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.NextPageTokenstring `json:"nextPageToken,omitempty"`// PartialErrors: Query execution errors that may have caused the time series// data returned to be incomplete. The available data will be available in the// response.PartialErrors []*Status `json:"partialErrors,omitempty"`// TimeSeriesData: The time series data.TimeSeriesData []*TimeSeriesData `json:"timeSeriesData,omitempty"`// TimeSeriesDescriptor: The descriptor for the time series data.TimeSeriesDescriptor *TimeSeriesDescriptor `json:"timeSeriesDescriptor,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

QueryTimeSeriesResponse: The QueryTimeSeries response. For information aboutthe status of Monitoring Query Language (MQL), see the MQL deprecationnotice (https://cloud.google.com/stackdriver/docs/deprecations/mql).

func (QueryTimeSeriesResponse)MarshalJSONadded inv0.22.0

func (sQueryTimeSeriesResponse) MarshalJSON() ([]byte,error)

typeRange

type Range struct {// Max: The maximum of the population values.Maxfloat64 `json:"max,omitempty"`// Min: The minimum of the population values.Minfloat64 `json:"min,omitempty"`// ForceSendFields is a list of field names (e.g. "Max") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Max") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Range: The range of the population values.

func (Range)MarshalJSON

func (sRange) MarshalJSON() ([]byte,error)

func (*Range)UnmarshalJSON

func (s *Range) UnmarshalJSON(data []byte)error

typeRequestBasedSliadded inv0.14.0

type RequestBasedSli struct {// 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.DistributionCut *DistributionCut `json:"distributionCut,omitempty"`// GoodTotalRatio: good_total_ratio is used when the ratio of good_service to// total_service is computed from two TimeSeries.GoodTotalRatio *TimeSeriesRatio `json:"goodTotalRatio,omitempty"`// ForceSendFields is a list of field names (e.g. "DistributionCut") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DistributionCut") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RequestBasedSli: Service Level Indicators for which atomic units of serviceare counted directly.

func (RequestBasedSli)MarshalJSONadded inv0.14.0

func (sRequestBasedSli) MarshalJSON() ([]byte,error)

typeResourceGroup

type ResourceGroup struct {// GroupId: The group of resources being monitored. Should be only the// [GROUP_ID], and not the full-path// projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].GroupIdstring `json:"groupId,omitempty"`// ResourceType: The resource type of the group members.//// Possible values://   "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.ResourceTypestring `json:"resourceType,omitempty"`// ForceSendFields is a list of field names (e.g. "GroupId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GroupId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ResourceGroup: The resource submessage for group checks. It can be usedinstead of a monitored resource, when multiple resources are beingmonitored.

func (ResourceGroup)MarshalJSON

func (sResourceGroup) MarshalJSON() ([]byte,error)

typeResponseStatusCodeadded inv0.89.0

type ResponseStatusCode struct {// StatusClass: A class of status codes to accept.//// Possible values://   "STATUS_CLASS_UNSPECIFIED" - Default value that matches no status codes.//   "STATUS_CLASS_1XX" - The class of status codes between 100 and 199.//   "STATUS_CLASS_2XX" - The class of status codes between 200 and 299.//   "STATUS_CLASS_3XX" - The class of status codes between 300 and 399.//   "STATUS_CLASS_4XX" - The class of status codes between 400 and 499.//   "STATUS_CLASS_5XX" - The class of status codes between 500 and 599.//   "STATUS_CLASS_ANY" - The class of all status codes.StatusClassstring `json:"statusClass,omitempty"`// StatusValue: A status code to accept.StatusValueint64 `json:"statusValue,omitempty"`// ForceSendFields is a list of field names (e.g. "StatusClass") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "StatusClass") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ResponseStatusCode: A status to accept. Either a status code class like"2xx", or an integer status code like "200".

func (ResponseStatusCode)MarshalJSONadded inv0.89.0

func (sResponseStatusCode) MarshalJSON() ([]byte,error)

typeRowCountTestadded inv0.200.0

type RowCountTest struct {// Comparison: Required. The comparison to apply between the number of rows// returned by the query and the threshold.//// Possible values://   "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.Comparisonstring `json:"comparison,omitempty"`// Threshold: Required. The value against which to compare the row count.Thresholdint64 `json:"threshold,omitempty,string"`// ForceSendFields is a list of field names (e.g. "Comparison") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Comparison") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RowCountTest: A test that checks if the number of rows in the result setviolates some threshold.

func (RowCountTest)MarshalJSONadded inv0.200.0

func (sRowCountTest) MarshalJSON() ([]byte,error)

typeSendNotificationChannelVerificationCodeRequest

type SendNotificationChannelVerificationCodeRequest struct {}

SendNotificationChannelVerificationCodeRequest: TheSendNotificationChannelVerificationCode request.

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentFolders *FoldersServiceOrganizations *OrganizationsServiceProjects *ProjectsServiceServices *ServicesServiceUptimeCheckIps *UptimeCheckIpsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeServiceAgentAuthenticationadded inv0.176.0

type ServiceAgentAuthentication struct {// Type: Type of authentication.//// Possible values://   "SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED" - Default value, will// result in OIDC Authentication.//   "OIDC_TOKEN" - OIDC AuthenticationTypestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Type") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Type") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ServiceAgentAuthentication: Contains information needed for generatingeither an OpenID Connect token(https://developers.google.com/identity/protocols/OpenIDConnect) or OAuthtoken (https://developers.google.com/identity/protocols/oauth2). The tokenwill be generated for the Monitoring service agent service account.

func (ServiceAgentAuthentication)MarshalJSONadded inv0.176.0

func (sServiceAgentAuthentication) MarshalJSON() ([]byte,error)

typeServiceLevelIndicatoradded inv0.14.0

type ServiceLevelIndicator struct {// BasicSli: Basic SLI on a well-known service type.BasicSli *BasicSli `json:"basicSli,omitempty"`// RequestBased: Request-based SLIsRequestBased *RequestBasedSli `json:"requestBased,omitempty"`// WindowsBased: Windows-based SLIsWindowsBased *WindowsBasedSli `json:"windowsBased,omitempty"`// ForceSendFields is a list of field names (e.g. "BasicSli") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BasicSli") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (ServiceLevelIndicator)MarshalJSONadded inv0.14.0

func (sServiceLevelIndicator) MarshalJSON() ([]byte,error)

typeServiceLevelObjectiveadded inv0.14.0

type ServiceLevelObjective struct {// CalendarPeriod: A calendar period, semantically "since the start of the// current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported.//// Possible values://   "CALENDAR_PERIOD_UNSPECIFIED" - Undefined period, raises an error.//   "DAY" - A day.//   "WEEK" - A week. Weeks begin on Monday, following ISO 8601// (https://en.wikipedia.org/wiki/ISO_week_date).//   "FORTNIGHT" - A fortnight. The first calendar fortnight of the year begins// at the start of week 1 according to ISO 8601// (https://en.wikipedia.org/wiki/ISO_week_date).//   "MONTH" - A month.//   "QUARTER" - A quarter. Quarters start on dates 1-Jan, 1-Apr, 1-Jul, and// 1-Oct of each year.//   "HALF" - A half-year. Half-years start on dates 1-Jan and 1-Jul.//   "YEAR" - A year.CalendarPeriodstring `json:"calendarPeriod,omitempty"`// DisplayName: Name used for UI elements listing this SLO.DisplayNamestring `json:"displayName,omitempty"`// Goal: The fraction of service that must be good in order for this objective// to be met. 0 < goal <= 0.9999.Goalfloat64 `json:"goal,omitempty"`// Name: Identifier. Resource name for this ServiceLevelObjective. The format// is:// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/// [SLO_NAME]Namestring `json:"name,omitempty"`// RollingPeriod: A rolling time period, semantically "in the past ". Must be// an integer multiple of 1 day no larger than 30 days.RollingPeriodstring `json:"rollingPeriod,omitempty"`// 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.ServiceLevelIndicator *ServiceLevelIndicator `json:"serviceLevelIndicator,omitempty"`// UserLabels: 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.UserLabels map[string]string `json:"userLabels,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CalendarPeriod") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CalendarPeriod") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ServiceLevelObjective: A Service-Level Objective (SLO) describes a level ofdesired good service. It consists of a service-level indicator (SLI), aperformance goal, and a period over which the objective is to be evaluatedagainst that goal. The SLO can use SLIs defined in a number of differentmanners. Typical SLOs might include "99% of requests in each rolling weekhave latency below 200 milliseconds" or "99.5% of requests in each calendarmonth return successfully."

func (ServiceLevelObjective)MarshalJSONadded inv0.14.0

func (sServiceLevelObjective) MarshalJSON() ([]byte,error)

func (*ServiceLevelObjective)UnmarshalJSONadded inv0.14.0

func (s *ServiceLevelObjective) UnmarshalJSON(data []byte)error

typeServicesCreateCalladded inv0.14.0

type ServicesCreateCall struct {// contains filtered or unexported fields}

func (*ServicesCreateCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesCreateCall)Doadded inv0.14.0

Do executes the "monitoring.services.create" call.Any non-2xx status code is an error. Response headers are in either*MService.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesCreateCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesCreateCall)Headeradded inv0.14.0

func (c *ServicesCreateCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesCreateCall)ServiceIdadded inv0.14.0

func (c *ServicesCreateCall) ServiceId(serviceIdstring) *ServicesCreateCall

ServiceId sets the optional parameter "serviceId": The Service id to use forthis Service. If omitted, an id will be generated instead. Must match thepattern [a-z0-9\-]+

typeServicesDeleteCalladded inv0.14.0

type ServicesDeleteCall struct {// contains filtered or unexported fields}

func (*ServicesDeleteCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesDeleteCall)Doadded inv0.14.0

Do executes the "monitoring.services.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesDeleteCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesDeleteCall)Headeradded inv0.14.0

func (c *ServicesDeleteCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesGetCalladded inv0.14.0

type ServicesGetCall struct {// contains filtered or unexported fields}

func (*ServicesGetCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesGetCall)Doadded inv0.14.0

Do executes the "monitoring.services.get" call.Any non-2xx status code is an error. Response headers are in either*MService.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesGetCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesGetCall)Headeradded inv0.14.0

func (c *ServicesGetCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesGetCall)IfNoneMatchadded inv0.14.0

func (c *ServicesGetCall) IfNoneMatch(entityTagstring) *ServicesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeServicesListCalladded inv0.14.0

type ServicesListCall struct {// contains filtered or unexported fields}

func (*ServicesListCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesListCall)Doadded inv0.14.0

Do executes the "monitoring.services.list" call.Any non-2xx status code is an error. Response headers are in either*ListServicesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ServicesListCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesListCall)Filteradded inv0.14.0

func (c *ServicesListCall) Filter(filterstring) *ServicesListCall

Filter sets the optional parameter "filter": A filter specifying whatServices to return. The filter supports filtering on a particularservice-identifier type or one of its attributes.To filter on a particularservice-identifier type, the identifier_case refers to which option in theidentifier field is populated. For example, the filter identifier_case ="CUSTOM" would match all services with a value for the custom field. Validoptions include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other optionslisted athttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#ServiceTofilter on an attribute of a service-identifier type, apply the filter nameby using the snake case of the service-identifier type and the attribute ofthat service-identifier type, and join the two with a period. For example,to filter by the meshUid field of the MeshIstio service-identifier type, youmust filter on mesh_istio.mesh_uid = "123" to match all services with meshUID "123". Service-identifier types and their attributes are described athttps://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service

func (*ServicesListCall)Headeradded inv0.14.0

func (c *ServicesListCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesListCall)IfNoneMatchadded inv0.14.0

func (c *ServicesListCall) IfNoneMatch(entityTagstring) *ServicesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesListCall)PageSizeadded inv0.14.0

func (c *ServicesListCall) PageSize(pageSizeint64) *ServicesListCall

PageSize sets the optional parameter "pageSize": A non-negative number thatis the maximum number of results to return. When 0, use default page size.

func (*ServicesListCall)PageTokenadded inv0.14.0

func (c *ServicesListCall) PageToken(pageTokenstring) *ServicesListCall

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*ServicesListCall)Pagesadded inv0.14.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeServicesPatchCalladded inv0.14.0

type ServicesPatchCall struct {// contains filtered or unexported fields}

func (*ServicesPatchCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesPatchCall)Doadded inv0.14.0

Do executes the "monitoring.services.patch" call.Any non-2xx status code is an error. Response headers are in either*MService.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesPatchCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesPatchCall)Headeradded inv0.14.0

func (c *ServicesPatchCall) Header()http.Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesPatchCall)UpdateMaskadded inv0.14.0

func (c *ServicesPatchCall) UpdateMask(updateMaskstring) *ServicesPatchCall

UpdateMask sets the optional parameter "updateMask": A set of field pathsdefining which fields to use for the update.

typeServicesServiceadded inv0.14.0

type ServicesService struct {ServiceLevelObjectives *ServicesServiceLevelObjectivesService// contains filtered or unexported fields}

funcNewServicesServiceadded inv0.14.0

func NewServicesService(s *Service) *ServicesService

func (*ServicesService)Createadded inv0.14.0

func (r *ServicesService) Create(parentstring, service *MService) *ServicesCreateCall

Create: Create a Service.

func (*ServicesService)Deleteadded inv0.14.0

Delete: Soft delete this Service.

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

func (*ServicesService)Getadded inv0.14.0

Get: Get the named Service.

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

func (*ServicesService)Listadded inv0.14.0

func (r *ServicesService) List(parentstring) *ServicesListCall

List: List Services for this Metrics Scope.

func (*ServicesService)Patchadded inv0.14.0

func (r *ServicesService) Patch(namestring, service *MService) *ServicesPatchCall

Patch: Update this Service.

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

typeServicesServiceLevelObjectivesCreateCalladded inv0.14.0

type ServicesServiceLevelObjectivesCreateCall struct {// contains filtered or unexported fields}

func (*ServicesServiceLevelObjectivesCreateCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesServiceLevelObjectivesCreateCall)Doadded inv0.14.0

Do executes the "monitoring.services.serviceLevelObjectives.create" call.Any non-2xx status code is an error. Response headers are in either*ServiceLevelObjective.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ServicesServiceLevelObjectivesCreateCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesServiceLevelObjectivesCreateCall)Headeradded inv0.14.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesServiceLevelObjectivesCreateCall)ServiceLevelObjectiveIdadded inv0.14.0

func (c *ServicesServiceLevelObjectivesCreateCall) ServiceLevelObjectiveId(serviceLevelObjectiveIdstring) *ServicesServiceLevelObjectivesCreateCall

ServiceLevelObjectiveId sets the optional parameter"serviceLevelObjectiveId": The ServiceLevelObjective id to use for thisServiceLevelObjective. If omitted, an id will be generated instead. Mustmatch the pattern ^[a-zA-Z0-9-_:.]+$

typeServicesServiceLevelObjectivesDeleteCalladded inv0.14.0

type ServicesServiceLevelObjectivesDeleteCall struct {// contains filtered or unexported fields}

func (*ServicesServiceLevelObjectivesDeleteCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesServiceLevelObjectivesDeleteCall)Doadded inv0.14.0

Do executes the "monitoring.services.serviceLevelObjectives.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ServicesServiceLevelObjectivesDeleteCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesServiceLevelObjectivesDeleteCall)Headeradded inv0.14.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeServicesServiceLevelObjectivesGetCalladded inv0.14.0

type ServicesServiceLevelObjectivesGetCall struct {// contains filtered or unexported fields}

func (*ServicesServiceLevelObjectivesGetCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesServiceLevelObjectivesGetCall)Doadded inv0.14.0

Do executes the "monitoring.services.serviceLevelObjectives.get" call.Any non-2xx status code is an error. Response headers are in either*ServiceLevelObjective.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ServicesServiceLevelObjectivesGetCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesServiceLevelObjectivesGetCall)Headeradded inv0.14.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesServiceLevelObjectivesGetCall)IfNoneMatchadded inv0.14.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesServiceLevelObjectivesGetCall)Viewadded inv0.14.0

View sets the optional parameter "view": View of the ServiceLevelObjectiveto return. If DEFAULT, return the ServiceLevelObjective as originallydefined. If EXPLICIT and the ServiceLevelObjective is defined in terms of aBasicSli, replace the BasicSli with a RequestBasedSli spelling out how theSLI is computed.

Possible values:

"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 ServiceLevelIndicators using BasicSli articulation,

instead return the ServiceLevelIndicator with its mode of computation fullyspelled out as a RequestBasedSli. For ServiceLevelIndicators usingRequestBasedSli or WindowsBasedSli, return the ServiceLevelIndicator as itwas provided.

typeServicesServiceLevelObjectivesListCalladded inv0.14.0

type ServicesServiceLevelObjectivesListCall struct {// contains filtered or unexported fields}

func (*ServicesServiceLevelObjectivesListCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesServiceLevelObjectivesListCall)Doadded inv0.14.0

Do executes the "monitoring.services.serviceLevelObjectives.list" call.Any non-2xx status code is an error. Response headers are in either*ListServiceLevelObjectivesResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ServicesServiceLevelObjectivesListCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesServiceLevelObjectivesListCall)Filteradded inv0.14.0

Filter sets the optional parameter "filter": A filter specifying whatServiceLevelObjectives to return.

func (*ServicesServiceLevelObjectivesListCall)Headeradded inv0.14.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesServiceLevelObjectivesListCall)IfNoneMatchadded inv0.14.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ServicesServiceLevelObjectivesListCall)PageSizeadded inv0.14.0

PageSize sets the optional parameter "pageSize": A non-negative number thatis the maximum number of results to return. When 0, use default page size.

func (*ServicesServiceLevelObjectivesListCall)PageTokenadded inv0.14.0

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return additionalresults from the previous method call.

func (*ServicesServiceLevelObjectivesListCall)Pagesadded inv0.14.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ServicesServiceLevelObjectivesListCall)Viewadded inv0.14.0

View sets the optional parameter "view": View of the ServiceLevelObjectivesto return. If DEFAULT, return each ServiceLevelObjective as originallydefined. If EXPLICIT and the ServiceLevelObjective is defined in terms of aBasicSli, replace the BasicSli with a RequestBasedSli spelling out how theSLI is computed.

Possible values:

"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 ServiceLevelIndicators using BasicSli articulation,

instead return the ServiceLevelIndicator with its mode of computation fullyspelled out as a RequestBasedSli. For ServiceLevelIndicators usingRequestBasedSli or WindowsBasedSli, return the ServiceLevelIndicator as itwas provided.

typeServicesServiceLevelObjectivesPatchCalladded inv0.14.0

type ServicesServiceLevelObjectivesPatchCall struct {// contains filtered or unexported fields}

func (*ServicesServiceLevelObjectivesPatchCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method.

func (*ServicesServiceLevelObjectivesPatchCall)Doadded inv0.14.0

Do executes the "monitoring.services.serviceLevelObjectives.patch" call.Any non-2xx status code is an error. Response headers are in either*ServiceLevelObjective.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ServicesServiceLevelObjectivesPatchCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ServicesServiceLevelObjectivesPatchCall)Headeradded inv0.14.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ServicesServiceLevelObjectivesPatchCall)UpdateMaskadded inv0.14.0

UpdateMask sets the optional parameter "updateMask": A set of field pathsdefining which fields to use for the update.

typeServicesServiceLevelObjectivesServiceadded inv0.14.0

type ServicesServiceLevelObjectivesService struct {// contains filtered or unexported fields}

funcNewServicesServiceLevelObjectivesServiceadded inv0.14.0

func NewServicesServiceLevelObjectivesService(s *Service) *ServicesServiceLevelObjectivesService

func (*ServicesServiceLevelObjectivesService)Createadded inv0.14.0

Create: Create a ServiceLevelObjective for the given Service.

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

func (*ServicesServiceLevelObjectivesService)Deleteadded inv0.14.0

Delete: Delete the given ServiceLevelObjective.

  • name: Resource name of the ServiceLevelObjective to delete. The format is:projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME].

func (*ServicesServiceLevelObjectivesService)Getadded inv0.14.0

Get: Get a ServiceLevelObjective by name.

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

func (*ServicesServiceLevelObjectivesService)Listadded inv0.14.0

List: List the ServiceLevelObjectives for the given Service.

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

func (*ServicesServiceLevelObjectivesService)Patchadded inv0.14.0

Patch: Update the given ServiceLevelObjective.

  • name: Identifier. Resource name for this ServiceLevelObjective. The formatis:projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME].

typeSnoozeadded inv0.105.0

type Snooze struct {// Criteria: Required. This defines the criteria for applying the Snooze. See// Criteria for more information.Criteria *Criteria `json:"criteria,omitempty"`// DisplayName: Required. A display name for the Snooze. This can be, at most,// 512 unicode characters.DisplayNamestring `json:"displayName,omitempty"`// Interval: 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.Interval *TimeInterval `json:"interval,omitempty"`// Name: 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.Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Criteria") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Criteria") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Snooze)MarshalJSONadded inv0.105.0

func (sSnooze) MarshalJSON() ([]byte,error)

typeSourceContext

type SourceContext struct {// FileName: The path-qualified name of the .proto file that contained the// associated protobuf element. For example:// "google/protobuf/source_context.proto".FileNamestring `json:"fileName,omitempty"`// ForceSendFields is a list of field names (e.g. "FileName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FileName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SourceContext: SourceContext represents information about the source of aprotobuf element, like the file in which it is defined.

func (SourceContext)MarshalJSON

func (sSourceContext) MarshalJSON() ([]byte,error)

typeSpanContext

type SpanContext struct {// SpanName: 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.SpanNamestring `json:"spanName,omitempty"`// ForceSendFields is a list of field names (e.g. "SpanName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SpanName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SpanContext: The context of a span. This is attached to an Exemplar inDistribution values during aggregation.It contains the name of a span withformat: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]

func (SpanContext)MarshalJSON

func (sSpanContext) MarshalJSON() ([]byte,error)

typeSqlConditionadded inv0.200.0

type SqlCondition struct {// BooleanTest: Test the boolean value in the indicated column.BooleanTest *BooleanTest `json:"booleanTest,omitempty"`// Daily: Schedule the query to execute every so many days.Daily *Daily `json:"daily,omitempty"`// Hourly: Schedule the query to execute every so many hours.Hourly *Hourly `json:"hourly,omitempty"`// Minutes: Schedule the query to execute every so many minutes.Minutes *Minutes `json:"minutes,omitempty"`// Query: 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 NULLQuerystring `json:"query,omitempty"`// RowCountTest: Test the row count against a threshold.RowCountTest *RowCountTest `json:"rowCountTest,omitempty"`// ForceSendFields is a list of field names (e.g. "BooleanTest") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BooleanTest") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (SqlCondition)MarshalJSONadded inv0.200.0

func (sSqlCondition) MarshalJSON() ([]byte,error)

typeStatus

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Status: The Status type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each Status message contains threepieces of data: error code, error message, and error details.You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSON

func (sStatus) MarshalJSON() ([]byte,error)

typeSyntheticMonitorTargetadded inv0.133.0

type SyntheticMonitorTarget struct {// CloudFunctionV2: Target a Synthetic Monitor GCFv2 instance.CloudFunctionV2 *CloudFunctionV2Target `json:"cloudFunctionV2,omitempty"`// ForceSendFields is a list of field names (e.g. "CloudFunctionV2") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CloudFunctionV2") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SyntheticMonitorTarget: Describes a Synthetic Monitor to be invoked byUptime.

func (SyntheticMonitorTarget)MarshalJSONadded inv0.133.0

func (sSyntheticMonitorTarget) MarshalJSON() ([]byte,error)

typeTcpCheck

type TcpCheck struct {// PingConfig: Contains information needed to add pings to a TCP check.PingConfig *PingConfig `json:"pingConfig,omitempty"`// Port: The TCP port on the server against which to run the check. Will be// combined with host (specified within the monitored_resource) to construct// the full URL. Required.Portint64 `json:"port,omitempty"`// ForceSendFields is a list of field names (e.g. "PingConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PingConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TcpCheck: Information required for a TCP Uptime check request.

func (TcpCheck)MarshalJSON

func (sTcpCheck) MarshalJSON() ([]byte,error)

typeTelemetryadded inv0.14.0

type Telemetry struct {// ResourceName: The full name of the resource that defines this service.// Formatted as described in//https://cloud.google.com/apis/design/resource_names.ResourceNamestring `json:"resourceName,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourceName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourceName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Telemetry: Configuration for how to query telemetry on a Service.

func (Telemetry)MarshalJSONadded inv0.14.0

func (sTelemetry) MarshalJSON() ([]byte,error)

typeTimeInterval

type TimeInterval struct {// EndTime: Required. The end of the time interval.EndTimestring `json:"endTime,omitempty"`// StartTime: 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.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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, andshould be no older than the data retention period for the metric. Writes: Aclosed time interval. It extends from the start time to the end time, andincludes both: [startTime, endTime]. Valid time intervals depend on theMetricKind(https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#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 thanfive minutes in the future. For GAUGE metrics, the startTime value istechnically optional; if no value is specified, the start time defaults tothe value of the end time, and the interval represents a single point intime. 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-timemeasurements. The end time of a new interval must be at least a millisecondafter the end time of the previous interval. For DELTA metrics, the starttime and end time must specify a non-zero interval, with subsequent pointsspecifying contiguous and non-overlapping intervals. For DELTA metrics, thestart time of the next interval must be at least a millisecond after the endtime of the previous interval. For CUMULATIVE metrics, the start time andend time must specify a non-zero interval, with subsequent points specifyingthe same start time and increasing end times, until an event resets thecumulative 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 theprevious interval. The start time of a new interval must be at least amillisecond after the end time of the previous interval because intervalsare closed. If the start time of a new interval is the same as the end timeof the previous interval, then data written at the new start time couldoverwrite data written at the previous end time.

func (TimeInterval)MarshalJSON

func (sTimeInterval) MarshalJSON() ([]byte,error)

typeTimeOfDayadded inv0.200.0

type TimeOfDay struct {// Hours: Hours of a day in 24 hour format. Must be greater than or equal to 0// and typically must be less than or equal to 23. An API may choose to allow// the value "24:00:00" for scenarios like business closing time.Hoursint64 `json:"hours,omitempty"`// Minutes: Minutes of an hour. Must be greater than or equal to 0 and less// than or equal to 59.Minutesint64 `json:"minutes,omitempty"`// Nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal// to 0 and less than or equal to 999,999,999.Nanosint64 `json:"nanos,omitempty"`// Seconds: Seconds of a minute. Must be greater than or equal to 0 and// typically must be less than or equal to 59. An API may allow the value 60 if// it allows leap-seconds.Secondsint64 `json:"seconds,omitempty"`// ForceSendFields is a list of field names (e.g. "Hours") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Hours") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TimeOfDay: Represents a time of day. The date and time zone are either notsignificant or are specified elsewhere. An API may choose to allow leapseconds. Related types are google.type.Date and google.protobuf.Timestamp.

func (TimeOfDay)MarshalJSONadded inv0.200.0

func (sTimeOfDay) MarshalJSON() ([]byte,error)

typeTimeSeries

type TimeSeries struct {// Description: 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.Descriptionstring `json:"description,omitempty"`// Metadata: 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.Metadata *MonitoredResourceMetadata `json:"metadata,omitempty"`// Metric: The associated metric. A fully-specified metric used to identify the// time series.Metric *Metric `json:"metric,omitempty"`// 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.//// Possible values://   "METRIC_KIND_UNSPECIFIED" - Do not use this default value.//   "GAUGE" - An instantaneous measurement of a value.//   "DELTA" - The change in a value during a time interval.//   "CUMULATIVE" - A value accumulated over a time interval. Cumulative// measurements in a time series should have the same start time and increasing// end times, until an event resets the cumulative value to zero and sets a new// start time for the following points.MetricKindstring `json:"metricKind,omitempty"`// Points: 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.Points []*Point `json:"points,omitempty"`// Resource: 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// (https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).Resource *MonitoredResource `json:"resource,omitempty"`// Unit: 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.Unitstring `json:"unit,omitempty"`// 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.//// Possible values://   "VALUE_TYPE_UNSPECIFIED" - Do not use this default value.//   "BOOL" - The value is a boolean. This value type can be used only if the// metric kind is GAUGE.//   "INT64" - The value is a signed 64-bit integer.//   "DOUBLE" - The value is a double precision floating point number.//   "STRING" - The value is a text string. This value type can be used only if// the metric kind is GAUGE.//   "DISTRIBUTION" - The value is a Distribution.//   "MONEY" - The value is money.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TimeSeries: A collection of data points that describes the time-varyingvalues of a metric. A time series is identified by a combination of afully-specified monitored resource and a fully-specified metric. This typeis used for both listing and creating time series.

func (TimeSeries)MarshalJSON

func (sTimeSeries) MarshalJSON() ([]byte,error)

typeTimeSeriesDataadded inv0.22.0

type TimeSeriesData struct {// LabelValues: 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.LabelValues []*LabelValue `json:"labelValues,omitempty"`// PointData: The points in the time series.PointData []*PointData `json:"pointData,omitempty"`// ForceSendFields is a list of field names (e.g. "LabelValues") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LabelValues") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TimeSeriesData: Represents the values of a time series associated with aTimeSeriesDescriptor.

func (TimeSeriesData)MarshalJSONadded inv0.22.0

func (sTimeSeriesData) MarshalJSON() ([]byte,error)

typeTimeSeriesDescriptoradded inv0.22.0

type TimeSeriesDescriptor struct {// LabelDescriptors: Descriptors for the labels.LabelDescriptors []*LabelDescriptor `json:"labelDescriptors,omitempty"`// PointDescriptors: Descriptors for the point data value columns.PointDescriptors []*ValueDescriptor `json:"pointDescriptors,omitempty"`// ForceSendFields is a list of field names (e.g. "LabelDescriptors") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LabelDescriptors") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (TimeSeriesDescriptor)MarshalJSONadded inv0.22.0

func (sTimeSeriesDescriptor) MarshalJSON() ([]byte,error)

typeTimeSeriesRatioadded inv0.14.0

type TimeSeriesRatio struct {// BadServiceFilter: 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.BadServiceFilterstring `json:"badServiceFilter,omitempty"`// GoodServiceFilter: 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.GoodServiceFilterstring `json:"goodServiceFilter,omitempty"`// TotalServiceFilter: 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.TotalServiceFilterstring `json:"totalServiceFilter,omitempty"`// ForceSendFields is a list of field names (e.g. "BadServiceFilter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BadServiceFilter") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (TimeSeriesRatio)MarshalJSONadded inv0.14.0

func (sTimeSeriesRatio) MarshalJSON() ([]byte,error)

typeTrigger

type Trigger struct {// Count: The absolute number of time series that must fail the predicate for// the condition to be triggered.Countint64 `json:"count,omitempty"`// Percent: The percentage of time series that must fail the predicate for the// condition to be triggered.Percentfloat64 `json:"percent,omitempty"`// ForceSendFields is a list of field names (e.g. "Count") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Count") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Trigger)MarshalJSON

func (sTrigger) MarshalJSON() ([]byte,error)

func (*Trigger)UnmarshalJSON

func (s *Trigger) UnmarshalJSON(data []byte)error

typeType

type Type struct {// Edition: The source edition string, only valid when syntax is// SYNTAX_EDITIONS.Editionstring `json:"edition,omitempty"`// Fields: The list of fields.Fields []*Field `json:"fields,omitempty"`// Name: The fully qualified message name.Namestring `json:"name,omitempty"`// Oneofs: The list of types appearing in oneof definitions in this type.Oneofs []string `json:"oneofs,omitempty"`// Options: The protocol buffer options.Options []*Option `json:"options,omitempty"`// SourceContext: The source context.SourceContext *SourceContext `json:"sourceContext,omitempty"`// Syntax: The source syntax.//// Possible values://   "SYNTAX_PROTO2" - Syntax proto2.//   "SYNTAX_PROTO3" - Syntax proto3.//   "SYNTAX_EDITIONS" - Syntax editions.Syntaxstring `json:"syntax,omitempty"`// ForceSendFields is a list of field names (e.g. "Edition") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Edition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Type: A protocol buffer message type.New usages of this message as analternative to DescriptorProto are strongly discouraged. This message doesnot reliability preserve all information necessary to model the schema andpreserve semantics. Instead make use of FileDescriptorSet which preservesthe necessary information.

func (Type)MarshalJSON

func (sType) MarshalJSON() ([]byte,error)

typeTypedValue

type TypedValue struct {// BoolValue: A Boolean value: true or false.BoolValue *bool `json:"boolValue,omitempty"`// DistributionValue: A distribution value.DistributionValue *Distribution `json:"distributionValue,omitempty"`// DoubleValue: A 64-bit double-precision floating-point number. Its magnitude// is approximately ±10±300 and it has 16 significant digits of precision.DoubleValue *float64 `json:"doubleValue,omitempty"`// Int64Value: A 64-bit integer. Its range is approximately ±9.2x1018.Int64Value *int64 `json:"int64Value,omitempty,string"`// StringValue: A variable-length string value.StringValue *string `json:"stringValue,omitempty"`// ForceSendFields is a list of field names (e.g. "BoolValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoolValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TypedValue: A single strongly-typed value.

func (TypedValue)MarshalJSON

func (sTypedValue) MarshalJSON() ([]byte,error)

func (*TypedValue)UnmarshalJSON

func (s *TypedValue) UnmarshalJSON(data []byte)error

typeUptimeCheckConfig

type UptimeCheckConfig struct {// CheckerType: The type of checkers to use to execute the Uptime check.//// Possible values://   "CHECKER_TYPE_UNSPECIFIED" - The default checker type. Currently converted// to STATIC_IP_CHECKERS on creation, the default conversion behavior may// change in the future.//   "STATIC_IP_CHECKERS" - STATIC_IP_CHECKERS are used for uptime checks that// perform egress across the public internet. STATIC_IP_CHECKERS use the static// IP addresses returned by ListUptimeCheckIps.//   "VPC_CHECKERS" - VPC_CHECKERS are used for uptime checks that perform// egress using Service Directory and private network access. When using// VPC_CHECKERS, the monitored resource type must be servicedirectory_service.CheckerTypestring `json:"checkerType,omitempty"`// ContentMatchers: 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.ContentMatchers []*ContentMatcher `json:"contentMatchers,omitempty"`// Disabled: Whether the check is disabled or not.Disabledbool `json:"disabled,omitempty"`// DisplayName: A human-friendly name for the Uptime check configuration. The// display name should be unique within a Cloud Monitoring Workspace in order// to make it easier to identify; however, uniqueness is not enforced.// Required.DisplayNamestring `json:"displayName,omitempty"`// HttpCheck: Contains information needed to make an HTTP or HTTPS check.HttpCheck *HttpCheck `json:"httpCheck,omitempty"`// InternalCheckers: 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.InternalCheckers []*InternalChecker `json:"internalCheckers,omitempty"`// IsInternal: 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.IsInternalbool `json:"isInternal,omitempty"`// LogCheckFailures: To specify whether to log the results of failed probes to// Cloud Logging.LogCheckFailuresbool `json:"logCheckFailures,omitempty"`// MonitoredResource: The monitored resource// (https://cloud.google.com/monitoring/api/resources) associated with the// configuration. The following monitored resource types are valid for this// field: uptime_url, gce_instance, gae_app, aws_ec2_instance,// aws_elb_load_balancer k8s_service servicedirectory_service// cloud_run_revisionMonitoredResource *MonitoredResource `json:"monitoredResource,omitempty"`// Name: Identifier. A unique resource name for this Uptime check// configuration. The format is:// projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]// [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the// Uptime check.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.Namestring `json:"name,omitempty"`// Period: 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.Periodstring `json:"period,omitempty"`// ResourceGroup: The group resource associated with the configuration.ResourceGroup *ResourceGroup `json:"resourceGroup,omitempty"`// SelectedRegions: 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.//// Possible values://   "REGION_UNSPECIFIED" - Default value if no region is specified. Will// result in Uptime checks running from all regions.//   "USA" - Allows checks to run from locations within the United States of// America.//   "EUROPE" - Allows checks to run from locations within the continent of// Europe.//   "SOUTH_AMERICA" - Allows checks to run from locations within the continent// of South America.//   "ASIA_PACIFIC" - Allows checks to run from locations within the Asia// Pacific area (ex: Singapore).//   "USA_OREGON" - Allows checks to run from locations within the western// United States of America//   "USA_IOWA" - Allows checks to run from locations within the central United// States of America//   "USA_VIRGINIA" - Allows checks to run from locations within the eastern// United States of AmericaSelectedRegions []string `json:"selectedRegions,omitempty"`// SyntheticMonitor: Specifies a Synthetic Monitor to invoke.SyntheticMonitor *SyntheticMonitorTarget `json:"syntheticMonitor,omitempty"`// TcpCheck: Contains information needed to make a TCP check.TcpCheck *TcpCheck `json:"tcpCheck,omitempty"`// Timeout: The maximum amount of time to wait for the request to complete// (must be between 1 and 60 seconds). Required.Timeoutstring `json:"timeout,omitempty"`// UserLabels: User-supplied key/value data to be used for organizing and// identifying the UptimeCheckConfig 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.UserLabels map[string]string `json:"userLabels,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CheckerType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CheckerType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

UptimeCheckConfig: This message configures which resources and services tomonitor for availability.

func (UptimeCheckConfig)MarshalJSON

func (sUptimeCheckConfig) MarshalJSON() ([]byte,error)

typeUptimeCheckIp

type UptimeCheckIp struct {// IpAddress: 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.IpAddressstring `json:"ipAddress,omitempty"`// Location: 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.Locationstring `json:"location,omitempty"`// Region: A broad region category in which the IP address is located.//// Possible values://   "REGION_UNSPECIFIED" - Default value if no region is specified. Will// result in Uptime checks running from all regions.//   "USA" - Allows checks to run from locations within the United States of// America.//   "EUROPE" - Allows checks to run from locations within the continent of// Europe.//   "SOUTH_AMERICA" - Allows checks to run from locations within the continent// of South America.//   "ASIA_PACIFIC" - Allows checks to run from locations within the Asia// Pacific area (ex: Singapore).//   "USA_OREGON" - Allows checks to run from locations within the western// United States of America//   "USA_IOWA" - Allows checks to run from locations within the central United// States of America//   "USA_VIRGINIA" - Allows checks to run from locations within the eastern// United States of AmericaRegionstring `json:"region,omitempty"`// ForceSendFields is a list of field names (e.g. "IpAddress") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IpAddress") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

UptimeCheckIp: Contains the region, location, and list of IP addresses wherecheckers in the location run from.

func (UptimeCheckIp)MarshalJSON

func (sUptimeCheckIp) MarshalJSON() ([]byte,error)

typeUptimeCheckIpsListCall

type UptimeCheckIpsListCall struct {// contains filtered or unexported fields}

func (*UptimeCheckIpsListCall)Context

Context sets the context to be used in this call's Do method.

func (*UptimeCheckIpsListCall)Do

Do executes the "monitoring.uptimeCheckIps.list" call.Any non-2xx status code is an error. Response headers are in either*ListUptimeCheckIpsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*UptimeCheckIpsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*UptimeCheckIpsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*UptimeCheckIpsListCall)IfNoneMatch

func (c *UptimeCheckIpsListCall) IfNoneMatch(entityTagstring) *UptimeCheckIpsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*UptimeCheckIpsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return in a single response. The server may further constrain themaximum 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: thisfield is not yet implemented

func (*UptimeCheckIpsListCall)PageToken

PageToken sets the optional parameter "pageToken": If this field is notempty then it must contain the nextPageToken value returned by a previouscall to this method. Using this field causes the method to return moreresults from the previous method call. NOTE: this field is not yetimplemented

func (*UptimeCheckIpsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeUptimeCheckIpsService

type UptimeCheckIpsService struct {// contains filtered or unexported fields}

funcNewUptimeCheckIpsService

func NewUptimeCheckIpsService(s *Service) *UptimeCheckIpsService

func (*UptimeCheckIpsService)List

List: Returns the list of IP addresses that checkers run from.

typeValueDescriptoradded inv0.22.0

type ValueDescriptor struct {// Key: The value key.Keystring `json:"key,omitempty"`// MetricKind: The value stream kind.//// Possible values://   "METRIC_KIND_UNSPECIFIED" - Do not use this default value.//   "GAUGE" - An instantaneous measurement of a value.//   "DELTA" - The change in a value during a time interval.//   "CUMULATIVE" - A value accumulated over a time interval. Cumulative// measurements in a time series should have the same start time and increasing// end times, until an event resets the cumulative value to zero and sets a new// start time for the following points.MetricKindstring `json:"metricKind,omitempty"`// Unit: The unit in which time_series point values are reported. unit follows// the UCUM format for units as seen inhttps://unitsofmeasure.org/ucum.html.// unit is only valid if value_type is INTEGER, DOUBLE, DISTRIBUTION.Unitstring `json:"unit,omitempty"`// ValueType: The value type.//// Possible values://   "VALUE_TYPE_UNSPECIFIED" - Do not use this default value.//   "BOOL" - The value is a boolean. This value type can be used only if the// metric kind is GAUGE.//   "INT64" - The value is a signed 64-bit integer.//   "DOUBLE" - The value is a double precision floating point number.//   "STRING" - The value is a text string. This value type can be used only if// the metric kind is GAUGE.//   "DISTRIBUTION" - The value is a Distribution.//   "MONEY" - The value is money.ValueTypestring `json:"valueType,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Key") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ValueDescriptor: A descriptor for the value columns in a data point.

func (ValueDescriptor)MarshalJSONadded inv0.22.0

func (sValueDescriptor) MarshalJSON() ([]byte,error)

typeVerifyNotificationChannelRequest

type VerifyNotificationChannelRequest struct {// Code: 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).Codestring `json:"code,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

VerifyNotificationChannelRequest: The VerifyNotificationChannel request.

func (VerifyNotificationChannelRequest)MarshalJSON

func (sVerifyNotificationChannelRequest) MarshalJSON() ([]byte,error)

typeWindowsBasedSliadded inv0.14.0

type WindowsBasedSli struct {// GoodBadMetricFilter: 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.GoodBadMetricFilterstring `json:"goodBadMetricFilter,omitempty"`// GoodTotalRatioThreshold: A window is good if its performance is high enough.GoodTotalRatioThreshold *PerformanceThreshold `json:"goodTotalRatioThreshold,omitempty"`// MetricMeanInRange: A window is good if the metric's value is in a good// range, averaged across returned streams.MetricMeanInRange *MetricRange `json:"metricMeanInRange,omitempty"`// MetricSumInRange: A window is good if the metric's value is in a good range,// summed across returned streams.MetricSumInRange *MetricRange `json:"metricSumInRange,omitempty"`// WindowPeriod: Duration over which window quality is evaluated. Must be an// integer fraction of a day and at least 60s.WindowPeriodstring `json:"windowPeriod,omitempty"`// ForceSendFields is a list of field names (e.g. "GoodBadMetricFilter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GoodBadMetricFilter") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

WindowsBasedSli: A WindowsBasedSli defines good_service as the count of timewindows for which the provided service was of good quality. Criteria fordetermining if service was good are embedded in the window_criterion.

func (WindowsBasedSli)MarshalJSONadded inv0.14.0

func (sWindowsBasedSli) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp