Enum value maps for AlertPolicy_ConditionCombinerType.
var (
AlertPolicy_ConditionCombinerType_name = map[int32]string{
0: "COMBINE_UNSPECIFIED",
1: "AND",
2: "OR",
3: "AND_WITH_MATCHING_RESOURCE",
}
AlertPolicy_ConditionCombinerType_value = map[string]int32{
"COMBINE_UNSPECIFIED": 0,
"AND": 1,
"OR": 2,
"AND_WITH_MATCHING_RESOURCE": 3,
}
)
Enum value maps for AlertPolicy_Severity.
var (
AlertPolicy_Severity_name = map[int32]string{
0: "SEVERITY_UNSPECIFIED",
1: "CRITICAL",
2: "ERROR",
3: "WARNING",
}
AlertPolicy_Severity_value = map[string]int32{
"SEVERITY_UNSPECIFIED": 0,
"CRITICAL": 1,
"ERROR": 2,
"WARNING": 3,
}
)
Enum value maps for AlertPolicy_Condition_EvaluationMissingData.
var (
AlertPolicy_Condition_EvaluationMissingData_name = map[int32]string{
0: "EVALUATION_MISSING_DATA_UNSPECIFIED",
1: "EVALUATION_MISSING_DATA_INACTIVE",
2: "EVALUATION_MISSING_DATA_ACTIVE",
3: "EVALUATION_MISSING_DATA_NO_OP",
}
AlertPolicy_Condition_EvaluationMissingData_value = map[string]int32{
"EVALUATION_MISSING_DATA_UNSPECIFIED": 0,
"EVALUATION_MISSING_DATA_INACTIVE": 1,
"EVALUATION_MISSING_DATA_ACTIVE": 2,
"EVALUATION_MISSING_DATA_NO_OP": 3,
}
)
Enum value maps for ComparisonType.
var (
ComparisonType_name = map[int32]string{
0: "COMPARISON_UNSPECIFIED",
1: "COMPARISON_GT",
2: "COMPARISON_GE",
3: "COMPARISON_LT",
4: "COMPARISON_LE",
5: "COMPARISON_EQ",
6: "COMPARISON_NE",
}
ComparisonType_value = map[string]int32{
"COMPARISON_UNSPECIFIED": 0,
"COMPARISON_GT": 1,
"COMPARISON_GE": 2,
"COMPARISON_LT": 3,
"COMPARISON_LE": 4,
"COMPARISON_EQ": 5,
"COMPARISON_NE": 6,
}
)
Enum value maps for ServiceTier.
var (
ServiceTier_name = map[int32]string{
0: "SERVICE_TIER_UNSPECIFIED",
1: "SERVICE_TIER_BASIC",
2: "SERVICE_TIER_PREMIUM",
}
ServiceTier_value = map[string]int32{
"SERVICE_TIER_UNSPECIFIED": 0,
"SERVICE_TIER_BASIC": 1,
"SERVICE_TIER_PREMIUM": 2,
}
)
Enum value maps for Aggregation_Aligner.
var (
Aggregation_Aligner_name = map[int32]string{
0: "ALIGN_NONE",
1: "ALIGN_DELTA",
2: "ALIGN_RATE",
3: "ALIGN_INTERPOLATE",
4: "ALIGN_NEXT_OLDER",
10: "ALIGN_MIN",
11: "ALIGN_MAX",
12: "ALIGN_MEAN",
13: "ALIGN_COUNT",
14: "ALIGN_SUM",
15: "ALIGN_STDDEV",
16: "ALIGN_COUNT_TRUE",
24: "ALIGN_COUNT_FALSE",
17: "ALIGN_FRACTION_TRUE",
18: "ALIGN_PERCENTILE_99",
19: "ALIGN_PERCENTILE_95",
20: "ALIGN_PERCENTILE_50",
21: "ALIGN_PERCENTILE_05",
23: "ALIGN_PERCENT_CHANGE",
}
Aggregation_Aligner_value = map[string]int32{
"ALIGN_NONE": 0,
"ALIGN_DELTA": 1,
"ALIGN_RATE": 2,
"ALIGN_INTERPOLATE": 3,
"ALIGN_NEXT_OLDER": 4,
"ALIGN_MIN": 10,
"ALIGN_MAX": 11,
"ALIGN_MEAN": 12,
"ALIGN_COUNT": 13,
"ALIGN_SUM": 14,
"ALIGN_STDDEV": 15,
"ALIGN_COUNT_TRUE": 16,
"ALIGN_COUNT_FALSE": 24,
"ALIGN_FRACTION_TRUE": 17,
"ALIGN_PERCENTILE_99": 18,
"ALIGN_PERCENTILE_95": 19,
"ALIGN_PERCENTILE_50": 20,
"ALIGN_PERCENTILE_05": 21,
"ALIGN_PERCENT_CHANGE": 23,
}
)
Enum value maps for Aggregation_Reducer.
var (
Aggregation_Reducer_name = map[int32]string{
0: "REDUCE_NONE",
1: "REDUCE_MEAN",
2: "REDUCE_MIN",
3: "REDUCE_MAX",
4: "REDUCE_SUM",
5: "REDUCE_STDDEV",
6: "REDUCE_COUNT",
7: "REDUCE_COUNT_TRUE",
15: "REDUCE_COUNT_FALSE",
8: "REDUCE_FRACTION_TRUE",
9: "REDUCE_PERCENTILE_99",
10: "REDUCE_PERCENTILE_95",
11: "REDUCE_PERCENTILE_50",
12: "REDUCE_PERCENTILE_05",
}
Aggregation_Reducer_value = map[string]int32{
"REDUCE_NONE": 0,
"REDUCE_MEAN": 1,
"REDUCE_MIN": 2,
"REDUCE_MAX": 3,
"REDUCE_SUM": 4,
"REDUCE_STDDEV": 5,
"REDUCE_COUNT": 6,
"REDUCE_COUNT_TRUE": 7,
"REDUCE_COUNT_FALSE": 15,
"REDUCE_FRACTION_TRUE": 8,
"REDUCE_PERCENTILE_99": 9,
"REDUCE_PERCENTILE_95": 10,
"REDUCE_PERCENTILE_50": 11,
"REDUCE_PERCENTILE_05": 12,
}
)
Enum value maps for ListTimeSeriesRequest_TimeSeriesView.
var (
ListTimeSeriesRequest_TimeSeriesView_name = map[int32]string{
0: "FULL",
1: "HEADERS",
}
ListTimeSeriesRequest_TimeSeriesView_value = map[string]int32{
"FULL": 0,
"HEADERS": 1,
}
)
Enum value maps for NotificationChannel_VerificationStatus.
var (
NotificationChannel_VerificationStatus_name = map[int32]string{
0: "VERIFICATION_STATUS_UNSPECIFIED",
1: "UNVERIFIED",
2: "VERIFIED",
}
NotificationChannel_VerificationStatus_value = map[string]int32{
"VERIFICATION_STATUS_UNSPECIFIED": 0,
"UNVERIFIED": 1,
"VERIFIED": 2,
}
)
Enum value maps for ServiceLevelObjective_View.
var (
ServiceLevelObjective_View_name = map[int32]string{
0: "VIEW_UNSPECIFIED",
2: "FULL",
1: "EXPLICIT",
}
ServiceLevelObjective_View_value = map[string]int32{
"VIEW_UNSPECIFIED": 0,
"FULL": 2,
"EXPLICIT": 1,
}
)
Enum value maps for UptimeCheckRegion.
var (
UptimeCheckRegion_name = map[int32]string{
0: "REGION_UNSPECIFIED",
1: "USA",
2: "EUROPE",
3: "SOUTH_AMERICA",
4: "ASIA_PACIFIC",
5: "USA_OREGON",
6: "USA_IOWA",
7: "USA_VIRGINIA",
}
UptimeCheckRegion_value = map[string]int32{
"REGION_UNSPECIFIED": 0,
"USA": 1,
"EUROPE": 2,
"SOUTH_AMERICA": 3,
"ASIA_PACIFIC": 4,
"USA_OREGON": 5,
"USA_IOWA": 6,
"USA_VIRGINIA": 7,
}
)
Enum value maps for GroupResourceType.
var (
GroupResourceType_name = map[int32]string{
0: "RESOURCE_TYPE_UNSPECIFIED",
1: "INSTANCE",
2: "AWS_ELB_LOAD_BALANCER",
}
GroupResourceType_value = map[string]int32{
"RESOURCE_TYPE_UNSPECIFIED": 0,
"INSTANCE": 1,
"AWS_ELB_LOAD_BALANCER": 2,
}
)
Enum value maps for InternalChecker_State.
var (
InternalChecker_State_name = map[int32]string{
0: "UNSPECIFIED",
1: "CREATING",
2: "RUNNING",
}
InternalChecker_State_value = map[string]int32{
"UNSPECIFIED": 0,
"CREATING": 1,
"RUNNING": 2,
}
)
Enum value maps for UptimeCheckConfig_CheckerType.
var (
UptimeCheckConfig_CheckerType_name = map[int32]string{
0: "CHECKER_TYPE_UNSPECIFIED",
1: "STATIC_IP_CHECKERS",
3: "VPC_CHECKERS",
}
UptimeCheckConfig_CheckerType_value = map[string]int32{
"CHECKER_TYPE_UNSPECIFIED": 0,
"STATIC_IP_CHECKERS": 1,
"VPC_CHECKERS": 3,
}
)
Enum value maps for UptimeCheckConfig_HttpCheck_RequestMethod.
var (
UptimeCheckConfig_HttpCheck_RequestMethod_name = map[int32]string{
0: "METHOD_UNSPECIFIED",
1: "GET",
2: "POST",
}
UptimeCheckConfig_HttpCheck_RequestMethod_value = map[string]int32{
"METHOD_UNSPECIFIED": 0,
"GET": 1,
"POST": 2,
}
)
Enum value maps for UptimeCheckConfig_HttpCheck_ContentType.
var (
UptimeCheckConfig_HttpCheck_ContentType_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "URL_ENCODED",
2: "USER_PROVIDED",
}
UptimeCheckConfig_HttpCheck_ContentType_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"URL_ENCODED": 1,
"USER_PROVIDED": 2,
}
)
Enum value maps for UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass.
var (
UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass_name = map[int32]string{
0: "STATUS_CLASS_UNSPECIFIED",
100: "STATUS_CLASS_1XX",
200: "STATUS_CLASS_2XX",
300: "STATUS_CLASS_3XX",
400: "STATUS_CLASS_4XX",
500: "STATUS_CLASS_5XX",
1000: "STATUS_CLASS_ANY",
}
UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass_value = map[string]int32{
"STATUS_CLASS_UNSPECIFIED": 0,
"STATUS_CLASS_1XX": 100,
"STATUS_CLASS_2XX": 200,
"STATUS_CLASS_3XX": 300,
"STATUS_CLASS_4XX": 400,
"STATUS_CLASS_5XX": 500,
"STATUS_CLASS_ANY": 1000,
}
)
Enum value maps for UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType.
var (
UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType_name = map[int32]string{
0: "SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED",
1: "OIDC_TOKEN",
}
UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType_value = map[string]int32{
"SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED": 0,
"OIDC_TOKEN": 1,
}
)
Enum value maps for UptimeCheckConfig_ContentMatcher_ContentMatcherOption.
var (
UptimeCheckConfig_ContentMatcher_ContentMatcherOption_name = map[int32]string{
0: "CONTENT_MATCHER_OPTION_UNSPECIFIED",
1: "CONTAINS_STRING",
2: "NOT_CONTAINS_STRING",
3: "MATCHES_REGEX",
4: "NOT_MATCHES_REGEX",
5: "MATCHES_JSON_PATH",
6: "NOT_MATCHES_JSON_PATH",
}
UptimeCheckConfig_ContentMatcher_ContentMatcherOption_value = map[string]int32{
"CONTENT_MATCHER_OPTION_UNSPECIFIED": 0,
"CONTAINS_STRING": 1,
"NOT_CONTAINS_STRING": 2,
"MATCHES_REGEX": 3,
"NOT_MATCHES_REGEX": 4,
"MATCHES_JSON_PATH": 5,
"NOT_MATCHES_JSON_PATH": 6,
}
)
Enum value maps for UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption.
var (
UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption_name = map[int32]string{
0: "JSON_PATH_MATCHER_OPTION_UNSPECIFIED",
1: "EXACT_MATCH",
2: "REGEX_MATCH",
}
UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption_value = map[string]int32{
"JSON_PATH_MATCHER_OPTION_UNSPECIFIED": 0,
"EXACT_MATCH": 1,
"REGEX_MATCH": 2,
}
)
var File_google_monitoring_v3_alert_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_alert_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_common_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_dropped_labels_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_group_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_group_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_metric_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_metric_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_mutation_record_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_notification_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_notification_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_query_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_service_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_snooze_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_snooze_service_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_span_context_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_uptime_proto protoreflect.FileDescriptor
var File_google_monitoring_v3_uptime_service_proto protoreflect.FileDescriptor
func RegisterAlertPolicyServiceServer(s *grpc.Server, srv AlertPolicyServiceServer)
func RegisterGroupServiceServer(s *grpc.Server, srv GroupServiceServer)
func RegisterMetricServiceServer(s *grpc.Server, srv MetricServiceServer)
func RegisterNotificationChannelServiceServer(s *grpc.Server, srv NotificationChannelServiceServer)
func RegisterQueryServiceServer(s *grpc.Server, srv QueryServiceServer)
func RegisterServiceMonitoringServiceServer(s *grpc.Server, srv ServiceMonitoringServiceServer)
func RegisterSnoozeServiceServer(s *grpc.Server, srv SnoozeServiceServer)
func RegisterUptimeCheckServiceServer(s *grpc.Server, srv UptimeCheckServiceServer)
Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is _aligned_ to the same time interval boundaries, then the set of time series is optionally _reduced_ in number.
Alignment consists of applying the `per_series_aligner` operation to each time series after its data has been divided into regular `alignment_period` time intervals. This process takes _all_ of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.
Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a `cross_series_reducer` to all the time series, optionally sorting the time series into subsets with `group_by_fields`, and applying the reducer to each subset.
The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see [Filtering and aggregation](https://cloud.google.com/monitoring/api/v3/aggregation).
type Aggregation struct {
// The `alignment_period` specifies a time interval, in seconds, that is used
// to divide the data in all the
// [time series][google.monitoring.v3.TimeSeries] into consistent blocks of
// time. This will be done before the per-series aligner can be applied to
// the data.
//
// The value must be at least 60 seconds. If a per-series
// aligner other than `ALIGN_NONE` is specified, this field is required or an
// error is returned. If no per-series aligner is specified, or the aligner
// `ALIGN_NONE` is specified, then this field is ignored.
//
// The maximum value of the `alignment_period` is 104 weeks (2 years) for
// charts, and 90,000 seconds (25 hours) for alerting policies.
AlignmentPeriod *durationpb.Duration `protobuf:"bytes,1,opt,name=alignment_period,json=alignmentPeriod,proto3" json:"alignment_period,omitempty"`
// 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.
PerSeriesAligner Aggregation_Aligner `protobuf:"varint,2,opt,name=per_series_aligner,json=perSeriesAligner,proto3,enum=google.monitoring.v3.Aggregation_Aligner" json:"per_series_aligner,omitempty"`
// 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.
CrossSeriesReducer Aggregation_Reducer `protobuf:"varint,4,opt,name=cross_series_reducer,json=crossSeriesReducer,proto3,enum=google.monitoring.v3.Aggregation_Reducer" json:"cross_series_reducer,omitempty"`
// 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 `protobuf:"bytes,5,rep,name=group_by_fields,json=groupByFields,proto3" json:"group_by_fields,omitempty"`
// contains filtered or unexported fields
}
func (*Aggregation) Descriptor() ([]byte, []int)
Deprecated: Use Aggregation.ProtoReflect.Descriptor instead.
func (x *Aggregation) GetAlignmentPeriod() *durationpb.Duration
func (x *Aggregation) GetCrossSeriesReducer() Aggregation_Reducer
func (x *Aggregation) GetGroupByFields() []string
func (x *Aggregation) GetPerSeriesAligner() Aggregation_Aligner
func (*Aggregation) ProtoMessage()
func (x *Aggregation) ProtoReflect() protoreflect.Message
func (x *Aggregation) Reset()
func (x *Aggregation) String() string
The `Aligner` specifies the operation that will be applied to the data points in each alignment period in a time series. Except for `ALIGN_NONE`, which specifies that no operation be applied, each alignment operation replaces the set of data values in each alignment period with a single value: the result of applying the operation to the data values. An aligned time series has a single data value at the end of each `alignment_period`.
An alignment operation can change the data type of the values, too. For example, if you apply a counting operation to boolean values, the data `value_type` in the original time series is `BOOLEAN`, but the `value_type` in the aligned result is `INT64`.
type Aggregation_Aligner int32
const (
// 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.
Aggregation_ALIGN_NONE Aggregation_Aligner = 0
// Align and convert to
// [DELTA][google.api.MetricDescriptor.MetricKind.DELTA].
// The output is `delta = y1 - y0`.
//
// This alignment is valid for
// [CUMULATIVE][google.api.MetricDescriptor.MetricKind.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.
Aggregation_ALIGN_DELTA Aggregation_Aligner = 1
// 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.
Aggregation_ALIGN_RATE Aggregation_Aligner = 2
// 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.
Aggregation_ALIGN_INTERPOLATE Aggregation_Aligner = 3
// 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.
Aggregation_ALIGN_NEXT_OLDER Aggregation_Aligner = 4
// 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.
Aggregation_ALIGN_MIN Aggregation_Aligner = 10
// 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.
Aggregation_ALIGN_MAX Aggregation_Aligner = 11
// 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`.
Aggregation_ALIGN_MEAN Aggregation_Aligner = 12
// 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`.
Aggregation_ALIGN_COUNT Aggregation_Aligner = 13
// 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.
Aggregation_ALIGN_SUM Aggregation_Aligner = 14
// 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`.
Aggregation_ALIGN_STDDEV Aggregation_Aligner = 15
// 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`.
Aggregation_ALIGN_COUNT_TRUE Aggregation_Aligner = 16
// 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`.
Aggregation_ALIGN_COUNT_FALSE Aggregation_Aligner = 24
// 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`.
Aggregation_ALIGN_FRACTION_TRUE Aggregation_Aligner = 17
// 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`.
Aggregation_ALIGN_PERCENTILE_99 Aggregation_Aligner = 18
// 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`.
Aggregation_ALIGN_PERCENTILE_95 Aggregation_Aligner = 19
// 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`.
Aggregation_ALIGN_PERCENTILE_50 Aggregation_Aligner = 20
// 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`.
Aggregation_ALIGN_PERCENTILE_05 Aggregation_Aligner = 21
// 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`.
Aggregation_ALIGN_PERCENT_CHANGE Aggregation_Aligner = 23
)
func (Aggregation_Aligner) Descriptor() protoreflect.EnumDescriptor
func (x Aggregation_Aligner) Enum() *Aggregation_Aligner
func (Aggregation_Aligner) EnumDescriptor() ([]byte, []int)
Deprecated: Use Aggregation_Aligner.Descriptor instead.
func (x Aggregation_Aligner) Number() protoreflect.EnumNumber
func (x Aggregation_Aligner) String() string
func (Aggregation_Aligner) Type() protoreflect.EnumType
A Reducer operation describes how to aggregate data points from multiple 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.
type Aggregation_Reducer int32
const (
// No cross-time series reduction. The output of the `Aligner` is
// returned.
Aggregation_REDUCE_NONE Aggregation_Reducer = 0
// Reduce by computing the mean value across time series for each
// alignment period. This reducer is valid for
// [DELTA][google.api.MetricDescriptor.MetricKind.DELTA] and
// [GAUGE][google.api.MetricDescriptor.MetricKind.GAUGE] metrics with
// numeric or distribution values. The `value_type` of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_REDUCE_MEAN Aggregation_Reducer = 1
// 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.
Aggregation_REDUCE_MIN Aggregation_Reducer = 2
// 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.
Aggregation_REDUCE_MAX Aggregation_Reducer = 3
// 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.
Aggregation_REDUCE_SUM Aggregation_Reducer = 4
// 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`.
Aggregation_REDUCE_STDDEV Aggregation_Reducer = 5
// 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`.
Aggregation_REDUCE_COUNT Aggregation_Reducer = 6
// 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`.
Aggregation_REDUCE_COUNT_TRUE Aggregation_Reducer = 7
// 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`.
Aggregation_REDUCE_COUNT_FALSE Aggregation_Reducer = 15
// 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`.
Aggregation_REDUCE_FRACTION_TRUE Aggregation_Reducer = 8
// 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`.
Aggregation_REDUCE_PERCENTILE_99 Aggregation_Reducer = 9
// 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`.
Aggregation_REDUCE_PERCENTILE_95 Aggregation_Reducer = 10
// 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`.
Aggregation_REDUCE_PERCENTILE_50 Aggregation_Reducer = 11
// 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`.
Aggregation_REDUCE_PERCENTILE_05 Aggregation_Reducer = 12
)
func (Aggregation_Reducer) Descriptor() protoreflect.EnumDescriptor
func (x Aggregation_Reducer) Enum() *Aggregation_Reducer
func (Aggregation_Reducer) EnumDescriptor() ([]byte, []int)
Deprecated: Use Aggregation_Reducer.Descriptor instead.
func (x Aggregation_Reducer) Number() protoreflect.EnumNumber
func (x Aggregation_Reducer) String() string
func (Aggregation_Reducer) Type() protoreflect.EnumType
A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see [Introduction to Alerting](https://cloud.google.com/monitoring/alerts/).
type AlertPolicy struct {
// 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][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
// method, do not include the `name` field in the alerting policy passed as
// part of the request.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// 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 *AlertPolicy_Documentation `protobuf:"bytes,13,opt,name=documentation,proto3" json:"documentation,omitempty"`
// 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 `protobuf:"bytes,16,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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 []*AlertPolicy_Condition `protobuf:"bytes,12,rep,name=conditions,proto3" json:"conditions,omitempty"`
// 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`.
Combiner AlertPolicy_ConditionCombinerType `protobuf:"varint,6,opt,name=combiner,proto3,enum=google.monitoring.v3.AlertPolicy_ConditionCombinerType" json:"combiner,omitempty"`
// 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.
Enabled *wrapperspb.BoolValue `protobuf:"bytes,17,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Read-only description of how the alert policy is invalid. This field is
// only set when the alert policy is invalid. An invalid alert policy will not
// generate incidents.
Validity *status.Status `protobuf:"bytes,18,opt,name=validity,proto3" json:"validity,omitempty"`
// Identifies the notification channels to which notifications should be sent
// when incidents are opened or closed or when new violations occur on
// an already opened incident. Each element of this array corresponds to
// the `name` field in each of the
// [`NotificationChannel`][google.monitoring.v3.NotificationChannel]
// objects that are returned from the [`ListNotificationChannels`]
// [google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
// method. The format of the entries in this field is:
//
// projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
NotificationChannels []string `protobuf:"bytes,14,rep,name=notification_channels,json=notificationChannels,proto3" json:"notification_channels,omitempty"`
// 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 `protobuf:"bytes,10,opt,name=creation_record,json=creationRecord,proto3" json:"creation_record,omitempty"`
// 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 `protobuf:"bytes,11,opt,name=mutation_record,json=mutationRecord,proto3" json:"mutation_record,omitempty"`
// Control over how this alert policy's notification channels are notified.
AlertStrategy *AlertPolicy_AlertStrategy `protobuf:"bytes,21,opt,name=alert_strategy,json=alertStrategy,proto3" json:"alert_strategy,omitempty"`
// Optional. The severity of an alert policy indicates how important incidents
// generated by that policy are. The severity level will be displayed on the
// Incident detail page and in notifications.
Severity AlertPolicy_Severity `protobuf:"varint,22,opt,name=severity,proto3,enum=google.monitoring.v3.AlertPolicy_Severity" json:"severity,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy.ProtoReflect.Descriptor instead.
func (x *AlertPolicy) GetAlertStrategy() *AlertPolicy_AlertStrategy
func (x *AlertPolicy) GetCombiner() AlertPolicy_ConditionCombinerType
func (x *AlertPolicy) GetConditions() []*AlertPolicy_Condition
func (x *AlertPolicy) GetCreationRecord() *MutationRecord
func (x *AlertPolicy) GetDisplayName() string
func (x *AlertPolicy) GetDocumentation() *AlertPolicy_Documentation
func (x *AlertPolicy) GetEnabled() *wrapperspb.BoolValue
func (x *AlertPolicy) GetMutationRecord() *MutationRecord
func (x *AlertPolicy) GetName() string
func (x *AlertPolicy) GetNotificationChannels() []string
func (x *AlertPolicy) GetSeverity() AlertPolicy_Severity
func (x *AlertPolicy) GetUserLabels() map[string]string
func (x *AlertPolicy) GetValidity() *status.Status
func (*AlertPolicy) ProtoMessage()
func (x *AlertPolicy) ProtoReflect() protoreflect.Message
func (x *AlertPolicy) Reset()
func (x *AlertPolicy) String() string
AlertPolicyServiceClient is the client API for AlertPolicyService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type AlertPolicyServiceClient interface {
// Lists the existing alerting policies for the workspace.
ListAlertPolicies(ctx context.Context, in *ListAlertPoliciesRequest, opts ...grpc.CallOption) (*ListAlertPoliciesResponse, error)
// Gets a single alerting policy.
GetAlertPolicy(ctx context.Context, in *GetAlertPolicyRequest, opts ...grpc.CallOption) (*AlertPolicy, error)
// Creates a new alerting policy.
//
// Design your application to single-thread API calls that modify the state of
// alerting policies in a single project. This includes calls to
// CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
CreateAlertPolicy(ctx context.Context, in *CreateAlertPolicyRequest, opts ...grpc.CallOption) (*AlertPolicy, error)
// Deletes an alerting policy.
//
// Design your application to single-thread API calls that modify the state of
// alerting policies in a single project. This includes calls to
// CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
DeleteAlertPolicy(ctx context.Context, in *DeleteAlertPolicyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates an alerting policy. You can either replace the entire policy with
// a new one or replace only certain fields in the current alerting policy by
// specifying the fields to be updated via `updateMask`. Returns the
// updated alerting policy.
//
// Design your application to single-thread API calls that modify the state of
// alerting policies in a single project. This includes calls to
// CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
UpdateAlertPolicy(ctx context.Context, in *UpdateAlertPolicyRequest, opts ...grpc.CallOption) (*AlertPolicy, error)
}
func NewAlertPolicyServiceClient(cc grpc.ClientConnInterface) AlertPolicyServiceClient
AlertPolicyServiceServer is the server API for AlertPolicyService service.
type AlertPolicyServiceServer interface {
// Lists the existing alerting policies for the workspace.
ListAlertPolicies(context.Context, *ListAlertPoliciesRequest) (*ListAlertPoliciesResponse, error)
// Gets a single alerting policy.
GetAlertPolicy(context.Context, *GetAlertPolicyRequest) (*AlertPolicy, error)
// Creates a new alerting policy.
//
// Design your application to single-thread API calls that modify the state of
// alerting policies in a single project. This includes calls to
// CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
CreateAlertPolicy(context.Context, *CreateAlertPolicyRequest) (*AlertPolicy, error)
// Deletes an alerting policy.
//
// Design your application to single-thread API calls that modify the state of
// alerting policies in a single project. This includes calls to
// CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
DeleteAlertPolicy(context.Context, *DeleteAlertPolicyRequest) (*emptypb.Empty, error)
// Updates an alerting policy. You can either replace the entire policy with
// a new one or replace only certain fields in the current alerting policy by
// specifying the fields to be updated via `updateMask`. Returns the
// updated alerting policy.
//
// Design your application to single-thread API calls that modify the state of
// alerting policies in a single project. This includes calls to
// CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
UpdateAlertPolicy(context.Context, *UpdateAlertPolicyRequest) (*AlertPolicy, error)
}
Control over how the notification channels in `notification_channels` are notified when this alert fires.
type AlertPolicy_AlertStrategy struct {
// Required for alert policies with a `LogMatch` condition.
//
// This limit is not implemented for alert policies that are not log-based.
NotificationRateLimit *AlertPolicy_AlertStrategy_NotificationRateLimit `protobuf:"bytes,1,opt,name=notification_rate_limit,json=notificationRateLimit,proto3" json:"notification_rate_limit,omitempty"`
// If an alert policy that was active has no data for this long, any open
// incidents will close
AutoClose *durationpb.Duration `protobuf:"bytes,3,opt,name=auto_close,json=autoClose,proto3" json:"auto_close,omitempty"`
// Control how notifications will be sent out, on a per-channel basis.
NotificationChannelStrategy []*AlertPolicy_AlertStrategy_NotificationChannelStrategy `protobuf:"bytes,4,rep,name=notification_channel_strategy,json=notificationChannelStrategy,proto3" json:"notification_channel_strategy,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_AlertStrategy) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_AlertStrategy.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_AlertStrategy) GetAutoClose() *durationpb.Duration
func (x *AlertPolicy_AlertStrategy) GetNotificationChannelStrategy() []*AlertPolicy_AlertStrategy_NotificationChannelStrategy
func (x *AlertPolicy_AlertStrategy) GetNotificationRateLimit() *AlertPolicy_AlertStrategy_NotificationRateLimit
func (*AlertPolicy_AlertStrategy) ProtoMessage()
func (x *AlertPolicy_AlertStrategy) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_AlertStrategy) Reset()
func (x *AlertPolicy_AlertStrategy) String() string
Control over how the notification channels in `notification_channels` are notified when this alert fires, on a per-channel basis.
type AlertPolicy_AlertStrategy_NotificationChannelStrategy struct {
// 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 `protobuf:"bytes,1,rep,name=notification_channel_names,json=notificationChannelNames,proto3" json:"notification_channel_names,omitempty"`
// The frequency at which to send reminder notifications for open
// incidents.
RenotifyInterval *durationpb.Duration `protobuf:"bytes,2,opt,name=renotify_interval,json=renotifyInterval,proto3" json:"renotify_interval,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_AlertStrategy_NotificationChannelStrategy) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_AlertStrategy_NotificationChannelStrategy.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_AlertStrategy_NotificationChannelStrategy) GetNotificationChannelNames() []string
func (x *AlertPolicy_AlertStrategy_NotificationChannelStrategy) GetRenotifyInterval() *durationpb.Duration
func (*AlertPolicy_AlertStrategy_NotificationChannelStrategy) ProtoMessage()
func (x *AlertPolicy_AlertStrategy_NotificationChannelStrategy) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_AlertStrategy_NotificationChannelStrategy) Reset()
func (x *AlertPolicy_AlertStrategy_NotificationChannelStrategy) String() string
Control over the rate of notifications sent to this alert policy's notification channels.
type AlertPolicy_AlertStrategy_NotificationRateLimit struct {
// Not more than one notification per `period`.
Period *durationpb.Duration `protobuf:"bytes,1,opt,name=period,proto3" json:"period,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_AlertStrategy_NotificationRateLimit) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_AlertStrategy_NotificationRateLimit.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_AlertStrategy_NotificationRateLimit) GetPeriod() *durationpb.Duration
func (*AlertPolicy_AlertStrategy_NotificationRateLimit) ProtoMessage()
func (x *AlertPolicy_AlertStrategy_NotificationRateLimit) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_AlertStrategy_NotificationRateLimit) Reset()
func (x *AlertPolicy_AlertStrategy_NotificationRateLimit) String() string
A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.
type AlertPolicy_Condition struct {
// Required if the condition exists. The unique resource name for this
// condition. Its format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
//
// `[CONDITION_ID]` is assigned by Cloud Monitoring when the
// condition is created as part of a new or updated alerting policy.
//
// When calling the
// [alertPolicies.create][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
// 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][google.monitoring.v3.AlertPolicyService.UpdateAlertPolicy]
// 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.
Name string `protobuf:"bytes,12,opt,name=name,proto3" json:"name,omitempty"`
// 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.
DisplayName string `protobuf:"bytes,6,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Only one of the following condition types will be specified.
//
// Types that are assignable to Condition:
//
// *AlertPolicy_Condition_ConditionThreshold
// *AlertPolicy_Condition_ConditionAbsent
// *AlertPolicy_Condition_ConditionMatchedLog
// *AlertPolicy_Condition_ConditionMonitoringQueryLanguage
// *AlertPolicy_Condition_ConditionPrometheusQueryLanguage
Condition isAlertPolicy_Condition_Condition `protobuf_oneof:"condition"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition.ProtoReflect.Descriptor instead.
func (m *AlertPolicy_Condition) GetCondition() isAlertPolicy_Condition_Condition
func (x *AlertPolicy_Condition) GetConditionAbsent() *AlertPolicy_Condition_MetricAbsence
func (x *AlertPolicy_Condition) GetConditionMatchedLog() *AlertPolicy_Condition_LogMatch
func (x *AlertPolicy_Condition) GetConditionMonitoringQueryLanguage() *AlertPolicy_Condition_MonitoringQueryLanguageCondition
func (x *AlertPolicy_Condition) GetConditionPrometheusQueryLanguage() *AlertPolicy_Condition_PrometheusQueryLanguageCondition
func (x *AlertPolicy_Condition) GetConditionThreshold() *AlertPolicy_Condition_MetricThreshold
func (x *AlertPolicy_Condition) GetDisplayName() string
func (x *AlertPolicy_Condition) GetName() string
func (*AlertPolicy_Condition) ProtoMessage()
func (x *AlertPolicy_Condition) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition) Reset()
func (x *AlertPolicy_Condition) String() string
Operators for combining conditions.
type AlertPolicy_ConditionCombinerType int32
const (
// An unspecified combiner.
AlertPolicy_COMBINE_UNSPECIFIED AlertPolicy_ConditionCombinerType = 0
// 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.
AlertPolicy_AND AlertPolicy_ConditionCombinerType = 1
// Combine conditions using the logical `OR` operator. An incident
// is created if any of the listed conditions is met.
AlertPolicy_OR AlertPolicy_ConditionCombinerType = 2
// 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.
AlertPolicy_AND_WITH_MATCHING_RESOURCE AlertPolicy_ConditionCombinerType = 3
)
func (AlertPolicy_ConditionCombinerType) Descriptor() protoreflect.EnumDescriptor
func (x AlertPolicy_ConditionCombinerType) Enum() *AlertPolicy_ConditionCombinerType
func (AlertPolicy_ConditionCombinerType) EnumDescriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_ConditionCombinerType.Descriptor instead.
func (x AlertPolicy_ConditionCombinerType) Number() protoreflect.EnumNumber
func (x AlertPolicy_ConditionCombinerType) String() string
func (AlertPolicy_ConditionCombinerType) Type() protoreflect.EnumType
type AlertPolicy_Condition_ConditionAbsent struct {
// A condition that checks that a time series continues to
// receive new data points.
ConditionAbsent *AlertPolicy_Condition_MetricAbsence `protobuf:"bytes,2,opt,name=condition_absent,json=conditionAbsent,proto3,oneof"`
}
type AlertPolicy_Condition_ConditionMatchedLog struct {
// A condition that checks for log messages matching given constraints. If
// set, no other conditions can be present.
ConditionMatchedLog *AlertPolicy_Condition_LogMatch `protobuf:"bytes,20,opt,name=condition_matched_log,json=conditionMatchedLog,proto3,oneof"`
}
type AlertPolicy_Condition_ConditionMonitoringQueryLanguage struct {
// A condition that uses the Monitoring Query Language to define
// alerts.
ConditionMonitoringQueryLanguage *AlertPolicy_Condition_MonitoringQueryLanguageCondition `protobuf:"bytes,19,opt,name=condition_monitoring_query_language,json=conditionMonitoringQueryLanguage,proto3,oneof"`
}
type AlertPolicy_Condition_ConditionPrometheusQueryLanguage struct {
// A condition that uses the Prometheus query language to define alerts.
ConditionPrometheusQueryLanguage *AlertPolicy_Condition_PrometheusQueryLanguageCondition `protobuf:"bytes,21,opt,name=condition_prometheus_query_language,json=conditionPrometheusQueryLanguage,proto3,oneof"`
}
type AlertPolicy_Condition_ConditionThreshold struct {
// A condition that compares a time series against a threshold.
ConditionThreshold *AlertPolicy_Condition_MetricThreshold `protobuf:"bytes,1,opt,name=condition_threshold,json=conditionThreshold,proto3,oneof"`
}
A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. This control doesn't affect metric-absence policies.
type AlertPolicy_Condition_EvaluationMissingData int32
const (
// An unspecified evaluation missing data option. Equivalent to
// EVALUATION_MISSING_DATA_NO_OP.
AlertPolicy_Condition_EVALUATION_MISSING_DATA_UNSPECIFIED AlertPolicy_Condition_EvaluationMissingData = 0
// If there is no data to evaluate the condition, then evaluate the
// condition as false.
AlertPolicy_Condition_EVALUATION_MISSING_DATA_INACTIVE AlertPolicy_Condition_EvaluationMissingData = 1
// If there is no data to evaluate the condition, then evaluate the
// condition as true.
AlertPolicy_Condition_EVALUATION_MISSING_DATA_ACTIVE AlertPolicy_Condition_EvaluationMissingData = 2
// Do not evaluate the condition to any value if there is no data.
AlertPolicy_Condition_EVALUATION_MISSING_DATA_NO_OP AlertPolicy_Condition_EvaluationMissingData = 3
)
func (AlertPolicy_Condition_EvaluationMissingData) Descriptor() protoreflect.EnumDescriptor
func (x AlertPolicy_Condition_EvaluationMissingData) Enum() *AlertPolicy_Condition_EvaluationMissingData
func (AlertPolicy_Condition_EvaluationMissingData) EnumDescriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_EvaluationMissingData.Descriptor instead.
func (x AlertPolicy_Condition_EvaluationMissingData) Number() protoreflect.EnumNumber
func (x AlertPolicy_Condition_EvaluationMissingData) String() string
func (AlertPolicy_Condition_EvaluationMissingData) Type() protoreflect.EnumType
A condition type that checks whether a log message in the [scoping project](https://cloud.google.com/monitoring/api/v3#project_name) satisfies the given filter. Logs from other projects in the metrics scope are not evaluated.
type AlertPolicy_Condition_LogMatch struct {
// 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.
Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
// 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
// `valueExtractor`s](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric.FIELDS.value_extractor)
// for syntax and examples.
LabelExtractors map[string]string `protobuf:"bytes,2,rep,name=label_extractors,json=labelExtractors,proto3" json:"label_extractors,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition_LogMatch) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_LogMatch.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Condition_LogMatch) GetFilter() string
func (x *AlertPolicy_Condition_LogMatch) GetLabelExtractors() map[string]string
func (*AlertPolicy_Condition_LogMatch) ProtoMessage()
func (x *AlertPolicy_Condition_LogMatch) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition_LogMatch) Reset()
func (x *AlertPolicy_Condition_LogMatch) String() string
A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified `duration`.
type AlertPolicy_Condition_MetricAbsence struct {
// 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.
Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
// 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 `protobuf:"bytes,5,rep,name=aggregations,proto3" json:"aggregations,omitempty"`
// The amount of time that a time series must fail to report new
// data to be considered failing. The minimum value of this field
// is 120 seconds. Larger values that are a multiple of a
// minute--for example, 240 or 300 seconds--are supported.
// If an invalid value is given, an
// error will be returned. The `Duration.nanos` field is
// ignored.
Duration *durationpb.Duration `protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`
// 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 *AlertPolicy_Condition_Trigger `protobuf:"bytes,3,opt,name=trigger,proto3" json:"trigger,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition_MetricAbsence) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_MetricAbsence.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Condition_MetricAbsence) GetAggregations() []*Aggregation
func (x *AlertPolicy_Condition_MetricAbsence) GetDuration() *durationpb.Duration
func (x *AlertPolicy_Condition_MetricAbsence) GetFilter() string
func (x *AlertPolicy_Condition_MetricAbsence) GetTrigger() *AlertPolicy_Condition_Trigger
func (*AlertPolicy_Condition_MetricAbsence) ProtoMessage()
func (x *AlertPolicy_Condition_MetricAbsence) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition_MetricAbsence) Reset()
func (x *AlertPolicy_Condition_MetricAbsence) String() string
A condition type that compares a collection of time series against a threshold.
type AlertPolicy_Condition_MetricThreshold struct {
// 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.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// 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 `protobuf:"bytes,8,rep,name=aggregations,proto3" json:"aggregations,omitempty"`
// 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.
DenominatorFilter string `protobuf:"bytes,9,opt,name=denominator_filter,json=denominatorFilter,proto3" json:"denominator_filter,omitempty"`
// 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 `protobuf:"bytes,10,rep,name=denominator_aggregations,json=denominatorAggregations,proto3" json:"denominator_aggregations,omitempty"`
// 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 *AlertPolicy_Condition_MetricThreshold_ForecastOptions `protobuf:"bytes,12,opt,name=forecast_options,json=forecastOptions,proto3" json:"forecast_options,omitempty"`
// 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.
Comparison ComparisonType `protobuf:"varint,4,opt,name=comparison,proto3,enum=google.monitoring.v3.ComparisonType" json:"comparison,omitempty"`
// A value against which to compare the time series.
ThresholdValue float64 `protobuf:"fixed64,5,opt,name=threshold_value,json=thresholdValue,proto3" json:"threshold_value,omitempty"`
// 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.
Duration *durationpb.Duration `protobuf:"bytes,6,opt,name=duration,proto3" json:"duration,omitempty"`
// 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 *AlertPolicy_Condition_Trigger `protobuf:"bytes,7,opt,name=trigger,proto3" json:"trigger,omitempty"`
// 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.
EvaluationMissingData AlertPolicy_Condition_EvaluationMissingData `protobuf:"varint,11,opt,name=evaluation_missing_data,json=evaluationMissingData,proto3,enum=google.monitoring.v3.AlertPolicy_Condition_EvaluationMissingData" json:"evaluation_missing_data,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition_MetricThreshold) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_MetricThreshold.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Condition_MetricThreshold) GetAggregations() []*Aggregation
func (x *AlertPolicy_Condition_MetricThreshold) GetComparison() ComparisonType
func (x *AlertPolicy_Condition_MetricThreshold) GetDenominatorAggregations() []*Aggregation
func (x *AlertPolicy_Condition_MetricThreshold) GetDenominatorFilter() string
func (x *AlertPolicy_Condition_MetricThreshold) GetDuration() *durationpb.Duration
func (x *AlertPolicy_Condition_MetricThreshold) GetEvaluationMissingData() AlertPolicy_Condition_EvaluationMissingData
func (x *AlertPolicy_Condition_MetricThreshold) GetFilter() string
func (x *AlertPolicy_Condition_MetricThreshold) GetForecastOptions() *AlertPolicy_Condition_MetricThreshold_ForecastOptions
func (x *AlertPolicy_Condition_MetricThreshold) GetThresholdValue() float64
func (x *AlertPolicy_Condition_MetricThreshold) GetTrigger() *AlertPolicy_Condition_Trigger
func (*AlertPolicy_Condition_MetricThreshold) ProtoMessage()
func (x *AlertPolicy_Condition_MetricThreshold) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition_MetricThreshold) Reset()
func (x *AlertPolicy_Condition_MetricThreshold) String() string
Options used when forecasting the time series and testing the predicted value against the threshold.
type AlertPolicy_Condition_MetricThreshold_ForecastOptions struct {
// 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.
ForecastHorizon *durationpb.Duration `protobuf:"bytes,1,opt,name=forecast_horizon,json=forecastHorizon,proto3" json:"forecast_horizon,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition_MetricThreshold_ForecastOptions) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_MetricThreshold_ForecastOptions.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Condition_MetricThreshold_ForecastOptions) GetForecastHorizon() *durationpb.Duration
func (*AlertPolicy_Condition_MetricThreshold_ForecastOptions) ProtoMessage()
func (x *AlertPolicy_Condition_MetricThreshold_ForecastOptions) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition_MetricThreshold_ForecastOptions) Reset()
func (x *AlertPolicy_Condition_MetricThreshold_ForecastOptions) String() string
A condition type that allows alert policies to be defined using [Monitoring Query Language](https://cloud.google.com/monitoring/mql).
type AlertPolicy_Condition_MonitoringQueryLanguageCondition struct {
// [Monitoring Query Language](https://cloud.google.com/monitoring/mql)
// query that outputs a boolean stream.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// 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.
Duration *durationpb.Duration `protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`
// 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 *AlertPolicy_Condition_Trigger `protobuf:"bytes,3,opt,name=trigger,proto3" json:"trigger,omitempty"`
// A condition control that determines how metric-threshold conditions
// are evaluated when data stops arriving.
EvaluationMissingData AlertPolicy_Condition_EvaluationMissingData `protobuf:"varint,4,opt,name=evaluation_missing_data,json=evaluationMissingData,proto3,enum=google.monitoring.v3.AlertPolicy_Condition_EvaluationMissingData" json:"evaluation_missing_data,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition_MonitoringQueryLanguageCondition) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_MonitoringQueryLanguageCondition.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Condition_MonitoringQueryLanguageCondition) GetDuration() *durationpb.Duration
func (x *AlertPolicy_Condition_MonitoringQueryLanguageCondition) GetEvaluationMissingData() AlertPolicy_Condition_EvaluationMissingData
func (x *AlertPolicy_Condition_MonitoringQueryLanguageCondition) GetQuery() string
func (x *AlertPolicy_Condition_MonitoringQueryLanguageCondition) GetTrigger() *AlertPolicy_Condition_Trigger
func (*AlertPolicy_Condition_MonitoringQueryLanguageCondition) ProtoMessage()
func (x *AlertPolicy_Condition_MonitoringQueryLanguageCondition) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition_MonitoringQueryLanguageCondition) Reset()
func (x *AlertPolicy_Condition_MonitoringQueryLanguageCondition) String() string
A condition type that allows alert policies to be defined using [Prometheus Query Language (PromQL)](https://prometheus.io/docs/prometheus/latest/querying/basics/).
The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.
A Prometheus alerting rule 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).
A Prometheus 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).
Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.
The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).
type AlertPolicy_Condition_PrometheusQueryLanguageCondition struct {
// 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.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// 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.
Duration *durationpb.Duration `protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`
// 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.
EvaluationInterval *durationpb.Duration `protobuf:"bytes,3,opt,name=evaluation_interval,json=evaluationInterval,proto3" json:"evaluation_interval,omitempty"`
// 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).
// 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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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.
RuleGroup string `protobuf:"bytes,5,opt,name=rule_group,json=ruleGroup,proto3" json:"rule_group,omitempty"`
// 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.
AlertRule string `protobuf:"bytes,6,opt,name=alert_rule,json=alertRule,proto3" json:"alert_rule,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition_PrometheusQueryLanguageCondition) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_PrometheusQueryLanguageCondition.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) GetAlertRule() string
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) GetDuration() *durationpb.Duration
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) GetEvaluationInterval() *durationpb.Duration
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) GetLabels() map[string]string
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) GetQuery() string
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) GetRuleGroup() string
func (*AlertPolicy_Condition_PrometheusQueryLanguageCondition) ProtoMessage()
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) Reset()
func (x *AlertPolicy_Condition_PrometheusQueryLanguageCondition) String() string
Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a `{count: 1}` trigger is used.
type AlertPolicy_Condition_Trigger struct {
// A type of trigger.
//
// Types that are assignable to Type:
//
// *AlertPolicy_Condition_Trigger_Count
// *AlertPolicy_Condition_Trigger_Percent
Type isAlertPolicy_Condition_Trigger_Type `protobuf_oneof:"type"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Condition_Trigger) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Condition_Trigger.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Condition_Trigger) GetCount() int32
func (x *AlertPolicy_Condition_Trigger) GetPercent() float64
func (m *AlertPolicy_Condition_Trigger) GetType() isAlertPolicy_Condition_Trigger_Type
func (*AlertPolicy_Condition_Trigger) ProtoMessage()
func (x *AlertPolicy_Condition_Trigger) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Condition_Trigger) Reset()
func (x *AlertPolicy_Condition_Trigger) String() string
type AlertPolicy_Condition_Trigger_Count struct {
// The absolute number of time series that must fail
// the predicate for the condition to be triggered.
Count int32 `protobuf:"varint,1,opt,name=count,proto3,oneof"`
}
type AlertPolicy_Condition_Trigger_Percent struct {
// The percentage of time series that must fail the
// predicate for the condition to be triggered.
Percent float64 `protobuf:"fixed64,2,opt,name=percent,proto3,oneof"`
}
Documentation that is included in the notifications and incidents pertaining to this policy.
type AlertPolicy_Documentation struct {
// 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).
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// 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.
MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// 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).
// If this field is missing or empty, a default subject line will be
// generated.
Subject string `protobuf:"bytes,3,opt,name=subject,proto3" json:"subject,omitempty"`
// contains filtered or unexported fields
}
func (*AlertPolicy_Documentation) Descriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Documentation.ProtoReflect.Descriptor instead.
func (x *AlertPolicy_Documentation) GetContent() string
func (x *AlertPolicy_Documentation) GetMimeType() string
func (x *AlertPolicy_Documentation) GetSubject() string
func (*AlertPolicy_Documentation) ProtoMessage()
func (x *AlertPolicy_Documentation) ProtoReflect() protoreflect.Message
func (x *AlertPolicy_Documentation) Reset()
func (x *AlertPolicy_Documentation) String() string
An enumeration of possible severity level for an Alert Policy.
type AlertPolicy_Severity int32
const (
// No severity is specified. This is the default value.
AlertPolicy_SEVERITY_UNSPECIFIED AlertPolicy_Severity = 0
// This is the highest severity level. Use this if the problem could
// cause significant damage or downtime.
AlertPolicy_CRITICAL AlertPolicy_Severity = 1
// This is the medium severity level. Use this if the problem could
// cause minor damage or downtime.
AlertPolicy_ERROR AlertPolicy_Severity = 2
// 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.
AlertPolicy_WARNING AlertPolicy_Severity = 3
)
func (AlertPolicy_Severity) Descriptor() protoreflect.EnumDescriptor
func (x AlertPolicy_Severity) Enum() *AlertPolicy_Severity
func (AlertPolicy_Severity) EnumDescriptor() ([]byte, []int)
Deprecated: Use AlertPolicy_Severity.Descriptor instead.
func (x AlertPolicy_Severity) Number() protoreflect.EnumNumber
func (x AlertPolicy_Severity) String() string
func (AlertPolicy_Severity) Type() protoreflect.EnumType
An SLI measuring performance on a well-known service type. Performance will be computed on the basis of pre-defined metrics. The type of the `service_resource` determines the metrics to use and the `service_resource.labels` and `metric_labels` are used to construct a monitoring filter to filter that metric down to just the data relevant to this service.
type BasicSli struct {
// 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 `protobuf:"bytes,7,rep,name=method,proto3" json:"method,omitempty"`
// 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 `protobuf:"bytes,8,rep,name=location,proto3" json:"location,omitempty"`
// 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 `protobuf:"bytes,9,rep,name=version,proto3" json:"version,omitempty"`
// This SLI can be evaluated on the basis of availability or latency.
//
// Types that are assignable to SliCriteria:
//
// *BasicSli_Availability
// *BasicSli_Latency
SliCriteria isBasicSli_SliCriteria `protobuf_oneof:"sli_criteria"`
// contains filtered or unexported fields
}
func (*BasicSli) Descriptor() ([]byte, []int)
Deprecated: Use BasicSli.ProtoReflect.Descriptor instead.
func (x *BasicSli) GetAvailability() *BasicSli_AvailabilityCriteria
func (x *BasicSli) GetLatency() *BasicSli_LatencyCriteria
func (x *BasicSli) GetLocation() []string
func (x *BasicSli) GetMethod() []string
func (m *BasicSli) GetSliCriteria() isBasicSli_SliCriteria
func (x *BasicSli) GetVersion() []string
func (*BasicSli) ProtoMessage()
func (x *BasicSli) ProtoReflect() protoreflect.Message
func (x *BasicSli) Reset()
func (x *BasicSli) String() string
type BasicSli_Availability struct {
// Good service is defined to be the count of requests made to this service
// that return successfully.
Availability *BasicSli_AvailabilityCriteria `protobuf:"bytes,2,opt,name=availability,proto3,oneof"`
}
Future parameters for the availability SLI.
type BasicSli_AvailabilityCriteria struct {
// contains filtered or unexported fields
}
func (*BasicSli_AvailabilityCriteria) Descriptor() ([]byte, []int)
Deprecated: Use BasicSli_AvailabilityCriteria.ProtoReflect.Descriptor instead.
func (*BasicSli_AvailabilityCriteria) ProtoMessage()
func (x *BasicSli_AvailabilityCriteria) ProtoReflect() protoreflect.Message
func (x *BasicSli_AvailabilityCriteria) Reset()
func (x *BasicSli_AvailabilityCriteria) String() string
type BasicSli_Latency struct {
// Good service is defined to be the count of requests made to this service
// that are fast enough with respect to `latency.threshold`.
Latency *BasicSli_LatencyCriteria `protobuf:"bytes,3,opt,name=latency,proto3,oneof"`
}
Parameters for a latency threshold SLI.
type BasicSli_LatencyCriteria struct {
// Good service is defined to be the count of requests made to this service
// that return in no more than `threshold`.
Threshold *durationpb.Duration `protobuf:"bytes,3,opt,name=threshold,proto3" json:"threshold,omitempty"`
// contains filtered or unexported fields
}
func (*BasicSli_LatencyCriteria) Descriptor() ([]byte, []int)
Deprecated: Use BasicSli_LatencyCriteria.ProtoReflect.Descriptor instead.
func (x *BasicSli_LatencyCriteria) GetThreshold() *durationpb.Duration
func (*BasicSli_LatencyCriteria) ProtoMessage()
func (x *BasicSli_LatencyCriteria) ProtoReflect() protoreflect.Message
func (x *BasicSli_LatencyCriteria) Reset()
func (x *BasicSli_LatencyCriteria) String() string
Specifies an ordering relationship on two arguments, called `left` and `right`.
type ComparisonType int32
const (
// No ordering relationship is specified.
ComparisonType_COMPARISON_UNSPECIFIED ComparisonType = 0
// True if the left argument is greater than the right argument.
ComparisonType_COMPARISON_GT ComparisonType = 1
// True if the left argument is greater than or equal to the right argument.
ComparisonType_COMPARISON_GE ComparisonType = 2
// True if the left argument is less than the right argument.
ComparisonType_COMPARISON_LT ComparisonType = 3
// True if the left argument is less than or equal to the right argument.
ComparisonType_COMPARISON_LE ComparisonType = 4
// True if the left argument is equal to the right argument.
ComparisonType_COMPARISON_EQ ComparisonType = 5
// True if the left argument is not equal to the right argument.
ComparisonType_COMPARISON_NE ComparisonType = 6
)
func (ComparisonType) Descriptor() protoreflect.EnumDescriptor
func (x ComparisonType) Enum() *ComparisonType
func (ComparisonType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ComparisonType.Descriptor instead.
func (x ComparisonType) Number() protoreflect.EnumNumber
func (x ComparisonType) String() string
func (ComparisonType) Type() protoreflect.EnumType
The protocol for the `CreateAlertPolicy` request.
type CreateAlertPolicyRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
// to create the alerting policy. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
//
// Note that this field names the parent container in which the alerting
// policy will be written, not the name of the created policy. |name| must be
// a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will
// return. The alerting policy that is returned will have a name that contains
// a normalized representation of this name as a prefix but adds a suffix of
// the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
// container.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// Required. The requested alerting policy. You should omit the `name` field
// in this policy. The name will be returned in the new policy, including a
// new `[ALERT_POLICY_ID]` value.
AlertPolicy *AlertPolicy `protobuf:"bytes,2,opt,name=alert_policy,json=alertPolicy,proto3" json:"alert_policy,omitempty"`
// contains filtered or unexported fields
}
func (*CreateAlertPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateAlertPolicyRequest.ProtoReflect.Descriptor instead.
func (x *CreateAlertPolicyRequest) GetAlertPolicy() *AlertPolicy
func (x *CreateAlertPolicyRequest) GetName() string
func (*CreateAlertPolicyRequest) ProtoMessage()
func (x *CreateAlertPolicyRequest) ProtoReflect() protoreflect.Message
func (x *CreateAlertPolicyRequest) Reset()
func (x *CreateAlertPolicyRequest) String() string
The `CreateGroup` request.
type CreateGroupRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
// to create the group. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
// Required. A group definition. It is an error to define the `name` field
// because the system assigns the name.
Group *Group `protobuf:"bytes,2,opt,name=group,proto3" json:"group,omitempty"`
// If true, validate this request but do not create the group.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
func (*CreateGroupRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateGroupRequest.ProtoReflect.Descriptor instead.
func (x *CreateGroupRequest) GetGroup() *Group
func (x *CreateGroupRequest) GetName() string
func (x *CreateGroupRequest) GetValidateOnly() bool
func (*CreateGroupRequest) ProtoMessage()
func (x *CreateGroupRequest) ProtoReflect() protoreflect.Message
func (x *CreateGroupRequest) Reset()
func (x *CreateGroupRequest) String() string
The `CreateMetricDescriptor` request.
type CreateMetricDescriptorRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
// to execute the request. The format is:
// 4
//
// projects/[PROJECT_ID_OR_NUMBER]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// Required. The new [custom
// metric](https://cloud.google.com/monitoring/custom-metrics) descriptor.
MetricDescriptor *metric.MetricDescriptor `protobuf:"bytes,2,opt,name=metric_descriptor,json=metricDescriptor,proto3" json:"metric_descriptor,omitempty"`
// contains filtered or unexported fields
}
func (*CreateMetricDescriptorRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateMetricDescriptorRequest.ProtoReflect.Descriptor instead.
func (x *CreateMetricDescriptorRequest) GetMetricDescriptor() *metric.MetricDescriptor
func (x *CreateMetricDescriptorRequest) GetName() string
func (*CreateMetricDescriptorRequest) ProtoMessage()
func (x *CreateMetricDescriptorRequest) ProtoReflect() protoreflect.Message
func (x *CreateMetricDescriptorRequest) Reset()
func (x *CreateMetricDescriptorRequest) String() string
The `CreateNotificationChannel` request.
type CreateNotificationChannelRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
// to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
//
// This names the container into which the channel will be
// written, this does not name the newly created channel. The resulting
// channel's name will have a normalized version of this field as a prefix,
// but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// Required. The definition of the `NotificationChannel` to create.
NotificationChannel *NotificationChannel `protobuf:"bytes,2,opt,name=notification_channel,json=notificationChannel,proto3" json:"notification_channel,omitempty"`
// contains filtered or unexported fields
}
func (*CreateNotificationChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateNotificationChannelRequest.ProtoReflect.Descriptor instead.
func (x *CreateNotificationChannelRequest) GetName() string
func (x *CreateNotificationChannelRequest) GetNotificationChannel() *NotificationChannel
func (*CreateNotificationChannelRequest) ProtoMessage()
func (x *CreateNotificationChannelRequest) ProtoReflect() protoreflect.Message
func (x *CreateNotificationChannelRequest) Reset()
func (x *CreateNotificationChannelRequest) String() string
The `CreateServiceLevelObjective` request.
type CreateServiceLevelObjectiveRequest struct {
// Required. Resource name of the parent `Service`. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The ServiceLevelObjective id to use for this
// ServiceLevelObjective. If omitted, an id will be generated instead. Must
// match the pattern `^[a-zA-Z0-9-_:.]+$`
ServiceLevelObjectiveId string `protobuf:"bytes,3,opt,name=service_level_objective_id,json=serviceLevelObjectiveId,proto3" json:"service_level_objective_id,omitempty"`
// Required. The `ServiceLevelObjective` to create.
// The provided `name` will be respected if no `ServiceLevelObjective` exists
// with this name.
ServiceLevelObjective *ServiceLevelObjective `protobuf:"bytes,2,opt,name=service_level_objective,json=serviceLevelObjective,proto3" json:"service_level_objective,omitempty"`
// contains filtered or unexported fields
}
func (*CreateServiceLevelObjectiveRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateServiceLevelObjectiveRequest.ProtoReflect.Descriptor instead.
func (x *CreateServiceLevelObjectiveRequest) GetParent() string
func (x *CreateServiceLevelObjectiveRequest) GetServiceLevelObjective() *ServiceLevelObjective
func (x *CreateServiceLevelObjectiveRequest) GetServiceLevelObjectiveId() string
func (*CreateServiceLevelObjectiveRequest) ProtoMessage()
func (x *CreateServiceLevelObjectiveRequest) ProtoReflect() protoreflect.Message
func (x *CreateServiceLevelObjectiveRequest) Reset()
func (x *CreateServiceLevelObjectiveRequest) String() string
The `CreateService` request.
type CreateServiceRequest struct {
// Required. Resource
// [name](https://cloud.google.com/monitoring/api/v3#project_name) of the
// parent Metrics Scope. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The Service id to use for this Service. If omitted, an id will be
// generated instead. Must match the pattern `[a-z0-9\-]+`
ServiceId string `protobuf:"bytes,3,opt,name=service_id,json=serviceId,proto3" json:"service_id,omitempty"`
// Required. The `Service` to create.
Service *Service `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}
func (*CreateServiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateServiceRequest.ProtoReflect.Descriptor instead.
func (x *CreateServiceRequest) GetParent() string
func (x *CreateServiceRequest) GetService() *Service
func (x *CreateServiceRequest) GetServiceId() string
func (*CreateServiceRequest) ProtoMessage()
func (x *CreateServiceRequest) ProtoReflect() protoreflect.Message
func (x *CreateServiceRequest) Reset()
func (x *CreateServiceRequest) String() string
The message definition for creating a `Snooze`. Users must provide the body of the `Snooze` to be created but must omit the `Snooze` field, `name`.
type CreateSnoozeRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
// a `Snooze` should be created. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The `Snooze` to create. Omit the `name` field, as it will be
// filled in by the API.
Snooze *Snooze `protobuf:"bytes,2,opt,name=snooze,proto3" json:"snooze,omitempty"`
// contains filtered or unexported fields
}
func (*CreateSnoozeRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSnoozeRequest.ProtoReflect.Descriptor instead.
func (x *CreateSnoozeRequest) GetParent() string
func (x *CreateSnoozeRequest) GetSnooze() *Snooze
func (*CreateSnoozeRequest) ProtoMessage()
func (x *CreateSnoozeRequest) ProtoReflect() protoreflect.Message
func (x *CreateSnoozeRequest) Reset()
func (x *CreateSnoozeRequest) String() string
DEPRECATED. Used to hold per-time-series error status.
type CreateTimeSeriesError struct {
// DEPRECATED. Time series ID that resulted in the `status` error.
//
// Deprecated: Marked as deprecated in google/monitoring/v3/metric_service.proto.
TimeSeries *TimeSeries `protobuf:"bytes,1,opt,name=time_series,json=timeSeries,proto3" json:"time_series,omitempty"`
// DEPRECATED. The status of the requested write operation for `time_series`.
//
// Deprecated: Marked as deprecated in google/monitoring/v3/metric_service.proto.
Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTimeSeriesError) Descriptor() ([]byte, []int)
Deprecated: Use CreateTimeSeriesError.ProtoReflect.Descriptor instead.
func (x *CreateTimeSeriesError) GetStatus() *status.Status
Deprecated: Marked as deprecated in google/monitoring/v3/metric_service.proto.
func (x *CreateTimeSeriesError) GetTimeSeries() *TimeSeries
Deprecated: Marked as deprecated in google/monitoring/v3/metric_service.proto.
func (*CreateTimeSeriesError) ProtoMessage()
func (x *CreateTimeSeriesError) ProtoReflect() protoreflect.Message
func (x *CreateTimeSeriesError) Reset()
func (x *CreateTimeSeriesError) String() string
The `CreateTimeSeries` request.
type CreateTimeSeriesRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
// to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// 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 `protobuf:"bytes,2,rep,name=time_series,json=timeSeries,proto3" json:"time_series,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTimeSeriesRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTimeSeriesRequest.ProtoReflect.Descriptor instead.
func (x *CreateTimeSeriesRequest) GetName() string
func (x *CreateTimeSeriesRequest) GetTimeSeries() []*TimeSeries
func (*CreateTimeSeriesRequest) ProtoMessage()
func (x *CreateTimeSeriesRequest) ProtoReflect() protoreflect.Message
func (x *CreateTimeSeriesRequest) Reset()
func (x *CreateTimeSeriesRequest) String() string
Summary of the result of a failed request to write data to a time series.
type CreateTimeSeriesSummary struct {
// The number of points in the request.
TotalPointCount int32 `protobuf:"varint,1,opt,name=total_point_count,json=totalPointCount,proto3" json:"total_point_count,omitempty"`
// The number of points that were successfully written.
SuccessPointCount int32 `protobuf:"varint,2,opt,name=success_point_count,json=successPointCount,proto3" json:"success_point_count,omitempty"`
// The number of points that failed to be written. Order is not guaranteed.
Errors []*CreateTimeSeriesSummary_Error `protobuf:"bytes,3,rep,name=errors,proto3" json:"errors,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTimeSeriesSummary) Descriptor() ([]byte, []int)
Deprecated: Use CreateTimeSeriesSummary.ProtoReflect.Descriptor instead.
func (x *CreateTimeSeriesSummary) GetErrors() []*CreateTimeSeriesSummary_Error
func (x *CreateTimeSeriesSummary) GetSuccessPointCount() int32
func (x *CreateTimeSeriesSummary) GetTotalPointCount() int32
func (*CreateTimeSeriesSummary) ProtoMessage()
func (x *CreateTimeSeriesSummary) ProtoReflect() protoreflect.Message
func (x *CreateTimeSeriesSummary) Reset()
func (x *CreateTimeSeriesSummary) String() string
Detailed information about an error category.
type CreateTimeSeriesSummary_Error struct {
// The status of the requested write operation.
Status *status.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
// The number of points that couldn't be written because of `status`.
PointCount int32 `protobuf:"varint,2,opt,name=point_count,json=pointCount,proto3" json:"point_count,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTimeSeriesSummary_Error) Descriptor() ([]byte, []int)
Deprecated: Use CreateTimeSeriesSummary_Error.ProtoReflect.Descriptor instead.
func (x *CreateTimeSeriesSummary_Error) GetPointCount() int32
func (x *CreateTimeSeriesSummary_Error) GetStatus() *status.Status
func (*CreateTimeSeriesSummary_Error) ProtoMessage()
func (x *CreateTimeSeriesSummary_Error) ProtoReflect() protoreflect.Message
func (x *CreateTimeSeriesSummary_Error) Reset()
func (x *CreateTimeSeriesSummary_Error) String() string
The protocol for the `CreateUptimeCheckConfig` request.
type CreateUptimeCheckConfigRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
// to create the Uptime check. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The new Uptime check configuration.
UptimeCheckConfig *UptimeCheckConfig `protobuf:"bytes,2,opt,name=uptime_check_config,json=uptimeCheckConfig,proto3" json:"uptime_check_config,omitempty"`
// contains filtered or unexported fields
}
func (*CreateUptimeCheckConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateUptimeCheckConfigRequest.ProtoReflect.Descriptor instead.
func (x *CreateUptimeCheckConfigRequest) GetParent() string
func (x *CreateUptimeCheckConfigRequest) GetUptimeCheckConfig() *UptimeCheckConfig
func (*CreateUptimeCheckConfigRequest) ProtoMessage()
func (x *CreateUptimeCheckConfigRequest) ProtoReflect() protoreflect.Message
func (x *CreateUptimeCheckConfigRequest) Reset()
func (x *CreateUptimeCheckConfigRequest) String() string
The protocol for the `DeleteAlertPolicy` request.
type DeleteAlertPolicyRequest struct {
// Required. The alerting policy to delete. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
//
// For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteAlertPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteAlertPolicyRequest.ProtoReflect.Descriptor instead.
func (x *DeleteAlertPolicyRequest) GetName() string
func (*DeleteAlertPolicyRequest) ProtoMessage()
func (x *DeleteAlertPolicyRequest) ProtoReflect() protoreflect.Message
func (x *DeleteAlertPolicyRequest) Reset()
func (x *DeleteAlertPolicyRequest) String() string
The `DeleteGroup` request. The default behavior is to be able to delete a single group without any descendants.
type DeleteGroupRequest struct {
// Required. The group to delete. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// If this field is true, then the request means to delete a group with all
// its descendants. Otherwise, the request means to delete a group only when
// it has no descendants. The default value is false.
Recursive bool `protobuf:"varint,4,opt,name=recursive,proto3" json:"recursive,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteGroupRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteGroupRequest.ProtoReflect.Descriptor instead.
func (x *DeleteGroupRequest) GetName() string
func (x *DeleteGroupRequest) GetRecursive() bool
func (*DeleteGroupRequest) ProtoMessage()
func (x *DeleteGroupRequest) ProtoReflect() protoreflect.Message
func (x *DeleteGroupRequest) Reset()
func (x *DeleteGroupRequest) String() string
The `DeleteMetricDescriptor` request.
type DeleteMetricDescriptorRequest struct {
// Required. The metric descriptor on which to execute the request. The format
// is:
//
// projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
//
// An example of `[METRIC_ID]` is:
// `"custom.googleapis.com/my_test_metric"`.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteMetricDescriptorRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteMetricDescriptorRequest.ProtoReflect.Descriptor instead.
func (x *DeleteMetricDescriptorRequest) GetName() string
func (*DeleteMetricDescriptorRequest) ProtoMessage()
func (x *DeleteMetricDescriptorRequest) ProtoReflect() protoreflect.Message
func (x *DeleteMetricDescriptorRequest) Reset()
func (x *DeleteMetricDescriptorRequest) String() string
The `DeleteNotificationChannel` request.
type DeleteNotificationChannelRequest struct {
// Required. The channel for which to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// If true, the notification channel will be deleted regardless of its
// use in alert policies (the policies will be updated to remove the
// channel). If false, channels that are still referenced by an existing
// alerting policy will fail to be deleted in a delete operation.
Force bool `protobuf:"varint,5,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteNotificationChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteNotificationChannelRequest.ProtoReflect.Descriptor instead.
func (x *DeleteNotificationChannelRequest) GetForce() bool
func (x *DeleteNotificationChannelRequest) GetName() string
func (*DeleteNotificationChannelRequest) ProtoMessage()
func (x *DeleteNotificationChannelRequest) ProtoReflect() protoreflect.Message
func (x *DeleteNotificationChannelRequest) Reset()
func (x *DeleteNotificationChannelRequest) String() string
The `DeleteServiceLevelObjective` request.
type DeleteServiceLevelObjectiveRequest struct {
// Required. Resource name of the `ServiceLevelObjective` to delete. The
// format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteServiceLevelObjectiveRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteServiceLevelObjectiveRequest.ProtoReflect.Descriptor instead.
func (x *DeleteServiceLevelObjectiveRequest) GetName() string
func (*DeleteServiceLevelObjectiveRequest) ProtoMessage()
func (x *DeleteServiceLevelObjectiveRequest) ProtoReflect() protoreflect.Message
func (x *DeleteServiceLevelObjectiveRequest) Reset()
func (x *DeleteServiceLevelObjectiveRequest) String() string
The `DeleteService` request.
type DeleteServiceRequest struct {
// Required. Resource name of the `Service` to delete. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteServiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteServiceRequest.ProtoReflect.Descriptor instead.
func (x *DeleteServiceRequest) GetName() string
func (*DeleteServiceRequest) ProtoMessage()
func (x *DeleteServiceRequest) ProtoReflect() protoreflect.Message
func (x *DeleteServiceRequest) Reset()
func (x *DeleteServiceRequest) String() string
The protocol for the `DeleteUptimeCheckConfig` request.
type DeleteUptimeCheckConfigRequest struct {
// Required. The Uptime check configuration to delete. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteUptimeCheckConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteUptimeCheckConfigRequest.ProtoReflect.Descriptor instead.
func (x *DeleteUptimeCheckConfigRequest) GetName() string
func (*DeleteUptimeCheckConfigRequest) ProtoMessage()
func (x *DeleteUptimeCheckConfigRequest) ProtoReflect() protoreflect.Message
func (x *DeleteUptimeCheckConfigRequest) Reset()
func (x *DeleteUptimeCheckConfigRequest) String() string
A `DistributionCut` defines a `TimeSeries` and thresholds used for measuring good service and total service. The `TimeSeries` must have `ValueType = DISTRIBUTION` and `MetricKind = DELTA` or `MetricKind = CUMULATIVE`. The computed `good_service` will be the estimated count of values in the `Distribution` that fall within the specified `min` and `max`.
type DistributionCut struct {
// 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`.
DistributionFilter string `protobuf:"bytes,4,opt,name=distribution_filter,json=distributionFilter,proto3" json:"distribution_filter,omitempty"`
// Range of values considered "good." For a one-sided range, set one bound to
// an infinite value.
Range *Range `protobuf:"bytes,5,opt,name=range,proto3" json:"range,omitempty"`
// contains filtered or unexported fields
}
func (*DistributionCut) Descriptor() ([]byte, []int)
Deprecated: Use DistributionCut.ProtoReflect.Descriptor instead.
func (x *DistributionCut) GetDistributionFilter() string
func (x *DistributionCut) GetRange() *Range
func (*DistributionCut) ProtoMessage()
func (x *DistributionCut) ProtoReflect() protoreflect.Message
func (x *DistributionCut) Reset()
func (x *DistributionCut) String() string
A set of (label, value) pairs that were removed from a Distribution time series during aggregation and then added as an attachment to a Distribution.Exemplar.
The full label set for the exemplars is constructed by using the dropped pairs in combination with the label values that remain on the aggregated Distribution time series. The constructed full label set can be used to identify the specific entity, such as the instance or job, which might be contributing to a long-tail. However, with dropped labels, the storage requirements are reduced because only the aggregated distribution values for a large group of time series are stored.
Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.
type DroppedLabels struct {
// Map from label to its value, for all labels dropped in any aggregation.
Label map[string]string `protobuf:"bytes,1,rep,name=label,proto3" json:"label,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*DroppedLabels) Descriptor() ([]byte, []int)
Deprecated: Use DroppedLabels.ProtoReflect.Descriptor instead.
func (x *DroppedLabels) GetLabel() map[string]string
func (*DroppedLabels) ProtoMessage()
func (x *DroppedLabels) ProtoReflect() protoreflect.Message
func (x *DroppedLabels) Reset()
func (x *DroppedLabels) String() string
The protocol for the `GetAlertPolicy` request.
type GetAlertPolicyRequest struct {
// Required. The alerting policy to retrieve. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetAlertPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAlertPolicyRequest.ProtoReflect.Descriptor instead.
func (x *GetAlertPolicyRequest) GetName() string
func (*GetAlertPolicyRequest) ProtoMessage()
func (x *GetAlertPolicyRequest) ProtoReflect() protoreflect.Message
func (x *GetAlertPolicyRequest) Reset()
func (x *GetAlertPolicyRequest) String() string
The `GetGroup` request.
type GetGroupRequest struct {
// Required. The group to retrieve. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetGroupRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetGroupRequest.ProtoReflect.Descriptor instead.
func (x *GetGroupRequest) GetName() string
func (*GetGroupRequest) ProtoMessage()
func (x *GetGroupRequest) ProtoReflect() protoreflect.Message
func (x *GetGroupRequest) Reset()
func (x *GetGroupRequest) String() string
The `GetMetricDescriptor` request.
type GetMetricDescriptorRequest struct {
// Required. The metric descriptor on which to execute the request. The format
// is:
//
// projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
//
// An example value of `[METRIC_ID]` is
// `"compute.googleapis.com/instance/disk/read_bytes_count"`.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetMetricDescriptorRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetMetricDescriptorRequest.ProtoReflect.Descriptor instead.
func (x *GetMetricDescriptorRequest) GetName() string
func (*GetMetricDescriptorRequest) ProtoMessage()
func (x *GetMetricDescriptorRequest) ProtoReflect() protoreflect.Message
func (x *GetMetricDescriptorRequest) Reset()
func (x *GetMetricDescriptorRequest) String() string
The `GetMonitoredResourceDescriptor` request.
type GetMonitoredResourceDescriptorRequest struct {
// Required. The monitored resource descriptor to get. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]
//
// The `[RESOURCE_TYPE]` is a predefined type, such as
// `cloudsql_database`.
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetMonitoredResourceDescriptorRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetMonitoredResourceDescriptorRequest.ProtoReflect.Descriptor instead.
func (x *GetMonitoredResourceDescriptorRequest) GetName() string
func (*GetMonitoredResourceDescriptorRequest) ProtoMessage()
func (x *GetMonitoredResourceDescriptorRequest) ProtoReflect() protoreflect.Message
func (x *GetMonitoredResourceDescriptorRequest) Reset()
func (x *GetMonitoredResourceDescriptorRequest) String() string
The `GetNotificationChannelDescriptor` response.
type GetNotificationChannelDescriptorRequest struct {
// Required. The channel type for which to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetNotificationChannelDescriptorRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNotificationChannelDescriptorRequest.ProtoReflect.Descriptor instead.
func (x *GetNotificationChannelDescriptorRequest) GetName() string
func (*GetNotificationChannelDescriptorRequest) ProtoMessage()
func (x *GetNotificationChannelDescriptorRequest) ProtoReflect() protoreflect.Message
func (x *GetNotificationChannelDescriptorRequest) Reset()
func (x *GetNotificationChannelDescriptorRequest) String() string
The `GetNotificationChannel` request.
type GetNotificationChannelRequest struct {
// Required. The channel for which to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetNotificationChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNotificationChannelRequest.ProtoReflect.Descriptor instead.
func (x *GetNotificationChannelRequest) GetName() string
func (*GetNotificationChannelRequest) ProtoMessage()
func (x *GetNotificationChannelRequest) ProtoReflect() protoreflect.Message
func (x *GetNotificationChannelRequest) Reset()
func (x *GetNotificationChannelRequest) String() string
The `GetNotificationChannelVerificationCode` request.
type GetNotificationChannelVerificationCodeRequest struct {
// Required. The notification channel for which a verification code is to be
// generated and retrieved. This must name a channel that is already verified;
// if the specified channel is not verified, the request will fail.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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).
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}
func (*GetNotificationChannelVerificationCodeRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNotificationChannelVerificationCodeRequest.ProtoReflect.Descriptor instead.
func (x *GetNotificationChannelVerificationCodeRequest) GetExpireTime() *timestamppb.Timestamp
func (x *GetNotificationChannelVerificationCodeRequest) GetName() string
func (*GetNotificationChannelVerificationCodeRequest) ProtoMessage()
func (x *GetNotificationChannelVerificationCodeRequest) ProtoReflect() protoreflect.Message
func (x *GetNotificationChannelVerificationCodeRequest) Reset()
func (x *GetNotificationChannelVerificationCodeRequest) String() string
The `GetNotificationChannelVerificationCode` request.
type GetNotificationChannelVerificationCodeResponse struct {
// 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).
Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
// 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.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}
func (*GetNotificationChannelVerificationCodeResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetNotificationChannelVerificationCodeResponse.ProtoReflect.Descriptor instead.
func (x *GetNotificationChannelVerificationCodeResponse) GetCode() string
func (x *GetNotificationChannelVerificationCodeResponse) GetExpireTime() *timestamppb.Timestamp
func (*GetNotificationChannelVerificationCodeResponse) ProtoMessage()
func (x *GetNotificationChannelVerificationCodeResponse) ProtoReflect() protoreflect.Message
func (x *GetNotificationChannelVerificationCodeResponse) Reset()
func (x *GetNotificationChannelVerificationCodeResponse) String() string
The `GetServiceLevelObjective` request.
type GetServiceLevelObjectiveRequest struct {
// Required. Resource name of the `ServiceLevelObjective` to get. The format
// is:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// View of the `ServiceLevelObjective` to return. If `DEFAULT`, return the
// `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the
// `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the
// `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.
View ServiceLevelObjective_View `protobuf:"varint,2,opt,name=view,proto3,enum=google.monitoring.v3.ServiceLevelObjective_View" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*GetServiceLevelObjectiveRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetServiceLevelObjectiveRequest.ProtoReflect.Descriptor instead.
func (x *GetServiceLevelObjectiveRequest) GetName() string
func (x *GetServiceLevelObjectiveRequest) GetView() ServiceLevelObjective_View
func (*GetServiceLevelObjectiveRequest) ProtoMessage()
func (x *GetServiceLevelObjectiveRequest) ProtoReflect() protoreflect.Message
func (x *GetServiceLevelObjectiveRequest) Reset()
func (x *GetServiceLevelObjectiveRequest) String() string
The `GetService` request.
type GetServiceRequest struct {
// Required. Resource name of the `Service`. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetServiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetServiceRequest.ProtoReflect.Descriptor instead.
func (x *GetServiceRequest) GetName() string
func (*GetServiceRequest) ProtoMessage()
func (x *GetServiceRequest) ProtoReflect() protoreflect.Message
func (x *GetServiceRequest) Reset()
func (x *GetServiceRequest) String() string
The message definition for retrieving a `Snooze`. Users must specify the field, `name`, which identifies the `Snooze`.
type GetSnoozeRequest struct {
// Required. The ID of the `Snooze` to retrieve. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetSnoozeRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSnoozeRequest.ProtoReflect.Descriptor instead.
func (x *GetSnoozeRequest) GetName() string
func (*GetSnoozeRequest) ProtoMessage()
func (x *GetSnoozeRequest) ProtoReflect() protoreflect.Message
func (x *GetSnoozeRequest) Reset()
func (x *GetSnoozeRequest) String() string
The protocol for the `GetUptimeCheckConfig` request.
type GetUptimeCheckConfigRequest struct {
// Required. The Uptime check configuration to retrieve. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetUptimeCheckConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetUptimeCheckConfigRequest.ProtoReflect.Descriptor instead.
func (x *GetUptimeCheckConfigRequest) GetName() string
func (*GetUptimeCheckConfigRequest) ProtoMessage()
func (x *GetUptimeCheckConfigRequest) ProtoReflect() protoreflect.Message
func (x *GetUptimeCheckConfigRequest) Reset()
func (x *GetUptimeCheckConfigRequest) String() string
The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.
Groups can be nested in parent-child hierarchies. The `parentName` field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.
For example, consider an infrastructure running a set of instances with two user-defined tags: `"environment"` and `"role"`. A parent group has a filter, `environment="production"`. A child of that parent group has a filter, `role="transcoder"`. The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role *and* are in the production environment.
The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
type Group struct {
// 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.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// A user-assigned name for this group, used only for display purposes.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// 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, `""`.
ParentName string `protobuf:"bytes,3,opt,name=parent_name,json=parentName,proto3" json:"parent_name,omitempty"`
// The filter used to determine which monitored resources belong to this
// group.
Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
// If true, the members of this group are considered to be a cluster.
// The system can perform additional analysis on groups that are clusters.
IsCluster bool `protobuf:"varint,6,opt,name=is_cluster,json=isCluster,proto3" json:"is_cluster,omitempty"`
// contains filtered or unexported fields
}
func (*Group) Descriptor() ([]byte, []int)
Deprecated: Use Group.ProtoReflect.Descriptor instead.
func (x *Group) GetDisplayName() string
func (x *Group) GetFilter() string
func (x *Group) GetIsCluster() bool
func (x *Group) GetName() string
func (x *Group) GetParentName() string
func (*Group) ProtoMessage()
func (x *Group) ProtoReflect() protoreflect.Message
func (x *Group) Reset()
func (x *Group) String() string
The supported resource types that can be used as values of `group_resource.resource_type`. `INSTANCE` includes `gce_instance` and `aws_ec2_instance` resource types. The resource types `gae_app` and `uptime_url` are not valid here because group checks on App Engine modules and URLs are not allowed.
type GroupResourceType int32
const (
// Default value (not valid).
GroupResourceType_RESOURCE_TYPE_UNSPECIFIED GroupResourceType = 0
// A group of instances from Google Cloud Platform (GCP) or
// Amazon Web Services (AWS).
GroupResourceType_INSTANCE GroupResourceType = 1
// A group of Amazon ELB load balancers.
GroupResourceType_AWS_ELB_LOAD_BALANCER GroupResourceType = 2
)
func (GroupResourceType) Descriptor() protoreflect.EnumDescriptor
func (x GroupResourceType) Enum() *GroupResourceType
func (GroupResourceType) EnumDescriptor() ([]byte, []int)
Deprecated: Use GroupResourceType.Descriptor instead.
func (x GroupResourceType) Number() protoreflect.EnumNumber
func (x GroupResourceType) String() string
func (GroupResourceType) Type() protoreflect.EnumType
GroupServiceClient is the client API for GroupService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type GroupServiceClient interface {
// Lists the existing groups.
ListGroups(ctx context.Context, in *ListGroupsRequest, opts ...grpc.CallOption) (*ListGroupsResponse, error)
// Gets a single group.
GetGroup(ctx context.Context, in *GetGroupRequest, opts ...grpc.CallOption) (*Group, error)
// Creates a new group.
CreateGroup(ctx context.Context, in *CreateGroupRequest, opts ...grpc.CallOption) (*Group, error)
// Updates an existing group.
// You can change any group attributes except `name`.
UpdateGroup(ctx context.Context, in *UpdateGroupRequest, opts ...grpc.CallOption) (*Group, error)
// Deletes an existing group.
DeleteGroup(ctx context.Context, in *DeleteGroupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists the monitored resources that are members of a group.
ListGroupMembers(ctx context.Context, in *ListGroupMembersRequest, opts ...grpc.CallOption) (*ListGroupMembersResponse, error)
}
func NewGroupServiceClient(cc grpc.ClientConnInterface) GroupServiceClient
GroupServiceServer is the server API for GroupService service.
type GroupServiceServer interface {
// Lists the existing groups.
ListGroups(context.Context, *ListGroupsRequest) (*ListGroupsResponse, error)
// Gets a single group.
GetGroup(context.Context, *GetGroupRequest) (*Group, error)
// Creates a new group.
CreateGroup(context.Context, *CreateGroupRequest) (*Group, error)
// Updates an existing group.
// You can change any group attributes except `name`.
UpdateGroup(context.Context, *UpdateGroupRequest) (*Group, error)
// Deletes an existing group.
DeleteGroup(context.Context, *DeleteGroupRequest) (*emptypb.Empty, error)
// Lists the monitored resources that are members of a group.
ListGroupMembers(context.Context, *ListGroupMembersRequest) (*ListGroupMembersResponse, error)
}
An internal checker allows Uptime checks to run on private/internal GCP resources.
Deprecated: Marked as deprecated in google/monitoring/v3/uptime.proto.
type InternalChecker struct {
// 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.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The [GCP VPC network](https://cloud.google.com/vpc/docs/vpc) where the
// internal resource lives (ex: "default").
Network string `protobuf:"bytes,3,opt,name=network,proto3" json:"network,omitempty"`
// The GCP zone the Uptime check should egress from. Only respected for
// internal Uptime checks, where internal_network is specified.
GcpZone string `protobuf:"bytes,4,opt,name=gcp_zone,json=gcpZone,proto3" json:"gcp_zone,omitempty"`
// The GCP project ID where the internal checker lives. Not necessary
// the same as the Metrics Scope project.
PeerProjectId string `protobuf:"bytes,6,opt,name=peer_project_id,json=peerProjectId,proto3" json:"peer_project_id,omitempty"`
// The current operational state of the internal checker.
State InternalChecker_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.monitoring.v3.InternalChecker_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
func (*InternalChecker) Descriptor() ([]byte, []int)
Deprecated: Use InternalChecker.ProtoReflect.Descriptor instead.
func (x *InternalChecker) GetDisplayName() string
func (x *InternalChecker) GetGcpZone() string
func (x *InternalChecker) GetName() string
func (x *InternalChecker) GetNetwork() string
func (x *InternalChecker) GetPeerProjectId() string
func (x *InternalChecker) GetState() InternalChecker_State
func (*InternalChecker) ProtoMessage()
func (x *InternalChecker) ProtoReflect() protoreflect.Message
func (x *InternalChecker) Reset()
func (x *InternalChecker) String() string
Operational states for an internal checker.
type InternalChecker_State int32
const (
// An internal checker should never be in the unspecified state.
InternalChecker_UNSPECIFIED InternalChecker_State = 0
// 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.
InternalChecker_CREATING InternalChecker_State = 1
// 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.
InternalChecker_RUNNING InternalChecker_State = 2
)
func (InternalChecker_State) Descriptor() protoreflect.EnumDescriptor
func (x InternalChecker_State) Enum() *InternalChecker_State
func (InternalChecker_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use InternalChecker_State.Descriptor instead.
func (x InternalChecker_State) Number() protoreflect.EnumNumber
func (x InternalChecker_State) String() string
func (InternalChecker_State) Type() protoreflect.EnumType
A label value.
type LabelValue struct {
// The label value can be a bool, int64, or string.
//
// Types that are assignable to Value:
//
// *LabelValue_BoolValue
// *LabelValue_Int64Value
// *LabelValue_StringValue
Value isLabelValue_Value `protobuf_oneof:"value"`
// contains filtered or unexported fields
}
func (*LabelValue) Descriptor() ([]byte, []int)
Deprecated: Use LabelValue.ProtoReflect.Descriptor instead.
func (x *LabelValue) GetBoolValue() bool
func (x *LabelValue) GetInt64Value() int64
func (x *LabelValue) GetStringValue() string
func (m *LabelValue) GetValue() isLabelValue_Value
func (*LabelValue) ProtoMessage()
func (x *LabelValue) ProtoReflect() protoreflect.Message
func (x *LabelValue) Reset()
func (x *LabelValue) String() string
type LabelValue_BoolValue struct {
// A bool label value.
BoolValue bool `protobuf:"varint,1,opt,name=bool_value,json=boolValue,proto3,oneof"`
}
type LabelValue_Int64Value struct {
// An int64 label value.
Int64Value int64 `protobuf:"varint,2,opt,name=int64_value,json=int64Value,proto3,oneof"`
}
type LabelValue_StringValue struct {
// A string label value.
StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}
The protocol for the `ListAlertPolicies` request.
type ListAlertPoliciesRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
// alert policies are to be listed. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
//
// Note that this field names the parent container in which the alerting
// policies to be listed are stored. To retrieve a single alerting policy
// by name, use the
// [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy]
// operation, instead.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
// If provided, this field specifies the criteria that must be met by
// alert policies to be included in the response.
//
// For more details, see [sorting and
// filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
// A comma-separated list of fields by which to sort the result. Supports
// the same set of field references as the `filter` field. Entries can be
// prefixed with a minus sign to sort by the field in descending order.
//
// For more details, see [sorting and
// filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// The maximum number of results to return in a single response.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return more results from the previous method call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListAlertPoliciesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListAlertPoliciesRequest.ProtoReflect.Descriptor instead.
func (x *ListAlertPoliciesRequest) GetFilter() string
func (x *ListAlertPoliciesRequest) GetName() string
func (x *ListAlertPoliciesRequest) GetOrderBy() string
func (x *ListAlertPoliciesRequest) GetPageSize() int32
func (x *ListAlertPoliciesRequest) GetPageToken() string
func (*ListAlertPoliciesRequest) ProtoMessage()
func (x *ListAlertPoliciesRequest) ProtoReflect() protoreflect.Message
func (x *ListAlertPoliciesRequest) Reset()
func (x *ListAlertPoliciesRequest) String() string
The protocol for the `ListAlertPolicies` response.
type ListAlertPoliciesResponse struct {
// The returned alert policies.
AlertPolicies []*AlertPolicy `protobuf:"bytes,3,rep,name=alert_policies,json=alertPolicies,proto3" json:"alert_policies,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of alert policies in all pages. This number is only an
// estimate, and may change in subsequent pages. https://aip.dev/158
TotalSize int32 `protobuf:"varint,4,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}
func (*ListAlertPoliciesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListAlertPoliciesResponse.ProtoReflect.Descriptor instead.
func (x *ListAlertPoliciesResponse) GetAlertPolicies() []*AlertPolicy
func (x *ListAlertPoliciesResponse) GetNextPageToken() string
func (x *ListAlertPoliciesResponse) GetTotalSize() int32
func (*ListAlertPoliciesResponse) ProtoMessage()
func (x *ListAlertPoliciesResponse) ProtoReflect() protoreflect.Message
func (x *ListAlertPoliciesResponse) Reset()
func (x *ListAlertPoliciesResponse) String() string
The `ListGroupMembers` request.
type ListGroupMembersRequest struct {
// Required. The group whose members are listed. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
// A positive number that is the maximum number of results to return.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `next_page_token` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// An optional [list
// filter](https://cloud.google.com/monitoring/api/learn_more#filtering)
// describing the members to be returned. The filter may reference the type,
// labels, and metadata of monitored resources that comprise the group. For
// example, to return only resources representing Compute Engine VM instances,
// use this filter:
//
// `resource.type = "gce_instance"`
Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
// An optional time interval for which results should be returned. Only
// members that were part of the group during the specified interval are
// included in the response. If no interval is provided then the group
// membership over the last minute is returned.
Interval *TimeInterval `protobuf:"bytes,6,opt,name=interval,proto3" json:"interval,omitempty"`
// contains filtered or unexported fields
}
func (*ListGroupMembersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListGroupMembersRequest.ProtoReflect.Descriptor instead.
func (x *ListGroupMembersRequest) GetFilter() string
func (x *ListGroupMembersRequest) GetInterval() *TimeInterval
func (x *ListGroupMembersRequest) GetName() string
func (x *ListGroupMembersRequest) GetPageSize() int32
func (x *ListGroupMembersRequest) GetPageToken() string
func (*ListGroupMembersRequest) ProtoMessage()
func (x *ListGroupMembersRequest) ProtoReflect() protoreflect.Message
func (x *ListGroupMembersRequest) Reset()
func (x *ListGroupMembersRequest) String() string
The `ListGroupMembers` response.
type ListGroupMembersResponse struct {
// A set of monitored resources in the group.
Members []*monitoredres.MonitoredResource `protobuf:"bytes,1,rep,name=members,proto3" json:"members,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of elements matching this request.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}
func (*ListGroupMembersResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListGroupMembersResponse.ProtoReflect.Descriptor instead.
func (x *ListGroupMembersResponse) GetMembers() []*monitoredres.MonitoredResource
func (x *ListGroupMembersResponse) GetNextPageToken() string
func (x *ListGroupMembersResponse) GetTotalSize() int32
func (*ListGroupMembersResponse) ProtoMessage()
func (x *ListGroupMembersResponse) ProtoReflect() protoreflect.Message
func (x *ListGroupMembersResponse) Reset()
func (x *ListGroupMembersResponse) String() string
The `ListGroup` request.
type ListGroupsRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
// groups are to be listed. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
// An optional filter consisting of a single group name. The filters limit
// the groups returned based on their parent-child relationship with the
// specified group. If no filter is specified, all groups are returned.
//
// Types that are assignable to Filter:
//
// *ListGroupsRequest_ChildrenOfGroup
// *ListGroupsRequest_AncestorsOfGroup
// *ListGroupsRequest_DescendantsOfGroup
Filter isListGroupsRequest_Filter `protobuf_oneof:"filter"`
// A positive number that is the maximum number of results to return.
PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `next_page_token` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,6,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListGroupsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListGroupsRequest.ProtoReflect.Descriptor instead.
func (x *ListGroupsRequest) GetAncestorsOfGroup() string
func (x *ListGroupsRequest) GetChildrenOfGroup() string
func (x *ListGroupsRequest) GetDescendantsOfGroup() string
func (m *ListGroupsRequest) GetFilter() isListGroupsRequest_Filter
func (x *ListGroupsRequest) GetName() string
func (x *ListGroupsRequest) GetPageSize() int32
func (x *ListGroupsRequest) GetPageToken() string
func (*ListGroupsRequest) ProtoMessage()
func (x *ListGroupsRequest) ProtoReflect() protoreflect.Message
func (x *ListGroupsRequest) Reset()
func (x *ListGroupsRequest) String() string
type ListGroupsRequest_AncestorsOfGroup struct {
// A group name. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
//
// Returns groups that are ancestors of the specified group.
// The groups are returned in order, starting with the immediate parent and
// ending with the most distant ancestor. If the specified group has no
// immediate parent, the results are empty.
AncestorsOfGroup string `protobuf:"bytes,3,opt,name=ancestors_of_group,json=ancestorsOfGroup,proto3,oneof"`
}
type ListGroupsRequest_ChildrenOfGroup struct {
// A group name. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
//
// Returns groups whose `parent_name` field contains the group
// name. If no groups have this parent, the results are empty.
ChildrenOfGroup string `protobuf:"bytes,2,opt,name=children_of_group,json=childrenOfGroup,proto3,oneof"`
}
type ListGroupsRequest_DescendantsOfGroup struct {
// A group name. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
//
// Returns the descendants of the specified group. This is a superset of
// the results returned by the `children_of_group` filter, and includes
// children-of-children, and so forth.
DescendantsOfGroup string `protobuf:"bytes,4,opt,name=descendants_of_group,json=descendantsOfGroup,proto3,oneof"`
}
The `ListGroups` response.
type ListGroupsResponse struct {
// The groups that match the specified filters.
Group []*Group `protobuf:"bytes,1,rep,name=group,proto3" json:"group,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListGroupsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListGroupsResponse.ProtoReflect.Descriptor instead.
func (x *ListGroupsResponse) GetGroup() []*Group
func (x *ListGroupsResponse) GetNextPageToken() string
func (*ListGroupsResponse) ProtoMessage()
func (x *ListGroupsResponse) ProtoReflect() protoreflect.Message
func (x *ListGroupsResponse) Reset()
func (x *ListGroupsResponse) String() string
The `ListMetricDescriptors` request.
type ListMetricDescriptorsRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
// to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
// If this field is empty, all custom and
// system-defined metric descriptors are returned.
// Otherwise, the [filter](https://cloud.google.com/monitoring/api/v3/filters)
// specifies which metric descriptors are to be
// returned. For example, the following filter matches all
// [custom metrics](https://cloud.google.com/monitoring/custom-metrics):
//
// metric.type = starts_with("custom.googleapis.com/")
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// A positive number that is the maximum number of results to return. The
// default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is
// submitted, will instead return a maximum of 10,000 results.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// 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.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListMetricDescriptorsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListMetricDescriptorsRequest.ProtoReflect.Descriptor instead.
func (x *ListMetricDescriptorsRequest) GetFilter() string
func (x *ListMetricDescriptorsRequest) GetName() string
func (x *ListMetricDescriptorsRequest) GetPageSize() int32
func (x *ListMetricDescriptorsRequest) GetPageToken() string
func (*ListMetricDescriptorsRequest) ProtoMessage()
func (x *ListMetricDescriptorsRequest) ProtoReflect() protoreflect.Message
func (x *ListMetricDescriptorsRequest) Reset()
func (x *ListMetricDescriptorsRequest) String() string
The `ListMetricDescriptors` response.
type ListMetricDescriptorsResponse struct {
// The metric descriptors that are available to the project
// and that match the value of `filter`, if present.
MetricDescriptors []*metric.MetricDescriptor `protobuf:"bytes,1,rep,name=metric_descriptors,json=metricDescriptors,proto3" json:"metric_descriptors,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListMetricDescriptorsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListMetricDescriptorsResponse.ProtoReflect.Descriptor instead.
func (x *ListMetricDescriptorsResponse) GetMetricDescriptors() []*metric.MetricDescriptor
func (x *ListMetricDescriptorsResponse) GetNextPageToken() string
func (*ListMetricDescriptorsResponse) ProtoMessage()
func (x *ListMetricDescriptorsResponse) ProtoReflect() protoreflect.Message
func (x *ListMetricDescriptorsResponse) Reset()
func (x *ListMetricDescriptorsResponse) String() string
The `ListMonitoredResourceDescriptors` request.
type ListMonitoredResourceDescriptorsRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
// to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
// An optional [filter](https://cloud.google.com/monitoring/api/v3/filters)
// describing the descriptors to be returned. The filter can reference the
// descriptor's type and labels. For example, the following filter returns
// only Google Compute Engine descriptors that have an `id` label:
//
// resource.type = starts_with("gce_") AND resource.label:id
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// A positive number that is the maximum number of results to return.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// 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.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListMonitoredResourceDescriptorsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListMonitoredResourceDescriptorsRequest.ProtoReflect.Descriptor instead.
func (x *ListMonitoredResourceDescriptorsRequest) GetFilter() string
func (x *ListMonitoredResourceDescriptorsRequest) GetName() string
func (x *ListMonitoredResourceDescriptorsRequest) GetPageSize() int32
func (x *ListMonitoredResourceDescriptorsRequest) GetPageToken() string
func (*ListMonitoredResourceDescriptorsRequest) ProtoMessage()
func (x *ListMonitoredResourceDescriptorsRequest) ProtoReflect() protoreflect.Message
func (x *ListMonitoredResourceDescriptorsRequest) Reset()
func (x *ListMonitoredResourceDescriptorsRequest) String() string
The `ListMonitoredResourceDescriptors` response.
type ListMonitoredResourceDescriptorsResponse struct {
// The monitored resource descriptors that are available to this project
// and that match `filter`, if present.
ResourceDescriptors []*monitoredres.MonitoredResourceDescriptor `protobuf:"bytes,1,rep,name=resource_descriptors,json=resourceDescriptors,proto3" json:"resource_descriptors,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListMonitoredResourceDescriptorsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListMonitoredResourceDescriptorsResponse.ProtoReflect.Descriptor instead.
func (x *ListMonitoredResourceDescriptorsResponse) GetNextPageToken() string
func (x *ListMonitoredResourceDescriptorsResponse) GetResourceDescriptors() []*monitoredres.MonitoredResourceDescriptor
func (*ListMonitoredResourceDescriptorsResponse) ProtoMessage()
func (x *ListMonitoredResourceDescriptorsResponse) ProtoReflect() protoreflect.Message
func (x *ListMonitoredResourceDescriptorsResponse) Reset()
func (x *ListMonitoredResourceDescriptorsResponse) String() string
The `ListNotificationChannelDescriptors` request.
type ListNotificationChannelDescriptorsRequest struct {
// Required. The REST resource name of the parent from which to retrieve
// the notification channel descriptors. The expected syntax is:
//
// projects/[PROJECT_ID_OR_NUMBER]
//
// Note that this
// [names](https://cloud.google.com/monitoring/api/v3#project_name) the parent
// container in which to look for the descriptors; to retrieve a single
// descriptor by name, use the
// [GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor]
// operation, instead.
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
// The maximum number of results to return in a single response. If
// not set to a positive number, a reasonable value will be chosen by the
// service.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If non-empty, `page_token` must contain a value returned as the
// `next_page_token` in a previous response to request the next set
// of results.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListNotificationChannelDescriptorsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationChannelDescriptorsRequest.ProtoReflect.Descriptor instead.
func (x *ListNotificationChannelDescriptorsRequest) GetName() string
func (x *ListNotificationChannelDescriptorsRequest) GetPageSize() int32
func (x *ListNotificationChannelDescriptorsRequest) GetPageToken() string
func (*ListNotificationChannelDescriptorsRequest) ProtoMessage()
func (x *ListNotificationChannelDescriptorsRequest) ProtoReflect() protoreflect.Message
func (x *ListNotificationChannelDescriptorsRequest) Reset()
func (x *ListNotificationChannelDescriptorsRequest) String() string
The `ListNotificationChannelDescriptors` response.
type ListNotificationChannelDescriptorsResponse struct {
// The monitored resource descriptors supported for the specified
// project, optionally filtered.
ChannelDescriptors []*NotificationChannelDescriptor `protobuf:"bytes,1,rep,name=channel_descriptors,json=channelDescriptors,proto3" json:"channel_descriptors,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListNotificationChannelDescriptorsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationChannelDescriptorsResponse.ProtoReflect.Descriptor instead.
func (x *ListNotificationChannelDescriptorsResponse) GetChannelDescriptors() []*NotificationChannelDescriptor
func (x *ListNotificationChannelDescriptorsResponse) GetNextPageToken() string
func (*ListNotificationChannelDescriptorsResponse) ProtoMessage()
func (x *ListNotificationChannelDescriptorsResponse) ProtoReflect() protoreflect.Message
func (x *ListNotificationChannelDescriptorsResponse) Reset()
func (x *ListNotificationChannelDescriptorsResponse) String() string
The `ListNotificationChannels` request.
type ListNotificationChannelsRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
// to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
//
// This names the container
// in which to look for the notification channels; it does not name a
// specific channel. To query a specific channel by REST resource name, use
// the
// [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel]
// operation.
Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
// If provided, this field specifies the criteria that must be met by
// notification channels to be included in the response.
//
// For more details, see [sorting and
// filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
Filter string `protobuf:"bytes,6,opt,name=filter,proto3" json:"filter,omitempty"`
// A comma-separated list of fields by which to sort the result. Supports
// the same set of fields as in `filter`. Entries can be prefixed with
// a minus sign to sort in descending rather than ascending order.
//
// For more details, see [sorting and
// filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
OrderBy string `protobuf:"bytes,7,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// The maximum number of results to return in a single response. If
// not set to a positive number, a reasonable value will be chosen by the
// service.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If non-empty, `page_token` must contain a value returned as the
// `next_page_token` in a previous response to request the next set
// of results.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListNotificationChannelsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationChannelsRequest.ProtoReflect.Descriptor instead.
func (x *ListNotificationChannelsRequest) GetFilter() string
func (x *ListNotificationChannelsRequest) GetName() string
func (x *ListNotificationChannelsRequest) GetOrderBy() string
func (x *ListNotificationChannelsRequest) GetPageSize() int32
func (x *ListNotificationChannelsRequest) GetPageToken() string
func (*ListNotificationChannelsRequest) ProtoMessage()
func (x *ListNotificationChannelsRequest) ProtoReflect() protoreflect.Message
func (x *ListNotificationChannelsRequest) Reset()
func (x *ListNotificationChannelsRequest) String() string
The `ListNotificationChannels` response.
type ListNotificationChannelsResponse struct {
// The notification channels defined for the specified project.
NotificationChannels []*NotificationChannel `protobuf:"bytes,3,rep,name=notification_channels,json=notificationChannels,proto3" json:"notification_channels,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of notification channels in all pages. This number is only
// an estimate, and may change in subsequent pages. https://aip.dev/158
TotalSize int32 `protobuf:"varint,4,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}
func (*ListNotificationChannelsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListNotificationChannelsResponse.ProtoReflect.Descriptor instead.
func (x *ListNotificationChannelsResponse) GetNextPageToken() string
func (x *ListNotificationChannelsResponse) GetNotificationChannels() []*NotificationChannel
func (x *ListNotificationChannelsResponse) GetTotalSize() int32
func (*ListNotificationChannelsResponse) ProtoMessage()
func (x *ListNotificationChannelsResponse) ProtoReflect() protoreflect.Message
func (x *ListNotificationChannelsResponse) Reset()
func (x *ListNotificationChannelsResponse) String() string
The `ListServiceLevelObjectives` request.
type ListServiceLevelObjectivesRequest struct {
// Required. Resource name of the parent containing the listed SLOs, either a
// project or a Monitoring Metrics Scope. The formats are:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
// workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// A filter specifying what `ServiceLevelObjective`s to return.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// A non-negative number that is the maximum number of results to return.
// When 0, use default page size.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// 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.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// View of the `ServiceLevelObjective`s to return. If `DEFAULT`, return each
// `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the
// `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the
// `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.
View ServiceLevelObjective_View `protobuf:"varint,5,opt,name=view,proto3,enum=google.monitoring.v3.ServiceLevelObjective_View" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*ListServiceLevelObjectivesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListServiceLevelObjectivesRequest.ProtoReflect.Descriptor instead.
func (x *ListServiceLevelObjectivesRequest) GetFilter() string
func (x *ListServiceLevelObjectivesRequest) GetPageSize() int32
func (x *ListServiceLevelObjectivesRequest) GetPageToken() string
func (x *ListServiceLevelObjectivesRequest) GetParent() string
func (x *ListServiceLevelObjectivesRequest) GetView() ServiceLevelObjective_View
func (*ListServiceLevelObjectivesRequest) ProtoMessage()
func (x *ListServiceLevelObjectivesRequest) ProtoReflect() protoreflect.Message
func (x *ListServiceLevelObjectivesRequest) Reset()
func (x *ListServiceLevelObjectivesRequest) String() string
The `ListServiceLevelObjectives` response.
type ListServiceLevelObjectivesResponse struct {
// The `ServiceLevelObjective`s matching the specified filter.
ServiceLevelObjectives []*ServiceLevelObjective `protobuf:"bytes,1,rep,name=service_level_objectives,json=serviceLevelObjectives,proto3" json:"service_level_objectives,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListServiceLevelObjectivesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListServiceLevelObjectivesResponse.ProtoReflect.Descriptor instead.
func (x *ListServiceLevelObjectivesResponse) GetNextPageToken() string
func (x *ListServiceLevelObjectivesResponse) GetServiceLevelObjectives() []*ServiceLevelObjective
func (*ListServiceLevelObjectivesResponse) ProtoMessage()
func (x *ListServiceLevelObjectivesResponse) ProtoReflect() protoreflect.Message
func (x *ListServiceLevelObjectivesResponse) Reset()
func (x *ListServiceLevelObjectivesResponse) String() string
The `ListServices` request.
type ListServicesRequest struct {
// Required. Resource name of the parent containing the listed services,
// either a [project](https://cloud.google.com/monitoring/api/v3#project_name)
// or a Monitoring Metrics Scope. The formats are:
//
// projects/[PROJECT_ID_OR_NUMBER]
// workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// A filter specifying what `Service`s to return. The filter supports
// filtering on a particular service-identifier type or one of its attributes.
//
// To filter on a particular service-identifier type, the `identifier_case`
// refers to which option in the `identifier` field is populated. For example,
// the filter `identifier_case = "CUSTOM"` would match all services with a
// value for the `custom` field. Valid options include "CUSTOM", "APP_ENGINE",
// "MESH_ISTIO", and the other options listed at
// https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
//
// To filter on an attribute of a service-identifier type, apply the filter
// name by using the snake case of the service-identifier type and the
// attribute of that service-identifier type, and join the two with a period.
// For example, to filter by the `meshUid` field of the `MeshIstio`
// service-identifier type, you must filter on `mesh_istio.mesh_uid =
// "123"` to match all services with mesh UID "123". Service-identifier types
// and their attributes are described at
// https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// A non-negative number that is the maximum number of results to return.
// When 0, use default page size.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// 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.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListServicesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListServicesRequest.ProtoReflect.Descriptor instead.
func (x *ListServicesRequest) GetFilter() string
func (x *ListServicesRequest) GetPageSize() int32
func (x *ListServicesRequest) GetPageToken() string
func (x *ListServicesRequest) GetParent() string
func (*ListServicesRequest) ProtoMessage()
func (x *ListServicesRequest) ProtoReflect() protoreflect.Message
func (x *ListServicesRequest) Reset()
func (x *ListServicesRequest) String() string
The `ListServices` response.
type ListServicesResponse struct {
// The `Service`s matching the specified filter.
Services []*Service `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListServicesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListServicesResponse.ProtoReflect.Descriptor instead.
func (x *ListServicesResponse) GetNextPageToken() string
func (x *ListServicesResponse) GetServices() []*Service
func (*ListServicesResponse) ProtoMessage()
func (x *ListServicesResponse) ProtoReflect() protoreflect.Message
func (x *ListServicesResponse) Reset()
func (x *ListServicesResponse) String() string
The message definition for listing `Snooze`s associated with the given `parent`, satisfying the optional `filter`.
type ListSnoozesRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
// `Snooze`s should be listed. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Optional filter to restrict results to the given criteria. The
// following fields are supported.
//
// - `interval.start_time`
// - `interval.end_time`
//
// For example:
//
// ```
// interval.start_time > "2022-03-11T00:00:00-08:00" AND
// interval.end_time < "2022-03-12T00:00:00-08:00"
// ```
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. The maximum number of results to return for a single query. The
// server may further constrain the maximum number of results returned in a
// single page. The value should be in the range [1, 1000]. If the value given
// is outside this range, the server will decide the number of results to be
// returned.
PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The `next_page_token` from a previous call to
// `ListSnoozesRequest` to get the next page of results.
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListSnoozesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSnoozesRequest.ProtoReflect.Descriptor instead.
func (x *ListSnoozesRequest) GetFilter() string
func (x *ListSnoozesRequest) GetPageSize() int32
func (x *ListSnoozesRequest) GetPageToken() string
func (x *ListSnoozesRequest) GetParent() string
func (*ListSnoozesRequest) ProtoMessage()
func (x *ListSnoozesRequest) ProtoReflect() protoreflect.Message
func (x *ListSnoozesRequest) Reset()
func (x *ListSnoozesRequest) String() string
The results of a successful `ListSnoozes` call, containing the matching `Snooze`s.
type ListSnoozesResponse struct {
// `Snooze`s matching this list call.
Snoozes []*Snooze `protobuf:"bytes,1,rep,name=snoozes,proto3" json:"snoozes,omitempty"`
// Page token for repeated calls to `ListSnoozes`, to fetch additional pages
// of results. If this is empty or missing, there are no more pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListSnoozesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSnoozesResponse.ProtoReflect.Descriptor instead.
func (x *ListSnoozesResponse) GetNextPageToken() string
func (x *ListSnoozesResponse) GetSnoozes() []*Snooze
func (*ListSnoozesResponse) ProtoMessage()
func (x *ListSnoozesResponse) ProtoReflect() protoreflect.Message
func (x *ListSnoozesResponse) Reset()
func (x *ListSnoozesResponse) String() string
The `ListTimeSeries` request.
type ListTimeSeriesRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name),
// organization or folder on which to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
// organizations/[ORGANIZATION_ID]
// folders/[FOLDER_ID]
Name string `protobuf:"bytes,10,opt,name=name,proto3" json:"name,omitempty"`
// Required. A [monitoring
// filter](https://cloud.google.com/monitoring/api/v3/filters) that specifies
// which time series should be returned. The filter must specify a single
// metric type, and can additionally specify metric labels and other
// information. For example:
//
// metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
// metric.labels.instance_name = "my-instance-name"
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Required. The time interval for which results should be returned. Only time
// series that contain data points in the specified interval are included in
// the response.
Interval *TimeInterval `protobuf:"bytes,4,opt,name=interval,proto3" json:"interval,omitempty"`
// Specifies the alignment of data points in individual time series as
// well as how to combine the retrieved time series across specified labels.
//
// By default (if no `aggregation` is explicitly specified), the raw time
// series data is returned.
Aggregation *Aggregation `protobuf:"bytes,5,opt,name=aggregation,proto3" json:"aggregation,omitempty"`
// Apply a second aggregation after `aggregation` is applied. May only be
// specified if `aggregation` is specified.
SecondaryAggregation *Aggregation `protobuf:"bytes,11,opt,name=secondary_aggregation,json=secondaryAggregation,proto3" json:"secondary_aggregation,omitempty"`
// Unsupported: must be left blank. The points in each time series are
// currently returned in reverse time order (most recent to oldest).
OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// Required. Specifies which information is returned about the time series.
View ListTimeSeriesRequest_TimeSeriesView `protobuf:"varint,7,opt,name=view,proto3,enum=google.monitoring.v3.ListTimeSeriesRequest_TimeSeriesView" json:"view,omitempty"`
// A positive number that is the maximum number of results to return. If
// `page_size` is empty or more than 100,000 results, the effective
// `page_size` is 100,000 results. If `view` is set to `FULL`, this is the
// maximum number of `Points` returned. If `view` is set to `HEADERS`, this is
// the maximum number of `TimeSeries` returned.
PageSize int32 `protobuf:"varint,8,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// 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.
PageToken string `protobuf:"bytes,9,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListTimeSeriesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTimeSeriesRequest.ProtoReflect.Descriptor instead.
func (x *ListTimeSeriesRequest) GetAggregation() *Aggregation
func (x *ListTimeSeriesRequest) GetFilter() string
func (x *ListTimeSeriesRequest) GetInterval() *TimeInterval
func (x *ListTimeSeriesRequest) GetName() string
func (x *ListTimeSeriesRequest) GetOrderBy() string
func (x *ListTimeSeriesRequest) GetPageSize() int32
func (x *ListTimeSeriesRequest) GetPageToken() string
func (x *ListTimeSeriesRequest) GetSecondaryAggregation() *Aggregation
func (x *ListTimeSeriesRequest) GetView() ListTimeSeriesRequest_TimeSeriesView
func (*ListTimeSeriesRequest) ProtoMessage()
func (x *ListTimeSeriesRequest) ProtoReflect() protoreflect.Message
func (x *ListTimeSeriesRequest) Reset()
func (x *ListTimeSeriesRequest) String() string
Controls which fields are returned by `ListTimeSeries*`.
type ListTimeSeriesRequest_TimeSeriesView int32
const (
// Returns the identity of the metric(s), the time series,
// and the time series data.
ListTimeSeriesRequest_FULL ListTimeSeriesRequest_TimeSeriesView = 0
// Returns the identity of the metric and the time series resource,
// but not the time series data.
ListTimeSeriesRequest_HEADERS ListTimeSeriesRequest_TimeSeriesView = 1
)
func (ListTimeSeriesRequest_TimeSeriesView) Descriptor() protoreflect.EnumDescriptor
func (x ListTimeSeriesRequest_TimeSeriesView) Enum() *ListTimeSeriesRequest_TimeSeriesView
func (ListTimeSeriesRequest_TimeSeriesView) EnumDescriptor() ([]byte, []int)
Deprecated: Use ListTimeSeriesRequest_TimeSeriesView.Descriptor instead.
func (x ListTimeSeriesRequest_TimeSeriesView) Number() protoreflect.EnumNumber
func (x ListTimeSeriesRequest_TimeSeriesView) String() string
func (ListTimeSeriesRequest_TimeSeriesView) Type() protoreflect.EnumType
The `ListTimeSeries` response.
type ListTimeSeriesResponse struct {
// One or more time series that match the filter included in the request.
TimeSeries []*TimeSeries `protobuf:"bytes,1,rep,name=time_series,json=timeSeries,proto3" json:"time_series,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Query execution errors that may have caused the time series data returned
// to be incomplete.
ExecutionErrors []*status.Status `protobuf:"bytes,3,rep,name=execution_errors,json=executionErrors,proto3" json:"execution_errors,omitempty"`
// 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}".
Unit string `protobuf:"bytes,5,opt,name=unit,proto3" json:"unit,omitempty"`
// contains filtered or unexported fields
}
func (*ListTimeSeriesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTimeSeriesResponse.ProtoReflect.Descriptor instead.
func (x *ListTimeSeriesResponse) GetExecutionErrors() []*status.Status
func (x *ListTimeSeriesResponse) GetNextPageToken() string
func (x *ListTimeSeriesResponse) GetTimeSeries() []*TimeSeries
func (x *ListTimeSeriesResponse) GetUnit() string
func (*ListTimeSeriesResponse) ProtoMessage()
func (x *ListTimeSeriesResponse) ProtoReflect() protoreflect.Message
func (x *ListTimeSeriesResponse) Reset()
func (x *ListTimeSeriesResponse) String() string
The protocol for the `ListUptimeCheckConfigs` request.
type ListUptimeCheckConfigsRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
// Uptime check configurations are listed. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// If provided, this field specifies the criteria that must be met by
// uptime checks to be included in the response.
//
// For more details, see [Filtering
// syntax](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// The maximum number of results to return in a single response. The server
// may further constrain the maximum number of results returned in a single
// page. If the page_size is <=0, the server will decide the number of results
// to be returned.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return more results from the previous method call.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListUptimeCheckConfigsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListUptimeCheckConfigsRequest.ProtoReflect.Descriptor instead.
func (x *ListUptimeCheckConfigsRequest) GetFilter() string
func (x *ListUptimeCheckConfigsRequest) GetPageSize() int32
func (x *ListUptimeCheckConfigsRequest) GetPageToken() string
func (x *ListUptimeCheckConfigsRequest) GetParent() string
func (*ListUptimeCheckConfigsRequest) ProtoMessage()
func (x *ListUptimeCheckConfigsRequest) ProtoReflect() protoreflect.Message
func (x *ListUptimeCheckConfigsRequest) Reset()
func (x *ListUptimeCheckConfigsRequest) String() string
The protocol for the `ListUptimeCheckConfigs` response.
type ListUptimeCheckConfigsResponse struct {
// The returned Uptime check configurations.
UptimeCheckConfigs []*UptimeCheckConfig `protobuf:"bytes,1,rep,name=uptime_check_configs,json=uptimeCheckConfigs,proto3" json:"uptime_check_configs,omitempty"`
// 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).
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of Uptime check configurations for the project,
// irrespective of any pagination.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}
func (*ListUptimeCheckConfigsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListUptimeCheckConfigsResponse.ProtoReflect.Descriptor instead.
func (x *ListUptimeCheckConfigsResponse) GetNextPageToken() string
func (x *ListUptimeCheckConfigsResponse) GetTotalSize() int32
func (x *ListUptimeCheckConfigsResponse) GetUptimeCheckConfigs() []*UptimeCheckConfig
func (*ListUptimeCheckConfigsResponse) ProtoMessage()
func (x *ListUptimeCheckConfigsResponse) ProtoReflect() protoreflect.Message
func (x *ListUptimeCheckConfigsResponse) Reset()
func (x *ListUptimeCheckConfigsResponse) String() string
The protocol for the `ListUptimeCheckIps` request.
type ListUptimeCheckIpsRequest struct {
// The maximum number of results to return in a single response. The server
// may further constrain the maximum number of results returned in a single
// page. If the page_size is <=0, the server will decide the number of results
// to be returned.
// NOTE: this field is not yet implemented
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return more results from the previous method call.
// NOTE: this field is not yet implemented
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListUptimeCheckIpsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListUptimeCheckIpsRequest.ProtoReflect.Descriptor instead.
func (x *ListUptimeCheckIpsRequest) GetPageSize() int32
func (x *ListUptimeCheckIpsRequest) GetPageToken() string
func (*ListUptimeCheckIpsRequest) ProtoMessage()
func (x *ListUptimeCheckIpsRequest) ProtoReflect() protoreflect.Message
func (x *ListUptimeCheckIpsRequest) Reset()
func (x *ListUptimeCheckIpsRequest) String() string
The protocol for the `ListUptimeCheckIps` response.
type ListUptimeCheckIpsResponse struct {
// The returned list of IP addresses (including region and location) that the
// checkers run from.
UptimeCheckIps []*UptimeCheckIp `protobuf:"bytes,1,rep,name=uptime_check_ips,json=uptimeCheckIps,proto3" json:"uptime_check_ips,omitempty"`
// 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 implemented
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListUptimeCheckIpsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListUptimeCheckIpsResponse.ProtoReflect.Descriptor instead.
func (x *ListUptimeCheckIpsResponse) GetNextPageToken() string
func (x *ListUptimeCheckIpsResponse) GetUptimeCheckIps() []*UptimeCheckIp
func (*ListUptimeCheckIpsResponse) ProtoMessage()
func (x *ListUptimeCheckIpsResponse) ProtoReflect() protoreflect.Message
func (x *ListUptimeCheckIpsResponse) Reset()
func (x *ListUptimeCheckIpsResponse) String() string
MetricServiceClient is the client API for MetricService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type MetricServiceClient interface {
// Lists monitored resource descriptors that match a filter.
ListMonitoredResourceDescriptors(ctx context.Context, in *ListMonitoredResourceDescriptorsRequest, opts ...grpc.CallOption) (*ListMonitoredResourceDescriptorsResponse, error)
// Gets a single monitored resource descriptor.
GetMonitoredResourceDescriptor(ctx context.Context, in *GetMonitoredResourceDescriptorRequest, opts ...grpc.CallOption) (*monitoredres.MonitoredResourceDescriptor, error)
// Lists metric descriptors that match a filter.
ListMetricDescriptors(ctx context.Context, in *ListMetricDescriptorsRequest, opts ...grpc.CallOption) (*ListMetricDescriptorsResponse, error)
// Gets a single metric descriptor.
GetMetricDescriptor(ctx context.Context, in *GetMetricDescriptorRequest, opts ...grpc.CallOption) (*metric.MetricDescriptor, error)
// Creates a new metric descriptor.
// The creation is executed asynchronously.
// User-created metric descriptors define
// [custom metrics](https://cloud.google.com/monitoring/custom-metrics).
// The metric descriptor is updated if it already exists,
// except that metric labels are never removed.
CreateMetricDescriptor(ctx context.Context, in *CreateMetricDescriptorRequest, opts ...grpc.CallOption) (*metric.MetricDescriptor, error)
// Deletes a metric descriptor. Only user-created
// [custom metrics](https://cloud.google.com/monitoring/custom-metrics) can be
// deleted.
DeleteMetricDescriptor(ctx context.Context, in *DeleteMetricDescriptorRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists time series that match a filter.
ListTimeSeries(ctx context.Context, in *ListTimeSeriesRequest, opts ...grpc.CallOption) (*ListTimeSeriesResponse, error)
// Creates or adds data to one or more time series.
// The response is empty if all time series in the request were written.
// If any time series could not be written, a corresponding failure message is
// included in the error response.
// This method does not support
// [resource locations constraint of an organization
// policy](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy).
CreateTimeSeries(ctx context.Context, in *CreateTimeSeriesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Creates or adds data to one or more service time series. A service time
// series is a time series for a metric from a Google Cloud service. The
// response is empty if all time series in the request were written. If any
// time series could not be written, a corresponding failure message is
// included in the error response. This endpoint rejects writes to
// user-defined metrics.
// This method is only for use by Google Cloud services. Use
// [projects.timeSeries.create][google.monitoring.v3.MetricService.CreateTimeSeries]
// instead.
CreateServiceTimeSeries(ctx context.Context, in *CreateTimeSeriesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}
func NewMetricServiceClient(cc grpc.ClientConnInterface) MetricServiceClient
MetricServiceServer is the server API for MetricService service.
type MetricServiceServer interface {
// Lists monitored resource descriptors that match a filter.
ListMonitoredResourceDescriptors(context.Context, *ListMonitoredResourceDescriptorsRequest) (*ListMonitoredResourceDescriptorsResponse, error)
// Gets a single monitored resource descriptor.
GetMonitoredResourceDescriptor(context.Context, *GetMonitoredResourceDescriptorRequest) (*monitoredres.MonitoredResourceDescriptor, error)
// Lists metric descriptors that match a filter.
ListMetricDescriptors(context.Context, *ListMetricDescriptorsRequest) (*ListMetricDescriptorsResponse, error)
// Gets a single metric descriptor.
GetMetricDescriptor(context.Context, *GetMetricDescriptorRequest) (*metric.MetricDescriptor, error)
// Creates a new metric descriptor.
// The creation is executed asynchronously.
// User-created metric descriptors define
// [custom metrics](https://cloud.google.com/monitoring/custom-metrics).
// The metric descriptor is updated if it already exists,
// except that metric labels are never removed.
CreateMetricDescriptor(context.Context, *CreateMetricDescriptorRequest) (*metric.MetricDescriptor, error)
// Deletes a metric descriptor. Only user-created
// [custom metrics](https://cloud.google.com/monitoring/custom-metrics) can be
// deleted.
DeleteMetricDescriptor(context.Context, *DeleteMetricDescriptorRequest) (*emptypb.Empty, error)
// Lists time series that match a filter.
ListTimeSeries(context.Context, *ListTimeSeriesRequest) (*ListTimeSeriesResponse, error)
// Creates or adds data to one or more time series.
// The response is empty if all time series in the request were written.
// If any time series could not be written, a corresponding failure message is
// included in the error response.
// This method does not support
// [resource locations constraint of an organization
// policy](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy).
CreateTimeSeries(context.Context, *CreateTimeSeriesRequest) (*emptypb.Empty, error)
// Creates or adds data to one or more service time series. A service time
// series is a time series for a metric from a Google Cloud service. The
// response is empty if all time series in the request were written. If any
// time series could not be written, a corresponding failure message is
// included in the error response. This endpoint rejects writes to
// user-defined metrics.
// This method is only for use by Google Cloud services. Use
// [projects.timeSeries.create][google.monitoring.v3.MetricService.CreateTimeSeries]
// instead.
CreateServiceTimeSeries(context.Context, *CreateTimeSeriesRequest) (*emptypb.Empty, error)
}
Describes a change made to a configuration.
type MutationRecord struct {
// When the change occurred.
MutateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=mutate_time,json=mutateTime,proto3" json:"mutate_time,omitempty"`
// The email address of the user making the change.
MutatedBy string `protobuf:"bytes,2,opt,name=mutated_by,json=mutatedBy,proto3" json:"mutated_by,omitempty"`
// contains filtered or unexported fields
}
func (*MutationRecord) Descriptor() ([]byte, []int)
Deprecated: Use MutationRecord.ProtoReflect.Descriptor instead.
func (x *MutationRecord) GetMutateTime() *timestamppb.Timestamp
func (x *MutationRecord) GetMutatedBy() string
func (*MutationRecord) ProtoMessage()
func (x *MutationRecord) ProtoReflect() protoreflect.Message
func (x *MutationRecord) Reset()
func (x *MutationRecord) String() string
A `NotificationChannel` is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.
type NotificationChannel struct {
// The type of the notification channel. This field matches the
// value of the
// [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type]
// field.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// 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.
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// 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.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// 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.
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Configuration fields that define the channel and its behavior. The
// permissible and required labels are specified in the
// [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels]
// of the `NotificationChannelDescriptor` corresponding to the `type` field.
Labels map[string]string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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 `protobuf:"bytes,8,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Indicates whether this channel has been verified or not. On a
// [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
// or
// [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.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`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel]
// operation. To change the value of this field, you must call
// [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel].
VerificationStatus NotificationChannel_VerificationStatus `protobuf:"varint,9,opt,name=verification_status,json=verificationStatus,proto3,enum=google.monitoring.v3.NotificationChannel_VerificationStatus" json:"verification_status,omitempty"`
// 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.
Enabled *wrapperspb.BoolValue `protobuf:"bytes,11,opt,name=enabled,proto3" json:"enabled,omitempty"`
// Record of the creation of this channel.
CreationRecord *MutationRecord `protobuf:"bytes,12,opt,name=creation_record,json=creationRecord,proto3" json:"creation_record,omitempty"`
// Records of the modification of this channel.
MutationRecords []*MutationRecord `protobuf:"bytes,13,rep,name=mutation_records,json=mutationRecords,proto3" json:"mutation_records,omitempty"`
// contains filtered or unexported fields
}
func (*NotificationChannel) Descriptor() ([]byte, []int)
Deprecated: Use NotificationChannel.ProtoReflect.Descriptor instead.
func (x *NotificationChannel) GetCreationRecord() *MutationRecord
func (x *NotificationChannel) GetDescription() string
func (x *NotificationChannel) GetDisplayName() string
func (x *NotificationChannel) GetEnabled() *wrapperspb.BoolValue
func (x *NotificationChannel) GetLabels() map[string]string
func (x *NotificationChannel) GetMutationRecords() []*MutationRecord
func (x *NotificationChannel) GetName() string
func (x *NotificationChannel) GetType() string
func (x *NotificationChannel) GetUserLabels() map[string]string
func (x *NotificationChannel) GetVerificationStatus() NotificationChannel_VerificationStatus
func (*NotificationChannel) ProtoMessage()
func (x *NotificationChannel) ProtoReflect() protoreflect.Message
func (x *NotificationChannel) Reset()
func (x *NotificationChannel) String() string
A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.
type NotificationChannelDescriptor struct {
// 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.
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// 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.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// A human-readable name for the notification channel type. This
// form of the name is suitable for a user interface.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// 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.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// 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 []*label.LabelDescriptor `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty"`
// The tiers that support this notification channel; the project service tier
// must be one of the supported_tiers.
//
// Deprecated: Marked as deprecated in google/monitoring/v3/notification.proto.
SupportedTiers []ServiceTier `protobuf:"varint,5,rep,packed,name=supported_tiers,json=supportedTiers,proto3,enum=google.monitoring.v3.ServiceTier" json:"supported_tiers,omitempty"`
// The product launch stage for channels of this type.
LaunchStage api.LaunchStage `protobuf:"varint,7,opt,name=launch_stage,json=launchStage,proto3,enum=google.api.LaunchStage" json:"launch_stage,omitempty"`
// contains filtered or unexported fields
}
func (*NotificationChannelDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use NotificationChannelDescriptor.ProtoReflect.Descriptor instead.
func (x *NotificationChannelDescriptor) GetDescription() string
func (x *NotificationChannelDescriptor) GetDisplayName() string
func (x *NotificationChannelDescriptor) GetLabels() []*label.LabelDescriptor
func (x *NotificationChannelDescriptor) GetLaunchStage() api.LaunchStage
func (x *NotificationChannelDescriptor) GetName() string
func (x *NotificationChannelDescriptor) GetSupportedTiers() []ServiceTier
Deprecated: Marked as deprecated in google/monitoring/v3/notification.proto.
func (x *NotificationChannelDescriptor) GetType() string
func (*NotificationChannelDescriptor) ProtoMessage()
func (x *NotificationChannelDescriptor) ProtoReflect() protoreflect.Message
func (x *NotificationChannelDescriptor) Reset()
func (x *NotificationChannelDescriptor) String() string
NotificationChannelServiceClient is the client API for NotificationChannelService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type NotificationChannelServiceClient interface {
// Lists the descriptors for supported channel types. The use of descriptors
// makes it possible for new channel types to be dynamically added.
ListNotificationChannelDescriptors(ctx context.Context, in *ListNotificationChannelDescriptorsRequest, opts ...grpc.CallOption) (*ListNotificationChannelDescriptorsResponse, error)
// Gets a single channel descriptor. The descriptor indicates which fields
// are expected / permitted for a notification channel of the given type.
GetNotificationChannelDescriptor(ctx context.Context, in *GetNotificationChannelDescriptorRequest, opts ...grpc.CallOption) (*NotificationChannelDescriptor, error)
// Lists the notification channels that have been created for the project.
// To list the types of notification channels that are supported, use
// the `ListNotificationChannelDescriptors` method.
ListNotificationChannels(ctx context.Context, in *ListNotificationChannelsRequest, opts ...grpc.CallOption) (*ListNotificationChannelsResponse, error)
// Gets a single notification channel. The channel includes the relevant
// configuration details with which the channel was created. However, the
// response may truncate or omit passwords, API keys, or other private key
// matter and thus the response may not be 100% identical to the information
// that was supplied in the call to the create method.
GetNotificationChannel(ctx context.Context, in *GetNotificationChannelRequest, opts ...grpc.CallOption) (*NotificationChannel, error)
// Creates a new notification channel, representing a single notification
// endpoint such as an email address, SMS number, or PagerDuty service.
//
// Design your application to single-thread API calls that modify the state of
// notification channels in a single project. This includes calls to
// CreateNotificationChannel, DeleteNotificationChannel and
// UpdateNotificationChannel.
CreateNotificationChannel(ctx context.Context, in *CreateNotificationChannelRequest, opts ...grpc.CallOption) (*NotificationChannel, error)
// Updates a notification channel. Fields not specified in the field mask
// remain unchanged.
//
// Design your application to single-thread API calls that modify the state of
// notification channels in a single project. This includes calls to
// CreateNotificationChannel, DeleteNotificationChannel and
// UpdateNotificationChannel.
UpdateNotificationChannel(ctx context.Context, in *UpdateNotificationChannelRequest, opts ...grpc.CallOption) (*NotificationChannel, error)
// Deletes a notification channel.
//
// Design your application to single-thread API calls that modify the state of
// notification channels in a single project. This includes calls to
// CreateNotificationChannel, DeleteNotificationChannel and
// UpdateNotificationChannel.
DeleteNotificationChannel(ctx context.Context, in *DeleteNotificationChannelRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Causes a verification code to be delivered to the channel. The code
// can then be supplied in `VerifyNotificationChannel` to verify the channel.
SendNotificationChannelVerificationCode(ctx context.Context, in *SendNotificationChannelVerificationCodeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Requests a verification code for an already verified channel that can then
// be used in a call to VerifyNotificationChannel() on a different channel
// with an equivalent identity in the same or in a different project. This
// makes it possible to copy a channel between projects without requiring
// manual reverification of the channel. If the channel is not in the
// verified state, this method will fail (in other words, this may only be
// used if the SendNotificationChannelVerificationCode and
// VerifyNotificationChannel paths have already been used to put the given
// channel into the verified state).
//
// There is no guarantee that the verification codes returned by this method
// will be of a similar structure or form as the ones that are delivered
// to the channel via SendNotificationChannelVerificationCode; while
// VerifyNotificationChannel() will recognize both the codes delivered via
// SendNotificationChannelVerificationCode() and returned from
// GetNotificationChannelVerificationCode(), it is typically the case that
// the verification 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 much longer, websafe base
// 64 encoded string that has a longer expiration time.
GetNotificationChannelVerificationCode(ctx context.Context, in *GetNotificationChannelVerificationCodeRequest, opts ...grpc.CallOption) (*GetNotificationChannelVerificationCodeResponse, error)
// Verifies a `NotificationChannel` by proving receipt of the code
// delivered to the channel as a result of calling
// `SendNotificationChannelVerificationCode`.
VerifyNotificationChannel(ctx context.Context, in *VerifyNotificationChannelRequest, opts ...grpc.CallOption) (*NotificationChannel, error)
}
func NewNotificationChannelServiceClient(cc grpc.ClientConnInterface) NotificationChannelServiceClient
NotificationChannelServiceServer is the server API for NotificationChannelService service.
type NotificationChannelServiceServer interface {
// Lists the descriptors for supported channel types. The use of descriptors
// makes it possible for new channel types to be dynamically added.
ListNotificationChannelDescriptors(context.Context, *ListNotificationChannelDescriptorsRequest) (*ListNotificationChannelDescriptorsResponse, error)
// Gets a single channel descriptor. The descriptor indicates which fields
// are expected / permitted for a notification channel of the given type.
GetNotificationChannelDescriptor(context.Context, *GetNotificationChannelDescriptorRequest) (*NotificationChannelDescriptor, error)
// Lists the notification channels that have been created for the project.
// To list the types of notification channels that are supported, use
// the `ListNotificationChannelDescriptors` method.
ListNotificationChannels(context.Context, *ListNotificationChannelsRequest) (*ListNotificationChannelsResponse, error)
// Gets a single notification channel. The channel includes the relevant
// configuration details with which the channel was created. However, the
// response may truncate or omit passwords, API keys, or other private key
// matter and thus the response may not be 100% identical to the information
// that was supplied in the call to the create method.
GetNotificationChannel(context.Context, *GetNotificationChannelRequest) (*NotificationChannel, error)
// Creates a new notification channel, representing a single notification
// endpoint such as an email address, SMS number, or PagerDuty service.
//
// Design your application to single-thread API calls that modify the state of
// notification channels in a single project. This includes calls to
// CreateNotificationChannel, DeleteNotificationChannel and
// UpdateNotificationChannel.
CreateNotificationChannel(context.Context, *CreateNotificationChannelRequest) (*NotificationChannel, error)
// Updates a notification channel. Fields not specified in the field mask
// remain unchanged.
//
// Design your application to single-thread API calls that modify the state of
// notification channels in a single project. This includes calls to
// CreateNotificationChannel, DeleteNotificationChannel and
// UpdateNotificationChannel.
UpdateNotificationChannel(context.Context, *UpdateNotificationChannelRequest) (*NotificationChannel, error)
// Deletes a notification channel.
//
// Design your application to single-thread API calls that modify the state of
// notification channels in a single project. This includes calls to
// CreateNotificationChannel, DeleteNotificationChannel and
// UpdateNotificationChannel.
DeleteNotificationChannel(context.Context, *DeleteNotificationChannelRequest) (*emptypb.Empty, error)
// Causes a verification code to be delivered to the channel. The code
// can then be supplied in `VerifyNotificationChannel` to verify the channel.
SendNotificationChannelVerificationCode(context.Context, *SendNotificationChannelVerificationCodeRequest) (*emptypb.Empty, error)
// Requests a verification code for an already verified channel that can then
// be used in a call to VerifyNotificationChannel() on a different channel
// with an equivalent identity in the same or in a different project. This
// makes it possible to copy a channel between projects without requiring
// manual reverification of the channel. If the channel is not in the
// verified state, this method will fail (in other words, this may only be
// used if the SendNotificationChannelVerificationCode and
// VerifyNotificationChannel paths have already been used to put the given
// channel into the verified state).
//
// There is no guarantee that the verification codes returned by this method
// will be of a similar structure or form as the ones that are delivered
// to the channel via SendNotificationChannelVerificationCode; while
// VerifyNotificationChannel() will recognize both the codes delivered via
// SendNotificationChannelVerificationCode() and returned from
// GetNotificationChannelVerificationCode(), it is typically the case that
// the verification 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 much longer, websafe base
// 64 encoded string that has a longer expiration time.
GetNotificationChannelVerificationCode(context.Context, *GetNotificationChannelVerificationCodeRequest) (*GetNotificationChannelVerificationCodeResponse, error)
// Verifies a `NotificationChannel` by proving receipt of the code
// delivered to the channel as a result of calling
// `SendNotificationChannelVerificationCode`.
VerifyNotificationChannel(context.Context, *VerifyNotificationChannelRequest) (*NotificationChannel, error)
}
Indicates whether the channel has been verified or not. It is illegal to specify this field in a [`CreateNotificationChannel`][google.monitoring.v3.NotificationChannelService.CreateNotificationChannel] or an [`UpdateNotificationChannel`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel] operation.
type NotificationChannel_VerificationStatus int32
const (
// 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).
NotificationChannel_VERIFICATION_STATUS_UNSPECIFIED NotificationChannel_VerificationStatus = 0
// 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.
NotificationChannel_UNVERIFIED NotificationChannel_VerificationStatus = 1
// 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.
NotificationChannel_VERIFIED NotificationChannel_VerificationStatus = 2
)
func (NotificationChannel_VerificationStatus) Descriptor() protoreflect.EnumDescriptor
func (x NotificationChannel_VerificationStatus) Enum() *NotificationChannel_VerificationStatus
func (NotificationChannel_VerificationStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use NotificationChannel_VerificationStatus.Descriptor instead.
func (x NotificationChannel_VerificationStatus) Number() protoreflect.EnumNumber
func (x NotificationChannel_VerificationStatus) String() string
func (NotificationChannel_VerificationStatus) Type() protoreflect.EnumType
A single data point in a time series.
type Point struct {
// 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 `protobuf:"bytes,1,opt,name=interval,proto3" json:"interval,omitempty"`
// The value of the data point.
Value *TypedValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*Point) Descriptor() ([]byte, []int)
Deprecated: Use Point.ProtoReflect.Descriptor instead.
func (x *Point) GetInterval() *TimeInterval
func (x *Point) GetValue() *TypedValue
func (*Point) ProtoMessage()
func (x *Point) ProtoReflect() protoreflect.Message
func (x *Point) Reset()
func (x *Point) String() string
An error associated with a query in the time series query language format.
type QueryError struct {
// The location of the time series query language text that this error applies
// to.
Locator *TextLocator `protobuf:"bytes,1,opt,name=locator,proto3" json:"locator,omitempty"`
// The error message.
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*QueryError) Descriptor() ([]byte, []int)
Deprecated: Use QueryError.ProtoReflect.Descriptor instead.
func (x *QueryError) GetLocator() *TextLocator
func (x *QueryError) GetMessage() string
func (*QueryError) ProtoMessage()
func (x *QueryError) ProtoReflect() protoreflect.Message
func (x *QueryError) Reset()
func (x *QueryError) String() string
This is an error detail intended to be used with INVALID_ARGUMENT errors.
type QueryErrorList struct {
// Errors in parsing the time series query language text. The number of errors
// in the response may be limited.
Errors []*QueryError `protobuf:"bytes,1,rep,name=errors,proto3" json:"errors,omitempty"`
// A summary of all the errors.
ErrorSummary string `protobuf:"bytes,2,opt,name=error_summary,json=errorSummary,proto3" json:"error_summary,omitempty"`
// contains filtered or unexported fields
}
func (*QueryErrorList) Descriptor() ([]byte, []int)
Deprecated: Use QueryErrorList.ProtoReflect.Descriptor instead.
func (x *QueryErrorList) GetErrorSummary() string
func (x *QueryErrorList) GetErrors() []*QueryError
func (*QueryErrorList) ProtoMessage()
func (x *QueryErrorList) ProtoReflect() protoreflect.Message
func (x *QueryErrorList) Reset()
func (x *QueryErrorList) String() string
QueryServiceClient is the client API for QueryService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type QueryServiceClient interface {
// Queries time series using Monitoring Query Language.
QueryTimeSeries(ctx context.Context, in *QueryTimeSeriesRequest, opts ...grpc.CallOption) (*QueryTimeSeriesResponse, error)
}
func NewQueryServiceClient(cc grpc.ClientConnInterface) QueryServiceClient
QueryServiceServer is the server API for QueryService service.
type QueryServiceServer interface {
// Queries time series using Monitoring Query Language.
QueryTimeSeries(context.Context, *QueryTimeSeriesRequest) (*QueryTimeSeriesResponse, error)
}
The `QueryTimeSeries` request.
type QueryTimeSeriesRequest struct {
// Required. The
// [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
// to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The query in the [Monitoring Query
// Language](https://cloud.google.com/monitoring/mql/reference) format.
// The default time zone is in UTC.
Query string `protobuf:"bytes,7,opt,name=query,proto3" json:"query,omitempty"`
// A positive number that is the maximum number of time_series_data to return.
PageSize int32 `protobuf:"varint,9,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// 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.
PageToken string `protobuf:"bytes,10,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*QueryTimeSeriesRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryTimeSeriesRequest.ProtoReflect.Descriptor instead.
func (x *QueryTimeSeriesRequest) GetName() string
func (x *QueryTimeSeriesRequest) GetPageSize() int32
func (x *QueryTimeSeriesRequest) GetPageToken() string
func (x *QueryTimeSeriesRequest) GetQuery() string
func (*QueryTimeSeriesRequest) ProtoMessage()
func (x *QueryTimeSeriesRequest) ProtoReflect() protoreflect.Message
func (x *QueryTimeSeriesRequest) Reset()
func (x *QueryTimeSeriesRequest) String() string
The `QueryTimeSeries` response.
type QueryTimeSeriesResponse struct {
// The descriptor for the time series data.
TimeSeriesDescriptor *TimeSeriesDescriptor `protobuf:"bytes,8,opt,name=time_series_descriptor,json=timeSeriesDescriptor,proto3" json:"time_series_descriptor,omitempty"`
// The time series data.
TimeSeriesData []*TimeSeriesData `protobuf:"bytes,9,rep,name=time_series_data,json=timeSeriesData,proto3" json:"time_series_data,omitempty"`
// 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.
NextPageToken string `protobuf:"bytes,10,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// 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.Status `protobuf:"bytes,11,rep,name=partial_errors,json=partialErrors,proto3" json:"partial_errors,omitempty"`
// contains filtered or unexported fields
}
func (*QueryTimeSeriesResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryTimeSeriesResponse.ProtoReflect.Descriptor instead.
func (x *QueryTimeSeriesResponse) GetNextPageToken() string
func (x *QueryTimeSeriesResponse) GetPartialErrors() []*status.Status
func (x *QueryTimeSeriesResponse) GetTimeSeriesData() []*TimeSeriesData
func (x *QueryTimeSeriesResponse) GetTimeSeriesDescriptor() *TimeSeriesDescriptor
func (*QueryTimeSeriesResponse) ProtoMessage()
func (x *QueryTimeSeriesResponse) ProtoReflect() protoreflect.Message
func (x *QueryTimeSeriesResponse) Reset()
func (x *QueryTimeSeriesResponse) String() string
Range of numerical values within `min` and `max`.
type Range struct {
// Range minimum.
Min float64 `protobuf:"fixed64,1,opt,name=min,proto3" json:"min,omitempty"`
// Range maximum.
Max float64 `protobuf:"fixed64,2,opt,name=max,proto3" json:"max,omitempty"`
// contains filtered or unexported fields
}
func (*Range) Descriptor() ([]byte, []int)
Deprecated: Use Range.ProtoReflect.Descriptor instead.
func (x *Range) GetMax() float64
func (x *Range) GetMin() float64
func (*Range) ProtoMessage()
func (x *Range) ProtoReflect() protoreflect.Message
func (x *Range) Reset()
func (x *Range) String() string
Service Level Indicators for which atomic units of service are counted directly.
type RequestBasedSli struct {
// The means to compute a ratio of `good_service` to `total_service`.
//
// Types that are assignable to Method:
//
// *RequestBasedSli_GoodTotalRatio
// *RequestBasedSli_DistributionCut
Method isRequestBasedSli_Method `protobuf_oneof:"method"`
// contains filtered or unexported fields
}
func (*RequestBasedSli) Descriptor() ([]byte, []int)
Deprecated: Use RequestBasedSli.ProtoReflect.Descriptor instead.
func (x *RequestBasedSli) GetDistributionCut() *DistributionCut
func (x *RequestBasedSli) GetGoodTotalRatio() *TimeSeriesRatio
func (m *RequestBasedSli) GetMethod() isRequestBasedSli_Method
func (*RequestBasedSli) ProtoMessage()
func (x *RequestBasedSli) ProtoReflect() protoreflect.Message
func (x *RequestBasedSli) Reset()
func (x *RequestBasedSli) String() string
type RequestBasedSli_DistributionCut struct {
// `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 `protobuf:"bytes,3,opt,name=distribution_cut,json=distributionCut,proto3,oneof"`
}
type RequestBasedSli_GoodTotalRatio struct {
// `good_total_ratio` is used when the ratio of `good_service` to
// `total_service` is computed from two `TimeSeries`.
GoodTotalRatio *TimeSeriesRatio `protobuf:"bytes,1,opt,name=good_total_ratio,json=goodTotalRatio,proto3,oneof"`
}
The `SendNotificationChannelVerificationCode` request.
type SendNotificationChannelVerificationCodeRequest struct {
// Required. The notification channel to which to send a verification code.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*SendNotificationChannelVerificationCodeRequest) Descriptor() ([]byte, []int)
Deprecated: Use SendNotificationChannelVerificationCodeRequest.ProtoReflect.Descriptor instead.
func (x *SendNotificationChannelVerificationCodeRequest) GetName() string
func (*SendNotificationChannelVerificationCodeRequest) ProtoMessage()
func (x *SendNotificationChannelVerificationCodeRequest) ProtoReflect() protoreflect.Message
func (x *SendNotificationChannelVerificationCodeRequest) Reset()
func (x *SendNotificationChannelVerificationCodeRequest) String() string
A `Service` is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern ([Wikipedia](https://en.wikipedia.org/wiki/Service-orientation)). In Cloud Monitoring, a `Service` acts as the root resource under which operational aspects of the service are accessible.
type Service struct {
// Identifier. Resource name for this Service. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Name used for UI elements listing this Service.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// REQUIRED. Service-identifying atoms specifying the underlying service.
//
// Types that are assignable to Identifier:
//
// *Service_Custom_
// *Service_AppEngine_
// *Service_CloudEndpoints_
// *Service_ClusterIstio_
// *Service_MeshIstio_
// *Service_IstioCanonicalService_
// *Service_CloudRun_
// *Service_GkeNamespace_
// *Service_GkeWorkload_
// *Service_GkeService_
Identifier isService_Identifier `protobuf_oneof:"identifier"`
// 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 *Service_BasicService `protobuf:"bytes,19,opt,name=basic_service,json=basicService,proto3" json:"basic_service,omitempty"`
// Configuration for how to query telemetry on a Service.
Telemetry *Service_Telemetry `protobuf:"bytes,13,opt,name=telemetry,proto3" json:"telemetry,omitempty"`
// 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 `protobuf:"bytes,14,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*Service) Descriptor() ([]byte, []int)
Deprecated: Use Service.ProtoReflect.Descriptor instead.
func (x *Service) GetAppEngine() *Service_AppEngine
func (x *Service) GetBasicService() *Service_BasicService
func (x *Service) GetCloudEndpoints() *Service_CloudEndpoints
func (x *Service) GetCloudRun() *Service_CloudRun
func (x *Service) GetClusterIstio() *Service_ClusterIstio
func (x *Service) GetCustom() *Service_Custom
func (x *Service) GetDisplayName() string
func (x *Service) GetGkeNamespace() *Service_GkeNamespace
func (x *Service) GetGkeService() *Service_GkeService
func (x *Service) GetGkeWorkload() *Service_GkeWorkload
func (m *Service) GetIdentifier() isService_Identifier
func (x *Service) GetIstioCanonicalService() *Service_IstioCanonicalService
func (x *Service) GetMeshIstio() *Service_MeshIstio
func (x *Service) GetName() string
func (x *Service) GetTelemetry() *Service_Telemetry
func (x *Service) GetUserLabels() map[string]string
func (*Service) ProtoMessage()
func (x *Service) ProtoReflect() protoreflect.Message
func (x *Service) Reset()
func (x *Service) String() string
A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be `good_service / total_service` over any queried time interval. The value of performance always falls into the range `0 <= performance <= 1`. A custom SLI describes how to compute this ratio, whether this is by dividing values from a pair of time series, cutting a `Distribution` into good and bad counts, or counting time windows in which the service complies with a criterion. For separation of concerns, a single Service-Level Indicator measures performance for only one aspect of service quality, such as fraction of successful queries or fast-enough queries.
type ServiceLevelIndicator struct {
// Service level indicators can be grouped by whether the "unit" of service
// being measured is based on counts of good requests or on counts of good
// time windows
//
// Types that are assignable to Type:
//
// *ServiceLevelIndicator_BasicSli
// *ServiceLevelIndicator_RequestBased
// *ServiceLevelIndicator_WindowsBased
Type isServiceLevelIndicator_Type `protobuf_oneof:"type"`
// contains filtered or unexported fields
}
func (*ServiceLevelIndicator) Descriptor() ([]byte, []int)
Deprecated: Use ServiceLevelIndicator.ProtoReflect.Descriptor instead.
func (x *ServiceLevelIndicator) GetBasicSli() *BasicSli
func (x *ServiceLevelIndicator) GetRequestBased() *RequestBasedSli
func (m *ServiceLevelIndicator) GetType() isServiceLevelIndicator_Type
func (x *ServiceLevelIndicator) GetWindowsBased() *WindowsBasedSli
func (*ServiceLevelIndicator) ProtoMessage()
func (x *ServiceLevelIndicator) ProtoReflect() protoreflect.Message
func (x *ServiceLevelIndicator) Reset()
func (x *ServiceLevelIndicator) String() string
type ServiceLevelIndicator_BasicSli struct {
// Basic SLI on a well-known service type.
BasicSli *BasicSli `protobuf:"bytes,4,opt,name=basic_sli,json=basicSli,proto3,oneof"`
}
type ServiceLevelIndicator_RequestBased struct {
// Request-based SLIs
RequestBased *RequestBasedSli `protobuf:"bytes,1,opt,name=request_based,json=requestBased,proto3,oneof"`
}
type ServiceLevelIndicator_WindowsBased struct {
// Windows-based SLIs
WindowsBased *WindowsBasedSli `protobuf:"bytes,2,opt,name=windows_based,json=windowsBased,proto3,oneof"`
}
A Service-Level Objective (SLO) describes a level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include "99% of requests in each rolling week have latency below 200 milliseconds" or "99.5% of requests in each calendar month return successfully."
type ServiceLevelObjective struct {
// Identifier. Resource name for this `ServiceLevelObjective`. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Name used for UI elements listing this SLO.
DisplayName string `protobuf:"bytes,11,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// 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 `protobuf:"bytes,3,opt,name=service_level_indicator,json=serviceLevelIndicator,proto3" json:"service_level_indicator,omitempty"`
// The fraction of service that must be good in order for this objective to be
// met. `0 < goal <= 0.999`.
Goal float64 `protobuf:"fixed64,4,opt,name=goal,proto3" json:"goal,omitempty"`
// The time period over which the objective will be evaluated.
//
// Types that are assignable to Period:
//
// *ServiceLevelObjective_RollingPeriod
// *ServiceLevelObjective_CalendarPeriod
Period isServiceLevelObjective_Period `protobuf_oneof:"period"`
// 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 `protobuf:"bytes,12,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*ServiceLevelObjective) Descriptor() ([]byte, []int)
Deprecated: Use ServiceLevelObjective.ProtoReflect.Descriptor instead.
func (x *ServiceLevelObjective) GetCalendarPeriod() calendarperiod.CalendarPeriod
func (x *ServiceLevelObjective) GetDisplayName() string
func (x *ServiceLevelObjective) GetGoal() float64
func (x *ServiceLevelObjective) GetName() string
func (m *ServiceLevelObjective) GetPeriod() isServiceLevelObjective_Period
func (x *ServiceLevelObjective) GetRollingPeriod() *durationpb.Duration
func (x *ServiceLevelObjective) GetServiceLevelIndicator() *ServiceLevelIndicator
func (x *ServiceLevelObjective) GetUserLabels() map[string]string
func (*ServiceLevelObjective) ProtoMessage()
func (x *ServiceLevelObjective) ProtoReflect() protoreflect.Message
func (x *ServiceLevelObjective) Reset()
func (x *ServiceLevelObjective) String() string
type ServiceLevelObjective_CalendarPeriod struct {
// A calendar period, semantically "since the start of the current
// `<calendar_period>`". At this time, only `DAY`, `WEEK`, `FORTNIGHT`, and
// `MONTH` are supported.
CalendarPeriod calendarperiod.CalendarPeriod `protobuf:"varint,6,opt,name=calendar_period,json=calendarPeriod,proto3,enum=google.type.CalendarPeriod,oneof"`
}
type ServiceLevelObjective_RollingPeriod struct {
// A rolling time period, semantically "in the past `<rolling_period>`".
// Must be an integer multiple of 1 day no larger than 30 days.
RollingPeriod *durationpb.Duration `protobuf:"bytes,5,opt,name=rolling_period,json=rollingPeriod,proto3,oneof"`
}
`ServiceLevelObjective.View` determines what form of `ServiceLevelObjective` is returned from `GetServiceLevelObjective`, `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
type ServiceLevelObjective_View int32
const (
// Same as FULL.
ServiceLevelObjective_VIEW_UNSPECIFIED ServiceLevelObjective_View = 0
// Return the embedded `ServiceLevelIndicator` in the form in which it was
// defined. If it was defined using a `BasicSli`, return that `BasicSli`.
ServiceLevelObjective_FULL ServiceLevelObjective_View = 2
// For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
// return the `ServiceLevelIndicator` with its mode of computation fully
// spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
// `RequestBasedSli` or `WindowsBasedSli`, return the
// `ServiceLevelIndicator` as it was provided.
ServiceLevelObjective_EXPLICIT ServiceLevelObjective_View = 1
)
func (ServiceLevelObjective_View) Descriptor() protoreflect.EnumDescriptor
func (x ServiceLevelObjective_View) Enum() *ServiceLevelObjective_View
func (ServiceLevelObjective_View) EnumDescriptor() ([]byte, []int)
Deprecated: Use ServiceLevelObjective_View.Descriptor instead.
func (x ServiceLevelObjective_View) Number() protoreflect.EnumNumber
func (x ServiceLevelObjective_View) String() string
func (ServiceLevelObjective_View) Type() protoreflect.EnumType
ServiceMonitoringServiceClient is the client API for ServiceMonitoringService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type ServiceMonitoringServiceClient interface {
// Create a `Service`.
CreateService(ctx context.Context, in *CreateServiceRequest, opts ...grpc.CallOption) (*Service, error)
// Get the named `Service`.
GetService(ctx context.Context, in *GetServiceRequest, opts ...grpc.CallOption) (*Service, error)
// List `Service`s for this Metrics Scope.
ListServices(ctx context.Context, in *ListServicesRequest, opts ...grpc.CallOption) (*ListServicesResponse, error)
// Update this `Service`.
UpdateService(ctx context.Context, in *UpdateServiceRequest, opts ...grpc.CallOption) (*Service, error)
// Soft delete this `Service`.
DeleteService(ctx context.Context, in *DeleteServiceRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Create a `ServiceLevelObjective` for the given `Service`.
CreateServiceLevelObjective(ctx context.Context, in *CreateServiceLevelObjectiveRequest, opts ...grpc.CallOption) (*ServiceLevelObjective, error)
// Get a `ServiceLevelObjective` by name.
GetServiceLevelObjective(ctx context.Context, in *GetServiceLevelObjectiveRequest, opts ...grpc.CallOption) (*ServiceLevelObjective, error)
// List the `ServiceLevelObjective`s for the given `Service`.
ListServiceLevelObjectives(ctx context.Context, in *ListServiceLevelObjectivesRequest, opts ...grpc.CallOption) (*ListServiceLevelObjectivesResponse, error)
// Update the given `ServiceLevelObjective`.
UpdateServiceLevelObjective(ctx context.Context, in *UpdateServiceLevelObjectiveRequest, opts ...grpc.CallOption) (*ServiceLevelObjective, error)
// Delete the given `ServiceLevelObjective`.
DeleteServiceLevelObjective(ctx context.Context, in *DeleteServiceLevelObjectiveRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}
func NewServiceMonitoringServiceClient(cc grpc.ClientConnInterface) ServiceMonitoringServiceClient
ServiceMonitoringServiceServer is the server API for ServiceMonitoringService service.
type ServiceMonitoringServiceServer interface {
// Create a `Service`.
CreateService(context.Context, *CreateServiceRequest) (*Service, error)
// Get the named `Service`.
GetService(context.Context, *GetServiceRequest) (*Service, error)
// List `Service`s for this Metrics Scope.
ListServices(context.Context, *ListServicesRequest) (*ListServicesResponse, error)
// Update this `Service`.
UpdateService(context.Context, *UpdateServiceRequest) (*Service, error)
// Soft delete this `Service`.
DeleteService(context.Context, *DeleteServiceRequest) (*emptypb.Empty, error)
// Create a `ServiceLevelObjective` for the given `Service`.
CreateServiceLevelObjective(context.Context, *CreateServiceLevelObjectiveRequest) (*ServiceLevelObjective, error)
// Get a `ServiceLevelObjective` by name.
GetServiceLevelObjective(context.Context, *GetServiceLevelObjectiveRequest) (*ServiceLevelObjective, error)
// List the `ServiceLevelObjective`s for the given `Service`.
ListServiceLevelObjectives(context.Context, *ListServiceLevelObjectivesRequest) (*ListServiceLevelObjectivesResponse, error)
// Update the given `ServiceLevelObjective`.
UpdateServiceLevelObjective(context.Context, *UpdateServiceLevelObjectiveRequest) (*ServiceLevelObjective, error)
// Delete the given `ServiceLevelObjective`.
DeleteServiceLevelObjective(context.Context, *DeleteServiceLevelObjectiveRequest) (*emptypb.Empty, error)
}
The tier of service for a Metrics Scope. Please see the [service tiers documentation](https://cloud.google.com/monitoring/workspaces/tiers) for more details.
Deprecated: Marked as deprecated in google/monitoring/v3/common.proto.
type ServiceTier int32
const (
// An invalid sentinel value, used to indicate that a tier has not
// been provided explicitly.
ServiceTier_SERVICE_TIER_UNSPECIFIED ServiceTier = 0
// 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).
ServiceTier_SERVICE_TIER_BASIC ServiceTier = 1
// 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).
ServiceTier_SERVICE_TIER_PREMIUM ServiceTier = 2
)
func (ServiceTier) Descriptor() protoreflect.EnumDescriptor
func (x ServiceTier) Enum() *ServiceTier
func (ServiceTier) EnumDescriptor() ([]byte, []int)
Deprecated: Use ServiceTier.Descriptor instead.
func (x ServiceTier) Number() protoreflect.EnumNumber
func (x ServiceTier) String() string
func (ServiceTier) Type() protoreflect.EnumType
App Engine service. Learn more at https://cloud.google.com/appengine.
type Service_AppEngine struct {
// 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).
ModuleId string `protobuf:"bytes,1,opt,name=module_id,json=moduleId,proto3" json:"module_id,omitempty"`
// contains filtered or unexported fields
}
func (*Service_AppEngine) Descriptor() ([]byte, []int)
Deprecated: Use Service_AppEngine.ProtoReflect.Descriptor instead.
func (x *Service_AppEngine) GetModuleId() string
func (*Service_AppEngine) ProtoMessage()
func (x *Service_AppEngine) ProtoReflect() protoreflect.Message
func (x *Service_AppEngine) Reset()
func (x *Service_AppEngine) String() string
type Service_AppEngine_ struct {
// Type used for App Engine services.
AppEngine *Service_AppEngine `protobuf:"bytes,7,opt,name=app_engine,json=appEngine,proto3,oneof"`
}
A well-known service type, defined by its service type and service labels. Documentation and examples [here](https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).
type Service_BasicService struct {
// 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).
ServiceType string `protobuf:"bytes,1,opt,name=service_type,json=serviceType,proto3" json:"service_type,omitempty"`
// 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 `protobuf:"bytes,2,rep,name=service_labels,json=serviceLabels,proto3" json:"service_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*Service_BasicService) Descriptor() ([]byte, []int)
Deprecated: Use Service_BasicService.ProtoReflect.Descriptor instead.
func (x *Service_BasicService) GetServiceLabels() map[string]string
func (x *Service_BasicService) GetServiceType() string
func (*Service_BasicService) ProtoMessage()
func (x *Service_BasicService) ProtoReflect() protoreflect.Message
func (x *Service_BasicService) Reset()
func (x *Service_BasicService) String() string
Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.
type Service_CloudEndpoints struct {
// 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).
Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}
func (*Service_CloudEndpoints) Descriptor() ([]byte, []int)
Deprecated: Use Service_CloudEndpoints.ProtoReflect.Descriptor instead.
func (x *Service_CloudEndpoints) GetService() string
func (*Service_CloudEndpoints) ProtoMessage()
func (x *Service_CloudEndpoints) ProtoReflect() protoreflect.Message
func (x *Service_CloudEndpoints) Reset()
func (x *Service_CloudEndpoints) String() string
type Service_CloudEndpoints_ struct {
// Type used for Cloud Endpoints services.
CloudEndpoints *Service_CloudEndpoints `protobuf:"bytes,8,opt,name=cloud_endpoints,json=cloudEndpoints,proto3,oneof"`
}
Cloud Run service. Learn more at https://cloud.google.com/run.
type Service_CloudRun struct {
// 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).
ServiceName string `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// 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).
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}
func (*Service_CloudRun) Descriptor() ([]byte, []int)
Deprecated: Use Service_CloudRun.ProtoReflect.Descriptor instead.
func (x *Service_CloudRun) GetLocation() string
func (x *Service_CloudRun) GetServiceName() string
func (*Service_CloudRun) ProtoMessage()
func (x *Service_CloudRun) ProtoReflect() protoreflect.Message
func (x *Service_CloudRun) Reset()
func (x *Service_CloudRun) String() string
type Service_CloudRun_ struct {
// Type used for Cloud Run services.
CloudRun *Service_CloudRun `protobuf:"bytes,12,opt,name=cloud_run,json=cloudRun,proto3,oneof"`
}
Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type.
type Service_ClusterIstio struct {
// The location of the Kubernetes cluster in which this Istio service is
// defined. Corresponds to the `location` resource label in `k8s_cluster`
// resources.
Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
// The name of the Kubernetes cluster in which this Istio service is
// defined. Corresponds to the `cluster_name` resource label in
// `k8s_cluster` resources.
ClusterName string `protobuf:"bytes,2,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
// The namespace of the Istio service underlying this service. Corresponds
// to the `destination_service_namespace` metric label in Istio metrics.
ServiceNamespace string `protobuf:"bytes,3,opt,name=service_namespace,json=serviceNamespace,proto3" json:"service_namespace,omitempty"`
// The name of the Istio service underlying this service. Corresponds to the
// `destination_service_name` metric label in Istio metrics.
ServiceName string `protobuf:"bytes,4,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// contains filtered or unexported fields
}
func (*Service_ClusterIstio) Descriptor() ([]byte, []int)
Deprecated: Use Service_ClusterIstio.ProtoReflect.Descriptor instead.
func (x *Service_ClusterIstio) GetClusterName() string
func (x *Service_ClusterIstio) GetLocation() string
func (x *Service_ClusterIstio) GetServiceName() string
func (x *Service_ClusterIstio) GetServiceNamespace() string
func (*Service_ClusterIstio) ProtoMessage()
func (x *Service_ClusterIstio) ProtoReflect() protoreflect.Message
func (x *Service_ClusterIstio) Reset()
func (x *Service_ClusterIstio) String() string
type Service_ClusterIstio_ struct {
// Type used for Istio services that live in a Kubernetes cluster.
ClusterIstio *Service_ClusterIstio `protobuf:"bytes,9,opt,name=cluster_istio,json=clusterIstio,proto3,oneof"`
}
Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service.
type Service_Custom struct {
// contains filtered or unexported fields
}
func (*Service_Custom) Descriptor() ([]byte, []int)
Deprecated: Use Service_Custom.ProtoReflect.Descriptor instead.
func (*Service_Custom) ProtoMessage()
func (x *Service_Custom) ProtoReflect() protoreflect.Message
func (x *Service_Custom) Reset()
func (x *Service_Custom) String() string
type Service_Custom_ struct {
// Custom service type.
Custom *Service_Custom `protobuf:"bytes,6,opt,name=custom,proto3,oneof"`
}
GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, `k8s_container` or `k8s_pod`).
type Service_GkeNamespace struct {
// 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.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// The location of the parent cluster. This may be a zone or region.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// The name of the parent cluster.
ClusterName string `protobuf:"bytes,3,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
// The name of this namespace.
NamespaceName string `protobuf:"bytes,4,opt,name=namespace_name,json=namespaceName,proto3" json:"namespace_name,omitempty"`
// contains filtered or unexported fields
}
func (*Service_GkeNamespace) Descriptor() ([]byte, []int)
Deprecated: Use Service_GkeNamespace.ProtoReflect.Descriptor instead.
func (x *Service_GkeNamespace) GetClusterName() string
func (x *Service_GkeNamespace) GetLocation() string
func (x *Service_GkeNamespace) GetNamespaceName() string
func (x *Service_GkeNamespace) GetProjectId() string
func (*Service_GkeNamespace) ProtoMessage()
func (x *Service_GkeNamespace) ProtoReflect() protoreflect.Message
func (x *Service_GkeNamespace) Reset()
func (x *Service_GkeNamespace) String() string
type Service_GkeNamespace_ struct {
// Type used for GKE Namespaces.
GkeNamespace *Service_GkeNamespace `protobuf:"bytes,15,opt,name=gke_namespace,json=gkeNamespace,proto3,oneof"`
}
GKE Service. The "service" here represents a [Kubernetes service object](https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on [`k8s_service` monitored resources](https://cloud.google.com/monitoring/api/resources#tag_k8s_service).
type Service_GkeService struct {
// 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.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// The location of the parent cluster. This may be a zone or region.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// The name of the parent cluster.
ClusterName string `protobuf:"bytes,3,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
// The name of the parent namespace.
NamespaceName string `protobuf:"bytes,4,opt,name=namespace_name,json=namespaceName,proto3" json:"namespace_name,omitempty"`
// The name of this service.
ServiceName string `protobuf:"bytes,5,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// contains filtered or unexported fields
}
func (*Service_GkeService) Descriptor() ([]byte, []int)
Deprecated: Use Service_GkeService.ProtoReflect.Descriptor instead.
func (x *Service_GkeService) GetClusterName() string
func (x *Service_GkeService) GetLocation() string
func (x *Service_GkeService) GetNamespaceName() string
func (x *Service_GkeService) GetProjectId() string
func (x *Service_GkeService) GetServiceName() string
func (*Service_GkeService) ProtoMessage()
func (x *Service_GkeService) ProtoReflect() protoreflect.Message
func (x *Service_GkeService) Reset()
func (x *Service_GkeService) String() string
type Service_GkeService_ struct {
// Type used for GKE Services (the Kubernetes concept of a service).
GkeService *Service_GkeService `protobuf:"bytes,17,opt,name=gke_service,json=gkeService,proto3,oneof"`
}
A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, `k8s_container` or `k8s_pod`).
type Service_GkeWorkload struct {
// 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.
ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// The location of the parent cluster. This may be a zone or region.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// The name of the parent cluster.
ClusterName string `protobuf:"bytes,3,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
// The name of the parent namespace.
NamespaceName string `protobuf:"bytes,4,opt,name=namespace_name,json=namespaceName,proto3" json:"namespace_name,omitempty"`
// The type of this workload (for example, "Deployment" or "DaemonSet")
TopLevelControllerType string `protobuf:"bytes,5,opt,name=top_level_controller_type,json=topLevelControllerType,proto3" json:"top_level_controller_type,omitempty"`
// The name of this workload.
TopLevelControllerName string `protobuf:"bytes,6,opt,name=top_level_controller_name,json=topLevelControllerName,proto3" json:"top_level_controller_name,omitempty"`
// contains filtered or unexported fields
}
func (*Service_GkeWorkload) Descriptor() ([]byte, []int)
Deprecated: Use Service_GkeWorkload.ProtoReflect.Descriptor instead.
func (x *Service_GkeWorkload) GetClusterName() string
func (x *Service_GkeWorkload) GetLocation() string
func (x *Service_GkeWorkload) GetNamespaceName() string
func (x *Service_GkeWorkload) GetProjectId() string
func (x *Service_GkeWorkload) GetTopLevelControllerName() string
func (x *Service_GkeWorkload) GetTopLevelControllerType() string
func (*Service_GkeWorkload) ProtoMessage()
func (x *Service_GkeWorkload) ProtoReflect() protoreflect.Message
func (x *Service_GkeWorkload) Reset()
func (x *Service_GkeWorkload) String() string
type Service_GkeWorkload_ struct {
// Type used for GKE Workloads.
GkeWorkload *Service_GkeWorkload `protobuf:"bytes,16,opt,name=gke_workload,json=gkeWorkload,proto3,oneof"`
}
Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.
type Service_IstioCanonicalService struct {
// 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).
MeshUid string `protobuf:"bytes,1,opt,name=mesh_uid,json=meshUid,proto3" json:"mesh_uid,omitempty"`
// 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).
CanonicalServiceNamespace string `protobuf:"bytes,3,opt,name=canonical_service_namespace,json=canonicalServiceNamespace,proto3" json:"canonical_service_namespace,omitempty"`
// 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).
CanonicalService string `protobuf:"bytes,4,opt,name=canonical_service,json=canonicalService,proto3" json:"canonical_service,omitempty"`
// contains filtered or unexported fields
}
func (*Service_IstioCanonicalService) Descriptor() ([]byte, []int)
Deprecated: Use Service_IstioCanonicalService.ProtoReflect.Descriptor instead.
func (x *Service_IstioCanonicalService) GetCanonicalService() string
func (x *Service_IstioCanonicalService) GetCanonicalServiceNamespace() string
func (x *Service_IstioCanonicalService) GetMeshUid() string
func (*Service_IstioCanonicalService) ProtoMessage()
func (x *Service_IstioCanonicalService) ProtoReflect() protoreflect.Message
func (x *Service_IstioCanonicalService) Reset()
func (x *Service_IstioCanonicalService) String() string
type Service_IstioCanonicalService_ struct {
// 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 *Service_IstioCanonicalService `protobuf:"bytes,11,opt,name=istio_canonical_service,json=istioCanonicalService,proto3,oneof"`
}
Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.
type Service_MeshIstio struct {
// Identifier for the mesh in which this Istio service is defined.
// Corresponds to the `mesh_uid` metric label in Istio metrics.
MeshUid string `protobuf:"bytes,1,opt,name=mesh_uid,json=meshUid,proto3" json:"mesh_uid,omitempty"`
// The namespace of the Istio service underlying this service. Corresponds
// to the `destination_service_namespace` metric label in Istio metrics.
ServiceNamespace string `protobuf:"bytes,3,opt,name=service_namespace,json=serviceNamespace,proto3" json:"service_namespace,omitempty"`
// The name of the Istio service underlying this service. Corresponds to the
// `destination_service_name` metric label in Istio metrics.
ServiceName string `protobuf:"bytes,4,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// contains filtered or unexported fields
}
func (*Service_MeshIstio) Descriptor() ([]byte, []int)
Deprecated: Use Service_MeshIstio.ProtoReflect.Descriptor instead.
func (x *Service_MeshIstio) GetMeshUid() string
func (x *Service_MeshIstio) GetServiceName() string
func (x *Service_MeshIstio) GetServiceNamespace() string
func (*Service_MeshIstio) ProtoMessage()
func (x *Service_MeshIstio) ProtoReflect() protoreflect.Message
func (x *Service_MeshIstio) Reset()
func (x *Service_MeshIstio) String() string
type Service_MeshIstio_ struct {
// Type used for Istio services scoped to an Istio mesh.
MeshIstio *Service_MeshIstio `protobuf:"bytes,10,opt,name=mesh_istio,json=meshIstio,proto3,oneof"`
}
Configuration for how to query telemetry on a Service.
type Service_Telemetry struct {
// The full name of the resource that defines this service. Formatted as
// described in https://cloud.google.com/apis/design/resource_names.
ResourceName string `protobuf:"bytes,1,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
// contains filtered or unexported fields
}
func (*Service_Telemetry) Descriptor() ([]byte, []int)
Deprecated: Use Service_Telemetry.ProtoReflect.Descriptor instead.
func (x *Service_Telemetry) GetResourceName() string
func (*Service_Telemetry) ProtoMessage()
func (x *Service_Telemetry) ProtoReflect() protoreflect.Message
func (x *Service_Telemetry) Reset()
func (x *Service_Telemetry) String() string
A `Snooze` will prevent any alerts from being opened, and close any that are already open. The `Snooze` will work on alerts that match the criteria defined in the `Snooze`. The `Snooze` will be active from `interval.start_time` through `interval.end_time`.
type Snooze struct {
// Required. 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.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. This defines the criteria for applying the `Snooze`. See
// `Criteria` for more information.
Criteria *Snooze_Criteria `protobuf:"bytes,3,opt,name=criteria,proto3" json:"criteria,omitempty"`
// 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 `protobuf:"bytes,4,opt,name=interval,proto3" json:"interval,omitempty"`
// Required. A display name for the `Snooze`. This can be, at most, 512
// unicode characters.
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// contains filtered or unexported fields
}
func (*Snooze) Descriptor() ([]byte, []int)
Deprecated: Use Snooze.ProtoReflect.Descriptor instead.
func (x *Snooze) GetCriteria() *Snooze_Criteria
func (x *Snooze) GetDisplayName() string
func (x *Snooze) GetInterval() *TimeInterval
func (x *Snooze) GetName() string
func (*Snooze) ProtoMessage()
func (x *Snooze) ProtoReflect() protoreflect.Message
func (x *Snooze) Reset()
func (x *Snooze) String() string
SnoozeServiceClient is the client API for SnoozeService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type SnoozeServiceClient interface {
// Creates a `Snooze` that will prevent alerts, which match the provided
// criteria, from being opened. The `Snooze` applies for a specific time
// interval.
CreateSnooze(ctx context.Context, in *CreateSnoozeRequest, opts ...grpc.CallOption) (*Snooze, error)
// Lists the `Snooze`s associated with a project. Can optionally pass in
// `filter`, which specifies predicates to match `Snooze`s.
ListSnoozes(ctx context.Context, in *ListSnoozesRequest, opts ...grpc.CallOption) (*ListSnoozesResponse, error)
// Retrieves a `Snooze` by `name`.
GetSnooze(ctx context.Context, in *GetSnoozeRequest, opts ...grpc.CallOption) (*Snooze, error)
// Updates a `Snooze`, identified by its `name`, with the parameters in the
// given `Snooze` object.
UpdateSnooze(ctx context.Context, in *UpdateSnoozeRequest, opts ...grpc.CallOption) (*Snooze, error)
}
func NewSnoozeServiceClient(cc grpc.ClientConnInterface) SnoozeServiceClient
SnoozeServiceServer is the server API for SnoozeService service.
type SnoozeServiceServer interface {
// Creates a `Snooze` that will prevent alerts, which match the provided
// criteria, from being opened. The `Snooze` applies for a specific time
// interval.
CreateSnooze(context.Context, *CreateSnoozeRequest) (*Snooze, error)
// Lists the `Snooze`s associated with a project. Can optionally pass in
// `filter`, which specifies predicates to match `Snooze`s.
ListSnoozes(context.Context, *ListSnoozesRequest) (*ListSnoozesResponse, error)
// Retrieves a `Snooze` by `name`.
GetSnooze(context.Context, *GetSnoozeRequest) (*Snooze, error)
// Updates a `Snooze`, identified by its `name`, with the parameters in the
// given `Snooze` object.
UpdateSnooze(context.Context, *UpdateSnoozeRequest) (*Snooze, error)
}
Criteria specific to the `AlertPolicy`s that this `Snooze` applies to. The `Snooze` will suppress alerts that come from one of the `AlertPolicy`s whose names are supplied.
type Snooze_Criteria struct {
// 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.
Policies []string `protobuf:"bytes,1,rep,name=policies,proto3" json:"policies,omitempty"`
// contains filtered or unexported fields
}
func (*Snooze_Criteria) Descriptor() ([]byte, []int)
Deprecated: Use Snooze_Criteria.ProtoReflect.Descriptor instead.
func (x *Snooze_Criteria) GetPolicies() []string
func (*Snooze_Criteria) ProtoMessage()
func (x *Snooze_Criteria) ProtoReflect() protoreflect.Message
func (x *Snooze_Criteria) Reset()
func (x *Snooze_Criteria) String() string
The context of a span. This is attached to an [Exemplar][google.api.Distribution.Exemplar] in [Distribution][google.api.Distribution] values during aggregation.
It contains the name of a span with format:
projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]
type SpanContext struct {
// 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.
SpanName string `protobuf:"bytes,1,opt,name=span_name,json=spanName,proto3" json:"span_name,omitempty"`
// contains filtered or unexported fields
}
func (*SpanContext) Descriptor() ([]byte, []int)
Deprecated: Use SpanContext.ProtoReflect.Descriptor instead.
func (x *SpanContext) GetSpanName() string
func (*SpanContext) ProtoMessage()
func (x *SpanContext) ProtoReflect() protoreflect.Message
func (x *SpanContext) Reset()
func (x *SpanContext) String() string
Describes a Synthetic Monitor to be invoked by Uptime.
type SyntheticMonitorTarget struct {
// Specifies a Synthetic Monitor's execution stack.
//
// Types that are assignable to Target:
//
// *SyntheticMonitorTarget_CloudFunctionV2
Target isSyntheticMonitorTarget_Target `protobuf_oneof:"target"`
// contains filtered or unexported fields
}
func (*SyntheticMonitorTarget) Descriptor() ([]byte, []int)
Deprecated: Use SyntheticMonitorTarget.ProtoReflect.Descriptor instead.
func (x *SyntheticMonitorTarget) GetCloudFunctionV2() *SyntheticMonitorTarget_CloudFunctionV2Target
func (m *SyntheticMonitorTarget) GetTarget() isSyntheticMonitorTarget_Target
func (*SyntheticMonitorTarget) ProtoMessage()
func (x *SyntheticMonitorTarget) ProtoReflect() protoreflect.Message
func (x *SyntheticMonitorTarget) Reset()
func (x *SyntheticMonitorTarget) String() string
type SyntheticMonitorTarget_CloudFunctionV2 struct {
// Target a Synthetic Monitor GCFv2 instance.
CloudFunctionV2 *SyntheticMonitorTarget_CloudFunctionV2Target `protobuf:"bytes,1,opt,name=cloud_function_v2,json=cloudFunctionV2,proto3,oneof"`
}
A Synthetic Monitor deployed to a Cloud Functions V2 instance.
type SyntheticMonitorTarget_CloudFunctionV2Target struct {
// Required. Fully qualified GCFv2 resource name
// i.e. `projects/{project}/locations/{location}/functions/{function}`
// Required.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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 *monitoredres.MonitoredResource `protobuf:"bytes,2,opt,name=cloud_run_revision,json=cloudRunRevision,proto3" json:"cloud_run_revision,omitempty"`
// contains filtered or unexported fields
}
func (*SyntheticMonitorTarget_CloudFunctionV2Target) Descriptor() ([]byte, []int)
Deprecated: Use SyntheticMonitorTarget_CloudFunctionV2Target.ProtoReflect.Descriptor instead.
func (x *SyntheticMonitorTarget_CloudFunctionV2Target) GetCloudRunRevision() *monitoredres.MonitoredResource
func (x *SyntheticMonitorTarget_CloudFunctionV2Target) GetName() string
func (*SyntheticMonitorTarget_CloudFunctionV2Target) ProtoMessage()
func (x *SyntheticMonitorTarget_CloudFunctionV2Target) ProtoReflect() protoreflect.Message
func (x *SyntheticMonitorTarget_CloudFunctionV2Target) Reset()
func (x *SyntheticMonitorTarget_CloudFunctionV2Target) String() string
A locator for text. Indicates a particular part of the text of a request or of an object referenced in the request.
For example, suppose the request field `text` contains:
text: "The quick brown fox jumps over the lazy dog."
Then the locator:
source: "text"
start_position {
line: 1
column: 17
}
end_position {
line: 1
column: 19
}
refers to the part of the text: "fox".
type TextLocator struct {
// The source of the text. The source may be a field in the request, in which
// case its format is the format of the
// google.rpc.BadRequest.FieldViolation.field field in
// https://cloud.google.com/apis/design/errors#error_details. It may also be
// be a source other than the request field (e.g. a macro definition
// referenced in the text of the query), in which case this is the name of
// the source (e.g. the macro name).
Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
// The position of the first byte within the text.
StartPosition *TextLocator_Position `protobuf:"bytes,2,opt,name=start_position,json=startPosition,proto3" json:"start_position,omitempty"`
// The position of the last byte within the text.
EndPosition *TextLocator_Position `protobuf:"bytes,3,opt,name=end_position,json=endPosition,proto3" json:"end_position,omitempty"`
// If `source`, `start_position`, and `end_position` describe a call on
// some object (e.g. a macro in the time series query language text) and a
// location is to be designated in that object's text, `nested_locator`
// identifies the location within that object.
NestedLocator *TextLocator `protobuf:"bytes,4,opt,name=nested_locator,json=nestedLocator,proto3" json:"nested_locator,omitempty"`
// When `nested_locator` is set, this field gives the reason for the nesting.
// Usually, the reason is a macro invocation. In that case, the macro name
// (including the leading '@') signals the location of the macro call
// in the text and a macro argument name (including the leading '$') signals
// the location of the macro argument inside the macro body that got
// substituted away.
NestingReason string `protobuf:"bytes,5,opt,name=nesting_reason,json=nestingReason,proto3" json:"nesting_reason,omitempty"`
// contains filtered or unexported fields
}
func (*TextLocator) Descriptor() ([]byte, []int)
Deprecated: Use TextLocator.ProtoReflect.Descriptor instead.
func (x *TextLocator) GetEndPosition() *TextLocator_Position
func (x *TextLocator) GetNestedLocator() *TextLocator
func (x *TextLocator) GetNestingReason() string
func (x *TextLocator) GetSource() string
func (x *TextLocator) GetStartPosition() *TextLocator_Position
func (*TextLocator) ProtoMessage()
func (x *TextLocator) ProtoReflect() protoreflect.Message
func (x *TextLocator) Reset()
func (x *TextLocator) String() string
The position of a byte within the text.
type TextLocator_Position struct {
// The line, starting with 1, where the byte is positioned.
Line int32 `protobuf:"varint,1,opt,name=line,proto3" json:"line,omitempty"`
// The column within the line, starting with 1, where the byte is
// positioned. This is a byte index even though the text is UTF-8.
Column int32 `protobuf:"varint,2,opt,name=column,proto3" json:"column,omitempty"`
// contains filtered or unexported fields
}
func (*TextLocator_Position) Descriptor() ([]byte, []int)
Deprecated: Use TextLocator_Position.ProtoReflect.Descriptor instead.
func (x *TextLocator_Position) GetColumn() int32
func (x *TextLocator_Position) GetLine() int32
func (*TextLocator_Position) ProtoMessage()
func (x *TextLocator_Position) ProtoReflect() protoreflect.Message
func (x *TextLocator_Position) Reset()
func (x *TextLocator_Position) String() string
Describes a time interval:
type TimeInterval struct {
// Required. The end of the time interval.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// 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.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// contains filtered or unexported fields
}
func (*TimeInterval) Descriptor() ([]byte, []int)
Deprecated: Use TimeInterval.ProtoReflect.Descriptor instead.
func (x *TimeInterval) GetEndTime() *timestamppb.Timestamp
func (x *TimeInterval) GetStartTime() *timestamppb.Timestamp
func (*TimeInterval) ProtoMessage()
func (x *TimeInterval) ProtoReflect() protoreflect.Message
func (x *TimeInterval) Reset()
func (x *TimeInterval) String() string
A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
type TimeSeries struct {
// The associated metric. A fully-specified metric used to identify the time
// series.
Metric *metric.Metric `protobuf:"bytes,1,opt,name=metric,proto3" json:"metric,omitempty"`
// 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 *monitoredres.MonitoredResource `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`
// 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 *monitoredres.MonitoredResourceMetadata `protobuf:"bytes,7,opt,name=metadata,proto3" json:"metadata,omitempty"`
// 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`.
MetricKind metric.MetricDescriptor_MetricKind `protobuf:"varint,3,opt,name=metric_kind,json=metricKind,proto3,enum=google.api.MetricDescriptor_MetricKind" json:"metric_kind,omitempty"`
// 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.
ValueType metric.MetricDescriptor_ValueType `protobuf:"varint,4,opt,name=value_type,json=valueType,proto3,enum=google.api.MetricDescriptor_ValueType" json:"value_type,omitempty"`
// 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 `protobuf:"bytes,5,rep,name=points,proto3" json:"points,omitempty"`
// 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.
Unit string `protobuf:"bytes,8,opt,name=unit,proto3" json:"unit,omitempty"`
// contains filtered or unexported fields
}
func (*TimeSeries) Descriptor() ([]byte, []int)
Deprecated: Use TimeSeries.ProtoReflect.Descriptor instead.
func (x *TimeSeries) GetMetadata() *monitoredres.MonitoredResourceMetadata
func (x *TimeSeries) GetMetric() *metric.Metric
func (x *TimeSeries) GetMetricKind() metric.MetricDescriptor_MetricKind
func (x *TimeSeries) GetPoints() []*Point
func (x *TimeSeries) GetResource() *monitoredres.MonitoredResource
func (x *TimeSeries) GetUnit() string
func (x *TimeSeries) GetValueType() metric.MetricDescriptor_ValueType
func (*TimeSeries) ProtoMessage()
func (x *TimeSeries) ProtoReflect() protoreflect.Message
func (x *TimeSeries) Reset()
func (x *TimeSeries) String() string
Represents the values of a time series associated with a TimeSeriesDescriptor.
type TimeSeriesData struct {
// 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 `protobuf:"bytes,1,rep,name=label_values,json=labelValues,proto3" json:"label_values,omitempty"`
// The points in the time series.
PointData []*TimeSeriesData_PointData `protobuf:"bytes,2,rep,name=point_data,json=pointData,proto3" json:"point_data,omitempty"`
// contains filtered or unexported fields
}
func (*TimeSeriesData) Descriptor() ([]byte, []int)
Deprecated: Use TimeSeriesData.ProtoReflect.Descriptor instead.
func (x *TimeSeriesData) GetLabelValues() []*LabelValue
func (x *TimeSeriesData) GetPointData() []*TimeSeriesData_PointData
func (*TimeSeriesData) ProtoMessage()
func (x *TimeSeriesData) ProtoReflect() protoreflect.Message
func (x *TimeSeriesData) Reset()
func (x *TimeSeriesData) String() string
A point's value columns and time interval. Each point has one or more point values corresponding to the entries in `point_descriptors` field in the TimeSeriesDescriptor associated with this object.
type TimeSeriesData_PointData struct {
// The values that make up the point.
Values []*TypedValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// The time interval associated with the point.
TimeInterval *TimeInterval `protobuf:"bytes,2,opt,name=time_interval,json=timeInterval,proto3" json:"time_interval,omitempty"`
// contains filtered or unexported fields
}
func (*TimeSeriesData_PointData) Descriptor() ([]byte, []int)
Deprecated: Use TimeSeriesData_PointData.ProtoReflect.Descriptor instead.
func (x *TimeSeriesData_PointData) GetTimeInterval() *TimeInterval
func (x *TimeSeriesData_PointData) GetValues() []*TypedValue
func (*TimeSeriesData_PointData) ProtoMessage()
func (x *TimeSeriesData_PointData) ProtoReflect() protoreflect.Message
func (x *TimeSeriesData_PointData) Reset()
func (x *TimeSeriesData_PointData) String() string
A descriptor for the labels and points in a time series.
type TimeSeriesDescriptor struct {
// Descriptors for the labels.
LabelDescriptors []*label.LabelDescriptor `protobuf:"bytes,1,rep,name=label_descriptors,json=labelDescriptors,proto3" json:"label_descriptors,omitempty"`
// Descriptors for the point data value columns.
PointDescriptors []*TimeSeriesDescriptor_ValueDescriptor `protobuf:"bytes,5,rep,name=point_descriptors,json=pointDescriptors,proto3" json:"point_descriptors,omitempty"`
// contains filtered or unexported fields
}
func (*TimeSeriesDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use TimeSeriesDescriptor.ProtoReflect.Descriptor instead.
func (x *TimeSeriesDescriptor) GetLabelDescriptors() []*label.LabelDescriptor
func (x *TimeSeriesDescriptor) GetPointDescriptors() []*TimeSeriesDescriptor_ValueDescriptor
func (*TimeSeriesDescriptor) ProtoMessage()
func (x *TimeSeriesDescriptor) ProtoReflect() protoreflect.Message
func (x *TimeSeriesDescriptor) Reset()
func (x *TimeSeriesDescriptor) String() string
A descriptor for the value columns in a data point.
type TimeSeriesDescriptor_ValueDescriptor struct {
// The value key.
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// The value type.
ValueType metric.MetricDescriptor_ValueType `protobuf:"varint,2,opt,name=value_type,json=valueType,proto3,enum=google.api.MetricDescriptor_ValueType" json:"value_type,omitempty"`
// The value stream kind.
MetricKind metric.MetricDescriptor_MetricKind `protobuf:"varint,3,opt,name=metric_kind,json=metricKind,proto3,enum=google.api.MetricDescriptor_MetricKind" json:"metric_kind,omitempty"`
// The unit in which `time_series` point values are reported. `unit`
// follows the UCUM format for units as seen in
// https://unitsofmeasure.org/ucum.html.
// `unit` is only valid if `value_type` is INTEGER, DOUBLE, DISTRIBUTION.
Unit string `protobuf:"bytes,4,opt,name=unit,proto3" json:"unit,omitempty"`
// contains filtered or unexported fields
}
func (*TimeSeriesDescriptor_ValueDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use TimeSeriesDescriptor_ValueDescriptor.ProtoReflect.Descriptor instead.
func (x *TimeSeriesDescriptor_ValueDescriptor) GetKey() string
func (x *TimeSeriesDescriptor_ValueDescriptor) GetMetricKind() metric.MetricDescriptor_MetricKind
func (x *TimeSeriesDescriptor_ValueDescriptor) GetUnit() string
func (x *TimeSeriesDescriptor_ValueDescriptor) GetValueType() metric.MetricDescriptor_ValueType
func (*TimeSeriesDescriptor_ValueDescriptor) ProtoMessage()
func (x *TimeSeriesDescriptor_ValueDescriptor) ProtoReflect() protoreflect.Message
func (x *TimeSeriesDescriptor_ValueDescriptor) Reset()
func (x *TimeSeriesDescriptor_ValueDescriptor) String() string
A `TimeSeriesRatio` specifies two `TimeSeries` to use for computing the `good_service / total_service` ratio. The specified `TimeSeries` must have `ValueType = DOUBLE` or `ValueType = INT64` and must have `MetricKind = DELTA` or `MetricKind = CUMULATIVE`. The `TimeSeriesRatio` must specify exactly two of good, bad, and total, and the relationship `good_service + bad_service = total_service` will be assumed.
type TimeSeriesRatio struct {
// 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`.
GoodServiceFilter string `protobuf:"bytes,4,opt,name=good_service_filter,json=goodServiceFilter,proto3" json:"good_service_filter,omitempty"`
// 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`.
BadServiceFilter string `protobuf:"bytes,5,opt,name=bad_service_filter,json=badServiceFilter,proto3" json:"bad_service_filter,omitempty"`
// 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`.
TotalServiceFilter string `protobuf:"bytes,6,opt,name=total_service_filter,json=totalServiceFilter,proto3" json:"total_service_filter,omitempty"`
// contains filtered or unexported fields
}
func (*TimeSeriesRatio) Descriptor() ([]byte, []int)
Deprecated: Use TimeSeriesRatio.ProtoReflect.Descriptor instead.
func (x *TimeSeriesRatio) GetBadServiceFilter() string
func (x *TimeSeriesRatio) GetGoodServiceFilter() string
func (x *TimeSeriesRatio) GetTotalServiceFilter() string
func (*TimeSeriesRatio) ProtoMessage()
func (x *TimeSeriesRatio) ProtoReflect() protoreflect.Message
func (x *TimeSeriesRatio) Reset()
func (x *TimeSeriesRatio) String() string
A single strongly-typed value.
type TypedValue struct {
// The typed value field.
//
// Types that are assignable to Value:
//
// *TypedValue_BoolValue
// *TypedValue_Int64Value
// *TypedValue_DoubleValue
// *TypedValue_StringValue
// *TypedValue_DistributionValue
Value isTypedValue_Value `protobuf_oneof:"value"`
// contains filtered or unexported fields
}
func (*TypedValue) Descriptor() ([]byte, []int)
Deprecated: Use TypedValue.ProtoReflect.Descriptor instead.
func (x *TypedValue) GetBoolValue() bool
func (x *TypedValue) GetDistributionValue() *distribution.Distribution
func (x *TypedValue) GetDoubleValue() float64
func (x *TypedValue) GetInt64Value() int64
func (x *TypedValue) GetStringValue() string
func (m *TypedValue) GetValue() isTypedValue_Value
func (*TypedValue) ProtoMessage()
func (x *TypedValue) ProtoReflect() protoreflect.Message
func (x *TypedValue) Reset()
func (x *TypedValue) String() string
type TypedValue_BoolValue struct {
// A Boolean value: `true` or `false`.
BoolValue bool `protobuf:"varint,1,opt,name=bool_value,json=boolValue,proto3,oneof"`
}
type TypedValue_DistributionValue struct {
// A distribution value.
DistributionValue *distribution.Distribution `protobuf:"bytes,5,opt,name=distribution_value,json=distributionValue,proto3,oneof"`
}
type TypedValue_DoubleValue struct {
// A 64-bit double-precision floating-point number. Its magnitude
// is approximately ±10<sup>±300</sup> and it has 16
// significant digits of precision.
DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}
type TypedValue_Int64Value struct {
// A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>.
Int64Value int64 `protobuf:"varint,2,opt,name=int64_value,json=int64Value,proto3,oneof"`
}
type TypedValue_StringValue struct {
// A variable-length string value.
StringValue string `protobuf:"bytes,4,opt,name=string_value,json=stringValue,proto3,oneof"`
}
UnimplementedAlertPolicyServiceServer can be embedded to have forward compatible implementations.
type UnimplementedAlertPolicyServiceServer struct {
}
func (*UnimplementedAlertPolicyServiceServer) CreateAlertPolicy(context.Context, *CreateAlertPolicyRequest) (*AlertPolicy, error)
func (*UnimplementedAlertPolicyServiceServer) DeleteAlertPolicy(context.Context, *DeleteAlertPolicyRequest) (*emptypb.Empty, error)
func (*UnimplementedAlertPolicyServiceServer) GetAlertPolicy(context.Context, *GetAlertPolicyRequest) (*AlertPolicy, error)
func (*UnimplementedAlertPolicyServiceServer) ListAlertPolicies(context.Context, *ListAlertPoliciesRequest) (*ListAlertPoliciesResponse, error)
func (*UnimplementedAlertPolicyServiceServer) UpdateAlertPolicy(context.Context, *UpdateAlertPolicyRequest) (*AlertPolicy, error)
UnimplementedGroupServiceServer can be embedded to have forward compatible implementations.
type UnimplementedGroupServiceServer struct {
}
func (*UnimplementedGroupServiceServer) CreateGroup(context.Context, *CreateGroupRequest) (*Group, error)
func (*UnimplementedGroupServiceServer) DeleteGroup(context.Context, *DeleteGroupRequest) (*emptypb.Empty, error)
func (*UnimplementedGroupServiceServer) GetGroup(context.Context, *GetGroupRequest) (*Group, error)
func (*UnimplementedGroupServiceServer) ListGroupMembers(context.Context, *ListGroupMembersRequest) (*ListGroupMembersResponse, error)
func (*UnimplementedGroupServiceServer) ListGroups(context.Context, *ListGroupsRequest) (*ListGroupsResponse, error)
func (*UnimplementedGroupServiceServer) UpdateGroup(context.Context, *UpdateGroupRequest) (*Group, error)
UnimplementedMetricServiceServer can be embedded to have forward compatible implementations.
type UnimplementedMetricServiceServer struct {
}
func (*UnimplementedMetricServiceServer) CreateMetricDescriptor(context.Context, *CreateMetricDescriptorRequest) (*metric.MetricDescriptor, error)
func (*UnimplementedMetricServiceServer) CreateServiceTimeSeries(context.Context, *CreateTimeSeriesRequest) (*emptypb.Empty, error)
func (*UnimplementedMetricServiceServer) CreateTimeSeries(context.Context, *CreateTimeSeriesRequest) (*emptypb.Empty, error)
func (*UnimplementedMetricServiceServer) DeleteMetricDescriptor(context.Context, *DeleteMetricDescriptorRequest) (*emptypb.Empty, error)
func (*UnimplementedMetricServiceServer) GetMetricDescriptor(context.Context, *GetMetricDescriptorRequest) (*metric.MetricDescriptor, error)
func (*UnimplementedMetricServiceServer) GetMonitoredResourceDescriptor(context.Context, *GetMonitoredResourceDescriptorRequest) (*monitoredres.MonitoredResourceDescriptor, error)
func (*UnimplementedMetricServiceServer) ListMetricDescriptors(context.Context, *ListMetricDescriptorsRequest) (*ListMetricDescriptorsResponse, error)
func (*UnimplementedMetricServiceServer) ListMonitoredResourceDescriptors(context.Context, *ListMonitoredResourceDescriptorsRequest) (*ListMonitoredResourceDescriptorsResponse, error)
func (*UnimplementedMetricServiceServer) ListTimeSeries(context.Context, *ListTimeSeriesRequest) (*ListTimeSeriesResponse, error)
UnimplementedNotificationChannelServiceServer can be embedded to have forward compatible implementations.
type UnimplementedNotificationChannelServiceServer struct {
}
func (*UnimplementedNotificationChannelServiceServer) CreateNotificationChannel(context.Context, *CreateNotificationChannelRequest) (*NotificationChannel, error)
func (*UnimplementedNotificationChannelServiceServer) DeleteNotificationChannel(context.Context, *DeleteNotificationChannelRequest) (*emptypb.Empty, error)
func (*UnimplementedNotificationChannelServiceServer) GetNotificationChannel(context.Context, *GetNotificationChannelRequest) (*NotificationChannel, error)
func (*UnimplementedNotificationChannelServiceServer) GetNotificationChannelDescriptor(context.Context, *GetNotificationChannelDescriptorRequest) (*NotificationChannelDescriptor, error)
func (*UnimplementedNotificationChannelServiceServer) GetNotificationChannelVerificationCode(context.Context, *GetNotificationChannelVerificationCodeRequest) (*GetNotificationChannelVerificationCodeResponse, error)
func (*UnimplementedNotificationChannelServiceServer) ListNotificationChannelDescriptors(context.Context, *ListNotificationChannelDescriptorsRequest) (*ListNotificationChannelDescriptorsResponse, error)
func (*UnimplementedNotificationChannelServiceServer) ListNotificationChannels(context.Context, *ListNotificationChannelsRequest) (*ListNotificationChannelsResponse, error)
func (*UnimplementedNotificationChannelServiceServer) SendNotificationChannelVerificationCode(context.Context, *SendNotificationChannelVerificationCodeRequest) (*emptypb.Empty, error)
func (*UnimplementedNotificationChannelServiceServer) UpdateNotificationChannel(context.Context, *UpdateNotificationChannelRequest) (*NotificationChannel, error)
func (*UnimplementedNotificationChannelServiceServer) VerifyNotificationChannel(context.Context, *VerifyNotificationChannelRequest) (*NotificationChannel, error)
UnimplementedQueryServiceServer can be embedded to have forward compatible implementations.
type UnimplementedQueryServiceServer struct {
}
func (*UnimplementedQueryServiceServer) QueryTimeSeries(context.Context, *QueryTimeSeriesRequest) (*QueryTimeSeriesResponse, error)
UnimplementedServiceMonitoringServiceServer can be embedded to have forward compatible implementations.
type UnimplementedServiceMonitoringServiceServer struct {
}
func (*UnimplementedServiceMonitoringServiceServer) CreateService(context.Context, *CreateServiceRequest) (*Service, error)
func (*UnimplementedServiceMonitoringServiceServer) CreateServiceLevelObjective(context.Context, *CreateServiceLevelObjectiveRequest) (*ServiceLevelObjective, error)
func (*UnimplementedServiceMonitoringServiceServer) DeleteService(context.Context, *DeleteServiceRequest) (*emptypb.Empty, error)
func (*UnimplementedServiceMonitoringServiceServer) DeleteServiceLevelObjective(context.Context, *DeleteServiceLevelObjectiveRequest) (*emptypb.Empty, error)
func (*UnimplementedServiceMonitoringServiceServer) GetService(context.Context, *GetServiceRequest) (*Service, error)
func (*UnimplementedServiceMonitoringServiceServer) GetServiceLevelObjective(context.Context, *GetServiceLevelObjectiveRequest) (*ServiceLevelObjective, error)
func (*UnimplementedServiceMonitoringServiceServer) ListServiceLevelObjectives(context.Context, *ListServiceLevelObjectivesRequest) (*ListServiceLevelObjectivesResponse, error)
func (*UnimplementedServiceMonitoringServiceServer) ListServices(context.Context, *ListServicesRequest) (*ListServicesResponse, error)
func (*UnimplementedServiceMonitoringServiceServer) UpdateService(context.Context, *UpdateServiceRequest) (*Service, error)
func (*UnimplementedServiceMonitoringServiceServer) UpdateServiceLevelObjective(context.Context, *UpdateServiceLevelObjectiveRequest) (*ServiceLevelObjective, error)
UnimplementedSnoozeServiceServer can be embedded to have forward compatible implementations.
type UnimplementedSnoozeServiceServer struct {
}
func (*UnimplementedSnoozeServiceServer) CreateSnooze(context.Context, *CreateSnoozeRequest) (*Snooze, error)
func (*UnimplementedSnoozeServiceServer) GetSnooze(context.Context, *GetSnoozeRequest) (*Snooze, error)
func (*UnimplementedSnoozeServiceServer) ListSnoozes(context.Context, *ListSnoozesRequest) (*ListSnoozesResponse, error)
func (*UnimplementedSnoozeServiceServer) UpdateSnooze(context.Context, *UpdateSnoozeRequest) (*Snooze, error)
UnimplementedUptimeCheckServiceServer can be embedded to have forward compatible implementations.
type UnimplementedUptimeCheckServiceServer struct {
}
func (*UnimplementedUptimeCheckServiceServer) CreateUptimeCheckConfig(context.Context, *CreateUptimeCheckConfigRequest) (*UptimeCheckConfig, error)
func (*UnimplementedUptimeCheckServiceServer) DeleteUptimeCheckConfig(context.Context, *DeleteUptimeCheckConfigRequest) (*emptypb.Empty, error)
func (*UnimplementedUptimeCheckServiceServer) GetUptimeCheckConfig(context.Context, *GetUptimeCheckConfigRequest) (*UptimeCheckConfig, error)
func (*UnimplementedUptimeCheckServiceServer) ListUptimeCheckConfigs(context.Context, *ListUptimeCheckConfigsRequest) (*ListUptimeCheckConfigsResponse, error)
func (*UnimplementedUptimeCheckServiceServer) ListUptimeCheckIps(context.Context, *ListUptimeCheckIpsRequest) (*ListUptimeCheckIpsResponse, error)
func (*UnimplementedUptimeCheckServiceServer) UpdateUptimeCheckConfig(context.Context, *UpdateUptimeCheckConfigRequest) (*UptimeCheckConfig, error)
The protocol for the `UpdateAlertPolicy` request.
type UpdateAlertPolicyRequest struct {
// Optional. A list of alerting policy field names. If this field is not
// empty, each listed field in the existing alerting policy is set to the
// value of the corresponding field in the supplied policy (`alert_policy`),
// or to the field's default value if the field is not in the supplied
// alerting policy. Fields not listed retain their previous value.
//
// Examples of valid field masks include `display_name`, `documentation`,
// `documentation.content`, `documentation.mime_type`, `user_labels`,
// `user_label.nameofkey`, `enabled`, `conditions`, `combiner`, etc.
//
// If this field is empty, then the supplied alerting policy replaces the
// existing policy. It is the same as deleting the existing policy and
// adding the supplied policy, except for the following:
//
// - The new policy will have the same `[ALERT_POLICY_ID]` as the former
// policy. This gives you continuity with the former policy in your
// notifications and incidents.
// - Conditions in the new policy will keep their former `[CONDITION_ID]` if
// the supplied condition includes the `name` field with that
// `[CONDITION_ID]`. If the supplied condition omits the `name` field,
// then a new `[CONDITION_ID]` is created.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. The updated alerting policy or the updated values for the
// fields listed in `update_mask`.
// If `update_mask` is not empty, any fields in this policy that are
// not in `update_mask` are ignored.
AlertPolicy *AlertPolicy `protobuf:"bytes,3,opt,name=alert_policy,json=alertPolicy,proto3" json:"alert_policy,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateAlertPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateAlertPolicyRequest.ProtoReflect.Descriptor instead.
func (x *UpdateAlertPolicyRequest) GetAlertPolicy() *AlertPolicy
func (x *UpdateAlertPolicyRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateAlertPolicyRequest) ProtoMessage()
func (x *UpdateAlertPolicyRequest) ProtoReflect() protoreflect.Message
func (x *UpdateAlertPolicyRequest) Reset()
func (x *UpdateAlertPolicyRequest) String() string
The `UpdateGroup` request.
type UpdateGroupRequest struct {
// Required. The new definition of the group. All fields of the existing
// group, excepting `name`, are replaced with the corresponding fields of this
// group.
Group *Group `protobuf:"bytes,2,opt,name=group,proto3" json:"group,omitempty"`
// If true, validate this request but do not update the existing group.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateGroupRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateGroupRequest.ProtoReflect.Descriptor instead.
func (x *UpdateGroupRequest) GetGroup() *Group
func (x *UpdateGroupRequest) GetValidateOnly() bool
func (*UpdateGroupRequest) ProtoMessage()
func (x *UpdateGroupRequest) ProtoReflect() protoreflect.Message
func (x *UpdateGroupRequest) Reset()
func (x *UpdateGroupRequest) String() string
The `UpdateNotificationChannel` request.
type UpdateNotificationChannelRequest struct {
// The fields to update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. A description of the changes to be applied to the specified
// notification channel. The description must provide a definition for
// fields to be updated; the names of these fields should also be
// included in the `update_mask`.
NotificationChannel *NotificationChannel `protobuf:"bytes,3,opt,name=notification_channel,json=notificationChannel,proto3" json:"notification_channel,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateNotificationChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateNotificationChannelRequest.ProtoReflect.Descriptor instead.
func (x *UpdateNotificationChannelRequest) GetNotificationChannel() *NotificationChannel
func (x *UpdateNotificationChannelRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateNotificationChannelRequest) ProtoMessage()
func (x *UpdateNotificationChannelRequest) ProtoReflect() protoreflect.Message
func (x *UpdateNotificationChannelRequest) Reset()
func (x *UpdateNotificationChannelRequest) String() string
The `UpdateServiceLevelObjective` request.
type UpdateServiceLevelObjectiveRequest struct {
// Required. The `ServiceLevelObjective` to draw updates from.
// The given `name` specifies the resource to update.
ServiceLevelObjective *ServiceLevelObjective `protobuf:"bytes,1,opt,name=service_level_objective,json=serviceLevelObjective,proto3" json:"service_level_objective,omitempty"`
// A set of field paths defining which fields to use for the update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateServiceLevelObjectiveRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateServiceLevelObjectiveRequest.ProtoReflect.Descriptor instead.
func (x *UpdateServiceLevelObjectiveRequest) GetServiceLevelObjective() *ServiceLevelObjective
func (x *UpdateServiceLevelObjectiveRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateServiceLevelObjectiveRequest) ProtoMessage()
func (x *UpdateServiceLevelObjectiveRequest) ProtoReflect() protoreflect.Message
func (x *UpdateServiceLevelObjectiveRequest) Reset()
func (x *UpdateServiceLevelObjectiveRequest) String() string
The `UpdateService` request.
type UpdateServiceRequest struct {
// Required. The `Service` to draw updates from.
// The given `name` specifies the resource to update.
Service *Service `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
// A set of field paths defining which fields to use for the update.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateServiceRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateServiceRequest.ProtoReflect.Descriptor instead.
func (x *UpdateServiceRequest) GetService() *Service
func (x *UpdateServiceRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateServiceRequest) ProtoMessage()
func (x *UpdateServiceRequest) ProtoReflect() protoreflect.Message
func (x *UpdateServiceRequest) Reset()
func (x *UpdateServiceRequest) String() string
The message definition for updating a `Snooze`. The field, `snooze.name` identifies the `Snooze` to be updated. The remainder of `snooze` gives the content the `Snooze` in question will be assigned.
What fields can be updated depends on the start time and end time of the `Snooze`.
type UpdateSnoozeRequest struct {
// Required. The `Snooze` to update. Must have the name field present.
Snooze *Snooze `protobuf:"bytes,1,opt,name=snooze,proto3" json:"snooze,omitempty"`
// Required. The fields to update.
//
// For each field listed in `update_mask`:
//
// - If the `Snooze` object supplied in the `UpdateSnoozeRequest` has a
// value for that field, the value of the field in the existing `Snooze`
// will be set to the value of the field in the supplied `Snooze`.
// - If the field does not have a value in the supplied `Snooze`, the field
// in the existing `Snooze` is set to its default value.
//
// Fields not listed retain their existing value.
//
// The following are the field names that are accepted in `update_mask`:
//
// - `display_name`
// - `interval.start_time`
// - `interval.end_time`
//
// That said, the start time and end time of the `Snooze` determines which
// fields can legally be updated. Before attempting an update, users should
// consult the documentation for `UpdateSnoozeRequest`, which talks about
// which fields can be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateSnoozeRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSnoozeRequest.ProtoReflect.Descriptor instead.
func (x *UpdateSnoozeRequest) GetSnooze() *Snooze
func (x *UpdateSnoozeRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateSnoozeRequest) ProtoMessage()
func (x *UpdateSnoozeRequest) ProtoReflect() protoreflect.Message
func (x *UpdateSnoozeRequest) Reset()
func (x *UpdateSnoozeRequest) String() string
The protocol for the `UpdateUptimeCheckConfig` request.
type UpdateUptimeCheckConfigRequest struct {
// Optional. If present, only the listed fields in the current Uptime check
// configuration are updated with values from the new configuration. If this
// field is empty, then the current configuration is completely replaced with
// the new configuration.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. If an `updateMask` has been specified, this field gives
// the values for the set of fields mentioned in the `updateMask`. If an
// `updateMask` has not been given, this Uptime check configuration replaces
// the current configuration. If a field is mentioned in `updateMask` but
// the corresponding field is omitted in this partial Uptime check
// configuration, it has the effect of deleting/clearing the field from the
// configuration on the server.
//
// The following fields can be updated: `display_name`,
// `http_check`, `tcp_check`, `timeout`, `content_matchers`, and
// `selected_regions`.
UptimeCheckConfig *UptimeCheckConfig `protobuf:"bytes,3,opt,name=uptime_check_config,json=uptimeCheckConfig,proto3" json:"uptime_check_config,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateUptimeCheckConfigRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUptimeCheckConfigRequest.ProtoReflect.Descriptor instead.
func (x *UpdateUptimeCheckConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (x *UpdateUptimeCheckConfigRequest) GetUptimeCheckConfig() *UptimeCheckConfig
func (*UpdateUptimeCheckConfigRequest) ProtoMessage()
func (x *UpdateUptimeCheckConfigRequest) ProtoReflect() protoreflect.Message
func (x *UpdateUptimeCheckConfigRequest) Reset()
func (x *UpdateUptimeCheckConfigRequest) String() string
This message configures which resources and services to monitor for availability.
type UptimeCheckConfig struct {
// 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.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The resource the check is checking. Required.
//
// Types that are assignable to Resource:
//
// *UptimeCheckConfig_MonitoredResource
// *UptimeCheckConfig_ResourceGroup_
// *UptimeCheckConfig_SyntheticMonitor
Resource isUptimeCheckConfig_Resource `protobuf_oneof:"resource"`
// The type of Uptime check request.
//
// Types that are assignable to CheckRequestType:
//
// *UptimeCheckConfig_HttpCheck_
// *UptimeCheckConfig_TcpCheck_
CheckRequestType isUptimeCheckConfig_CheckRequestType `protobuf_oneof:"check_request_type"`
// 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`.
Period *durationpb.Duration `protobuf:"bytes,7,opt,name=period,proto3" json:"period,omitempty"`
// The maximum amount of time to wait for the request to complete (must be
// between 1 and 60 seconds). Required.
Timeout *durationpb.Duration `protobuf:"bytes,8,opt,name=timeout,proto3" json:"timeout,omitempty"`
// 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 []*UptimeCheckConfig_ContentMatcher `protobuf:"bytes,9,rep,name=content_matchers,json=contentMatchers,proto3" json:"content_matchers,omitempty"`
// The type of checkers to use to execute the Uptime check.
CheckerType UptimeCheckConfig_CheckerType `protobuf:"varint,17,opt,name=checker_type,json=checkerType,proto3,enum=google.monitoring.v3.UptimeCheckConfig_CheckerType" json:"checker_type,omitempty"`
// 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.
SelectedRegions []UptimeCheckRegion `protobuf:"varint,10,rep,packed,name=selected_regions,json=selectedRegions,proto3,enum=google.monitoring.v3.UptimeCheckRegion" json:"selected_regions,omitempty"`
// 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`.
//
// Deprecated: Marked as deprecated in google/monitoring/v3/uptime.proto.
IsInternal bool `protobuf:"varint,15,opt,name=is_internal,json=isInternal,proto3" json:"is_internal,omitempty"`
// 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`.
//
// Deprecated: Marked as deprecated in google/monitoring/v3/uptime.proto.
InternalCheckers []*InternalChecker `protobuf:"bytes,14,rep,name=internal_checkers,json=internalCheckers,proto3" json:"internal_checkers,omitempty"`
// 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 `protobuf:"bytes,20,rep,name=user_labels,json=userLabels,proto3" json:"user_labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig.ProtoReflect.Descriptor instead.
func (m *UptimeCheckConfig) GetCheckRequestType() isUptimeCheckConfig_CheckRequestType
func (x *UptimeCheckConfig) GetCheckerType() UptimeCheckConfig_CheckerType
func (x *UptimeCheckConfig) GetContentMatchers() []*UptimeCheckConfig_ContentMatcher
func (x *UptimeCheckConfig) GetDisplayName() string
func (x *UptimeCheckConfig) GetHttpCheck() *UptimeCheckConfig_HttpCheck
func (x *UptimeCheckConfig) GetInternalCheckers() []*InternalChecker
Deprecated: Marked as deprecated in google/monitoring/v3/uptime.proto.
func (x *UptimeCheckConfig) GetIsInternal() bool
Deprecated: Marked as deprecated in google/monitoring/v3/uptime.proto.
func (x *UptimeCheckConfig) GetMonitoredResource() *monitoredres.MonitoredResource
func (x *UptimeCheckConfig) GetName() string
func (x *UptimeCheckConfig) GetPeriod() *durationpb.Duration
func (m *UptimeCheckConfig) GetResource() isUptimeCheckConfig_Resource
func (x *UptimeCheckConfig) GetResourceGroup() *UptimeCheckConfig_ResourceGroup
func (x *UptimeCheckConfig) GetSelectedRegions() []UptimeCheckRegion
func (x *UptimeCheckConfig) GetSyntheticMonitor() *SyntheticMonitorTarget
func (x *UptimeCheckConfig) GetTcpCheck() *UptimeCheckConfig_TcpCheck
func (x *UptimeCheckConfig) GetTimeout() *durationpb.Duration
func (x *UptimeCheckConfig) GetUserLabels() map[string]string
func (*UptimeCheckConfig) ProtoMessage()
func (x *UptimeCheckConfig) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig) Reset()
func (x *UptimeCheckConfig) String() string
What kind of checkers are available to be used by the check.
type UptimeCheckConfig_CheckerType int32
const (
// The default checker type. Currently converted to `STATIC_IP_CHECKERS`
// on creation, the default conversion behavior may change in the future.
UptimeCheckConfig_CHECKER_TYPE_UNSPECIFIED UptimeCheckConfig_CheckerType = 0
// `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`.
UptimeCheckConfig_STATIC_IP_CHECKERS UptimeCheckConfig_CheckerType = 1
// `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`.
UptimeCheckConfig_VPC_CHECKERS UptimeCheckConfig_CheckerType = 3
)
func (UptimeCheckConfig_CheckerType) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckConfig_CheckerType) Enum() *UptimeCheckConfig_CheckerType
func (UptimeCheckConfig_CheckerType) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_CheckerType.Descriptor instead.
func (x UptimeCheckConfig_CheckerType) Number() protoreflect.EnumNumber
func (x UptimeCheckConfig_CheckerType) String() string
func (UptimeCheckConfig_CheckerType) Type() protoreflect.EnumType
Optional. Used to perform content matching. This allows matching based on substrings and regular expressions, together with their negations. Only the first 4 MB of an HTTP or HTTPS check's response (and the first 1 MB of a TCP check's response) are examined for purposes of content matching.
type UptimeCheckConfig_ContentMatcher struct {
// String, regex or JSON content to match. Maximum 1024 bytes. An empty
// `content` string indicates no content matching is to be performed.
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// The type of content matcher that will be applied to the server output,
// compared to the `content` string when the check is run.
Matcher UptimeCheckConfig_ContentMatcher_ContentMatcherOption `protobuf:"varint,2,opt,name=matcher,proto3,enum=google.monitoring.v3.UptimeCheckConfig_ContentMatcher_ContentMatcherOption" json:"matcher,omitempty"`
// Certain `ContentMatcherOption` types require additional information.
// `MATCHES_JSON_PATH` or `NOT_MATCHES_JSON_PATH` require a
// `JsonPathMatcher`; not used for other options.
//
// Types that are assignable to AdditionalMatcherInfo:
//
// *UptimeCheckConfig_ContentMatcher_JsonPathMatcher_
AdditionalMatcherInfo isUptimeCheckConfig_ContentMatcher_AdditionalMatcherInfo `protobuf_oneof:"additional_matcher_info"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_ContentMatcher) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_ContentMatcher.ProtoReflect.Descriptor instead.
func (m *UptimeCheckConfig_ContentMatcher) GetAdditionalMatcherInfo() isUptimeCheckConfig_ContentMatcher_AdditionalMatcherInfo
func (x *UptimeCheckConfig_ContentMatcher) GetContent() string
func (x *UptimeCheckConfig_ContentMatcher) GetJsonPathMatcher() *UptimeCheckConfig_ContentMatcher_JsonPathMatcher
func (x *UptimeCheckConfig_ContentMatcher) GetMatcher() UptimeCheckConfig_ContentMatcher_ContentMatcherOption
func (*UptimeCheckConfig_ContentMatcher) ProtoMessage()
func (x *UptimeCheckConfig_ContentMatcher) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_ContentMatcher) Reset()
func (x *UptimeCheckConfig_ContentMatcher) String() string
Options to perform content matching.
type UptimeCheckConfig_ContentMatcher_ContentMatcherOption int32
const (
// No content matcher type specified (maintained for backward
// compatibility, but deprecated for future use).
// Treated as `CONTAINS_STRING`.
UptimeCheckConfig_ContentMatcher_CONTENT_MATCHER_OPTION_UNSPECIFIED UptimeCheckConfig_ContentMatcher_ContentMatcherOption = 0
// 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`.
UptimeCheckConfig_ContentMatcher_CONTAINS_STRING UptimeCheckConfig_ContentMatcher_ContentMatcherOption = 1
// Selects negation of substring matching. The match succeeds if the
// output does _NOT_ contain the `content` string.
UptimeCheckConfig_ContentMatcher_NOT_CONTAINS_STRING UptimeCheckConfig_ContentMatcher_ContentMatcherOption = 2
// 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.
UptimeCheckConfig_ContentMatcher_MATCHES_REGEX UptimeCheckConfig_ContentMatcher_ContentMatcherOption = 3
// 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.
UptimeCheckConfig_ContentMatcher_NOT_MATCHES_REGEX UptimeCheckConfig_ContentMatcher_ContentMatcherOption = 4
// Selects JSONPath matching. See `JsonPathMatcher` for details on when
// the match succeeds. JSONPath matching is only supported for HTTP/HTTPS
// checks.
UptimeCheckConfig_ContentMatcher_MATCHES_JSON_PATH UptimeCheckConfig_ContentMatcher_ContentMatcherOption = 5
// 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.
UptimeCheckConfig_ContentMatcher_NOT_MATCHES_JSON_PATH UptimeCheckConfig_ContentMatcher_ContentMatcherOption = 6
)
func (UptimeCheckConfig_ContentMatcher_ContentMatcherOption) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckConfig_ContentMatcher_ContentMatcherOption) Enum() *UptimeCheckConfig_ContentMatcher_ContentMatcherOption
func (UptimeCheckConfig_ContentMatcher_ContentMatcherOption) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_ContentMatcher_ContentMatcherOption.Descriptor instead.
func (x UptimeCheckConfig_ContentMatcher_ContentMatcherOption) Number() protoreflect.EnumNumber
func (x UptimeCheckConfig_ContentMatcher_ContentMatcherOption) String() string
func (UptimeCheckConfig_ContentMatcher_ContentMatcherOption) Type() protoreflect.EnumType
Information needed to perform a JSONPath content match. Used for `ContentMatcherOption::MATCHES_JSON_PATH` and `ContentMatcherOption::NOT_MATCHES_JSON_PATH`.
type UptimeCheckConfig_ContentMatcher_JsonPathMatcher struct {
// JSONPath within the response output pointing to the expected
// `ContentMatcher::content` to match against.
JsonPath string `protobuf:"bytes,1,opt,name=json_path,json=jsonPath,proto3" json:"json_path,omitempty"`
// The type of JSONPath match that will be applied to the JSON output
// (`ContentMatcher.content`)
JsonMatcher UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption `protobuf:"varint,2,opt,name=json_matcher,json=jsonMatcher,proto3,enum=google.monitoring.v3.UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption" json:"json_matcher,omitempty"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_ContentMatcher_JsonPathMatcher) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_ContentMatcher_JsonPathMatcher.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_ContentMatcher_JsonPathMatcher) GetJsonMatcher() UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption
func (x *UptimeCheckConfig_ContentMatcher_JsonPathMatcher) GetJsonPath() string
func (*UptimeCheckConfig_ContentMatcher_JsonPathMatcher) ProtoMessage()
func (x *UptimeCheckConfig_ContentMatcher_JsonPathMatcher) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_ContentMatcher_JsonPathMatcher) Reset()
func (x *UptimeCheckConfig_ContentMatcher_JsonPathMatcher) String() string
type UptimeCheckConfig_ContentMatcher_JsonPathMatcher_ struct {
// Matcher information for `MATCHES_JSON_PATH` and `NOT_MATCHES_JSON_PATH`
JsonPathMatcher *UptimeCheckConfig_ContentMatcher_JsonPathMatcher `protobuf:"bytes,3,opt,name=json_path_matcher,json=jsonPathMatcher,proto3,oneof"`
}
Options to perform JSONPath content matching.
type UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption int32
const (
// No JSONPath matcher type specified (not valid).
UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JSON_PATH_MATCHER_OPTION_UNSPECIFIED UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption = 0
// 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.
UptimeCheckConfig_ContentMatcher_JsonPathMatcher_EXACT_MATCH UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption = 1
// 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.
UptimeCheckConfig_ContentMatcher_JsonPathMatcher_REGEX_MATCH UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption = 2
)
func (UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption) Enum() *UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption
func (UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption.Descriptor instead.
func (x UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption) Number() protoreflect.EnumNumber
func (x UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption) String() string
func (UptimeCheckConfig_ContentMatcher_JsonPathMatcher_JsonPathMatcherOption) Type() protoreflect.EnumType
Information involved in an HTTP/HTTPS Uptime check request.
type UptimeCheckConfig_HttpCheck struct {
// The HTTP request method to use for the check. If set to
// `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
RequestMethod UptimeCheckConfig_HttpCheck_RequestMethod `protobuf:"varint,8,opt,name=request_method,json=requestMethod,proto3,enum=google.monitoring.v3.UptimeCheckConfig_HttpCheck_RequestMethod" json:"request_method,omitempty"`
// If `true`, use HTTPS instead of HTTP to run the check.
UseSsl bool `protobuf:"varint,1,opt,name=use_ssl,json=useSsl,proto3" json:"use_ssl,omitempty"`
// 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.
Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
// 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.
Port int32 `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"`
// The authentication information. Optional when creating an HTTP check;
// defaults to empty.
// Do not set both `auth_method` and `auth_info`.
AuthInfo *UptimeCheckConfig_HttpCheck_BasicAuthentication `protobuf:"bytes,4,opt,name=auth_info,json=authInfo,proto3" json:"auth_info,omitempty"`
// 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 `******.`
MaskHeaders bool `protobuf:"varint,5,opt,name=mask_headers,json=maskHeaders,proto3" json:"mask_headers,omitempty"`
// 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 `protobuf:"bytes,6,rep,name=headers,proto3" json:"headers,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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.
ContentType UptimeCheckConfig_HttpCheck_ContentType `protobuf:"varint,9,opt,name=content_type,json=contentType,proto3,enum=google.monitoring.v3.UptimeCheckConfig_HttpCheck_ContentType" json:"content_type,omitempty"`
// 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.
CustomContentType string `protobuf:"bytes,13,opt,name=custom_content_type,json=customContentType,proto3" json:"custom_content_type,omitempty"`
// 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.
ValidateSsl bool `protobuf:"varint,7,opt,name=validate_ssl,json=validateSsl,proto3" json:"validate_ssl,omitempty"`
// 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.
Body []byte `protobuf:"bytes,10,opt,name=body,proto3" json:"body,omitempty"`
// 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 []*UptimeCheckConfig_HttpCheck_ResponseStatusCode `protobuf:"bytes,11,rep,name=accepted_response_status_codes,json=acceptedResponseStatusCodes,proto3" json:"accepted_response_status_codes,omitempty"`
// Contains information needed to add pings to an HTTP check.
PingConfig *UptimeCheckConfig_PingConfig `protobuf:"bytes,12,opt,name=ping_config,json=pingConfig,proto3" json:"ping_config,omitempty"`
// This field is optional and should be set only by users interested in
// an authenticated uptime check.
// Do not set both `auth_method` and `auth_info`.
//
// Types that are assignable to AuthMethod:
//
// *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_
AuthMethod isUptimeCheckConfig_HttpCheck_AuthMethod `protobuf_oneof:"auth_method"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_HttpCheck) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_HttpCheck) GetAcceptedResponseStatusCodes() []*UptimeCheckConfig_HttpCheck_ResponseStatusCode
func (x *UptimeCheckConfig_HttpCheck) GetAuthInfo() *UptimeCheckConfig_HttpCheck_BasicAuthentication
func (m *UptimeCheckConfig_HttpCheck) GetAuthMethod() isUptimeCheckConfig_HttpCheck_AuthMethod
func (x *UptimeCheckConfig_HttpCheck) GetBody() []byte
func (x *UptimeCheckConfig_HttpCheck) GetContentType() UptimeCheckConfig_HttpCheck_ContentType
func (x *UptimeCheckConfig_HttpCheck) GetCustomContentType() string
func (x *UptimeCheckConfig_HttpCheck) GetHeaders() map[string]string
func (x *UptimeCheckConfig_HttpCheck) GetMaskHeaders() bool
func (x *UptimeCheckConfig_HttpCheck) GetPath() string
func (x *UptimeCheckConfig_HttpCheck) GetPingConfig() *UptimeCheckConfig_PingConfig
func (x *UptimeCheckConfig_HttpCheck) GetPort() int32
func (x *UptimeCheckConfig_HttpCheck) GetRequestMethod() UptimeCheckConfig_HttpCheck_RequestMethod
func (x *UptimeCheckConfig_HttpCheck) GetServiceAgentAuthentication() *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication
func (x *UptimeCheckConfig_HttpCheck) GetUseSsl() bool
func (x *UptimeCheckConfig_HttpCheck) GetValidateSsl() bool
func (*UptimeCheckConfig_HttpCheck) ProtoMessage()
func (x *UptimeCheckConfig_HttpCheck) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_HttpCheck) Reset()
func (x *UptimeCheckConfig_HttpCheck) String() string
type UptimeCheckConfig_HttpCheck_ struct {
// Contains information needed to make an HTTP or HTTPS check.
HttpCheck *UptimeCheckConfig_HttpCheck `protobuf:"bytes,5,opt,name=http_check,json=httpCheck,proto3,oneof"`
}
The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is supported in Uptime checks.
type UptimeCheckConfig_HttpCheck_BasicAuthentication struct {
// The username to use when authenticating with the HTTP server.
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
// The password to use when authenticating with the HTTP server.
Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_HttpCheck_BasicAuthentication) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck_BasicAuthentication.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_HttpCheck_BasicAuthentication) GetPassword() string
func (x *UptimeCheckConfig_HttpCheck_BasicAuthentication) GetUsername() string
func (*UptimeCheckConfig_HttpCheck_BasicAuthentication) ProtoMessage()
func (x *UptimeCheckConfig_HttpCheck_BasicAuthentication) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_HttpCheck_BasicAuthentication) Reset()
func (x *UptimeCheckConfig_HttpCheck_BasicAuthentication) String() string
Header options corresponding to the content type of a HTTP request body.
type UptimeCheckConfig_HttpCheck_ContentType int32
const (
// No content type specified.
UptimeCheckConfig_HttpCheck_TYPE_UNSPECIFIED UptimeCheckConfig_HttpCheck_ContentType = 0
// `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
// to `application/x-www-form-urlencoded` in the HTTP request.
UptimeCheckConfig_HttpCheck_URL_ENCODED UptimeCheckConfig_HttpCheck_ContentType = 1
// `body` is in `custom_content_type` form. Equivalent to setting the
// `Content-Type` to the contents of `custom_content_type` in the HTTP
// request.
UptimeCheckConfig_HttpCheck_USER_PROVIDED UptimeCheckConfig_HttpCheck_ContentType = 2
)
func (UptimeCheckConfig_HttpCheck_ContentType) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckConfig_HttpCheck_ContentType) Enum() *UptimeCheckConfig_HttpCheck_ContentType
func (UptimeCheckConfig_HttpCheck_ContentType) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck_ContentType.Descriptor instead.
func (x UptimeCheckConfig_HttpCheck_ContentType) Number() protoreflect.EnumNumber
func (x UptimeCheckConfig_HttpCheck_ContentType) String() string
func (UptimeCheckConfig_HttpCheck_ContentType) Type() protoreflect.EnumType
The HTTP request method options.
type UptimeCheckConfig_HttpCheck_RequestMethod int32
const (
// No request method specified.
UptimeCheckConfig_HttpCheck_METHOD_UNSPECIFIED UptimeCheckConfig_HttpCheck_RequestMethod = 0
// GET request.
UptimeCheckConfig_HttpCheck_GET UptimeCheckConfig_HttpCheck_RequestMethod = 1
// POST request.
UptimeCheckConfig_HttpCheck_POST UptimeCheckConfig_HttpCheck_RequestMethod = 2
)
func (UptimeCheckConfig_HttpCheck_RequestMethod) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckConfig_HttpCheck_RequestMethod) Enum() *UptimeCheckConfig_HttpCheck_RequestMethod
func (UptimeCheckConfig_HttpCheck_RequestMethod) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck_RequestMethod.Descriptor instead.
func (x UptimeCheckConfig_HttpCheck_RequestMethod) Number() protoreflect.EnumNumber
func (x UptimeCheckConfig_HttpCheck_RequestMethod) String() string
func (UptimeCheckConfig_HttpCheck_RequestMethod) Type() protoreflect.EnumType
A status to accept. Either a status code class like "2xx", or an integer status code like "200".
type UptimeCheckConfig_HttpCheck_ResponseStatusCode struct {
// Either a specific value or a class of status codes.
//
// Types that are assignable to StatusCode:
//
// *UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusValue
// *UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass_
StatusCode isUptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusCode `protobuf_oneof:"status_code"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_HttpCheck_ResponseStatusCode) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck_ResponseStatusCode.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_HttpCheck_ResponseStatusCode) GetStatusClass() UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass
func (m *UptimeCheckConfig_HttpCheck_ResponseStatusCode) GetStatusCode() isUptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusCode
func (x *UptimeCheckConfig_HttpCheck_ResponseStatusCode) GetStatusValue() int32
func (*UptimeCheckConfig_HttpCheck_ResponseStatusCode) ProtoMessage()
func (x *UptimeCheckConfig_HttpCheck_ResponseStatusCode) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_HttpCheck_ResponseStatusCode) Reset()
func (x *UptimeCheckConfig_HttpCheck_ResponseStatusCode) String() string
An HTTP status code class.
type UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass int32
const (
// Default value that matches no status codes.
UptimeCheckConfig_HttpCheck_ResponseStatusCode_STATUS_CLASS_UNSPECIFIED UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass = 0
// The class of status codes between 100 and 199.
UptimeCheckConfig_HttpCheck_ResponseStatusCode_STATUS_CLASS_1XX UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass = 100
// The class of status codes between 200 and 299.
UptimeCheckConfig_HttpCheck_ResponseStatusCode_STATUS_CLASS_2XX UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass = 200
// The class of status codes between 300 and 399.
UptimeCheckConfig_HttpCheck_ResponseStatusCode_STATUS_CLASS_3XX UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass = 300
// The class of status codes between 400 and 499.
UptimeCheckConfig_HttpCheck_ResponseStatusCode_STATUS_CLASS_4XX UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass = 400
// The class of status codes between 500 and 599.
UptimeCheckConfig_HttpCheck_ResponseStatusCode_STATUS_CLASS_5XX UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass = 500
// The class of all status codes.
UptimeCheckConfig_HttpCheck_ResponseStatusCode_STATUS_CLASS_ANY UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass = 1000
)
func (UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass) Enum() *UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass
func (UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass.Descriptor instead.
func (x UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass) Number() protoreflect.EnumNumber
func (x UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass) String() string
func (UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass) Type() protoreflect.EnumType
type UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass_ struct {
// A class of status codes to accept.
StatusClass UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass `protobuf:"varint,2,opt,name=status_class,json=statusClass,proto3,enum=google.monitoring.v3.UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusClass,oneof"`
}
type UptimeCheckConfig_HttpCheck_ResponseStatusCode_StatusValue struct {
// A status code to accept.
StatusValue int32 `protobuf:"varint,1,opt,name=status_value,json=statusValue,proto3,oneof"`
}
Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). The OIDC token will be generated for the Monitoring service agent service account.
type UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication struct {
// Type of authentication.
Type UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType `protobuf:"varint,1,opt,name=type,proto3,enum=google.monitoring.v3.UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType" json:"type,omitempty"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication) GetType() UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType
func (*UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication) ProtoMessage()
func (x *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication) Reset()
func (x *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication) String() string
type UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ struct {
// 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 *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication `protobuf:"bytes,14,opt,name=service_agent_authentication,json=serviceAgentAuthentication,proto3,oneof"`
}
Type of authentication.
type UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType int32
const (
// Default value, will result in OIDC Authentication.
UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType = 0
// OIDC Authentication
UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_OIDC_TOKEN UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType = 1
)
func (UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType) Enum() *UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType
func (UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType.Descriptor instead.
func (x UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType) Number() protoreflect.EnumNumber
func (x UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType) String() string
func (UptimeCheckConfig_HttpCheck_ServiceAgentAuthentication_ServiceAgentAuthenticationType) Type() protoreflect.EnumType
type UptimeCheckConfig_MonitoredResource struct {
// 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_revision`
MonitoredResource *monitoredres.MonitoredResource `protobuf:"bytes,3,opt,name=monitored_resource,json=monitoredResource,proto3,oneof"`
}
Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain.
type UptimeCheckConfig_PingConfig struct {
// Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
PingsCount int32 `protobuf:"varint,1,opt,name=pings_count,json=pingsCount,proto3" json:"pings_count,omitempty"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_PingConfig) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_PingConfig.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_PingConfig) GetPingsCount() int32
func (*UptimeCheckConfig_PingConfig) ProtoMessage()
func (x *UptimeCheckConfig_PingConfig) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_PingConfig) Reset()
func (x *UptimeCheckConfig_PingConfig) String() string
The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
type UptimeCheckConfig_ResourceGroup struct {
// 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]`.
GroupId string `protobuf:"bytes,1,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
// The resource type of the group members.
ResourceType GroupResourceType `protobuf:"varint,2,opt,name=resource_type,json=resourceType,proto3,enum=google.monitoring.v3.GroupResourceType" json:"resource_type,omitempty"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_ResourceGroup) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_ResourceGroup.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_ResourceGroup) GetGroupId() string
func (x *UptimeCheckConfig_ResourceGroup) GetResourceType() GroupResourceType
func (*UptimeCheckConfig_ResourceGroup) ProtoMessage()
func (x *UptimeCheckConfig_ResourceGroup) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_ResourceGroup) Reset()
func (x *UptimeCheckConfig_ResourceGroup) String() string
type UptimeCheckConfig_ResourceGroup_ struct {
// The group resource associated with the configuration.
ResourceGroup *UptimeCheckConfig_ResourceGroup `protobuf:"bytes,4,opt,name=resource_group,json=resourceGroup,proto3,oneof"`
}
type UptimeCheckConfig_SyntheticMonitor struct {
// Specifies a Synthetic Monitor to invoke.
SyntheticMonitor *SyntheticMonitorTarget `protobuf:"bytes,21,opt,name=synthetic_monitor,json=syntheticMonitor,proto3,oneof"`
}
Information required for a TCP Uptime check request.
type UptimeCheckConfig_TcpCheck struct {
// 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.
Port int32 `protobuf:"varint,1,opt,name=port,proto3" json:"port,omitempty"`
// Contains information needed to add pings to a TCP check.
PingConfig *UptimeCheckConfig_PingConfig `protobuf:"bytes,2,opt,name=ping_config,json=pingConfig,proto3" json:"ping_config,omitempty"`
// contains filtered or unexported fields
}
func (*UptimeCheckConfig_TcpCheck) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckConfig_TcpCheck.ProtoReflect.Descriptor instead.
func (x *UptimeCheckConfig_TcpCheck) GetPingConfig() *UptimeCheckConfig_PingConfig
func (x *UptimeCheckConfig_TcpCheck) GetPort() int32
func (*UptimeCheckConfig_TcpCheck) ProtoMessage()
func (x *UptimeCheckConfig_TcpCheck) ProtoReflect() protoreflect.Message
func (x *UptimeCheckConfig_TcpCheck) Reset()
func (x *UptimeCheckConfig_TcpCheck) String() string
type UptimeCheckConfig_TcpCheck_ struct {
// Contains information needed to make a TCP check.
TcpCheck *UptimeCheckConfig_TcpCheck `protobuf:"bytes,6,opt,name=tcp_check,json=tcpCheck,proto3,oneof"`
}
Contains the region, location, and list of IP addresses where checkers in the location run from.
type UptimeCheckIp struct {
// A broad region category in which the IP address is located.
Region UptimeCheckRegion `protobuf:"varint,1,opt,name=region,proto3,enum=google.monitoring.v3.UptimeCheckRegion" json:"region,omitempty"`
// 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.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// 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.
IpAddress string `protobuf:"bytes,3,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
// contains filtered or unexported fields
}
func (*UptimeCheckIp) Descriptor() ([]byte, []int)
Deprecated: Use UptimeCheckIp.ProtoReflect.Descriptor instead.
func (x *UptimeCheckIp) GetIpAddress() string
func (x *UptimeCheckIp) GetLocation() string
func (x *UptimeCheckIp) GetRegion() UptimeCheckRegion
func (*UptimeCheckIp) ProtoMessage()
func (x *UptimeCheckIp) ProtoReflect() protoreflect.Message
func (x *UptimeCheckIp) Reset()
func (x *UptimeCheckIp) String() string
The regions from which an Uptime check can be run.
type UptimeCheckRegion int32
const (
// Default value if no region is specified. Will result in Uptime checks
// running from all regions.
UptimeCheckRegion_REGION_UNSPECIFIED UptimeCheckRegion = 0
// Allows checks to run from locations within the United States of America.
UptimeCheckRegion_USA UptimeCheckRegion = 1
// Allows checks to run from locations within the continent of Europe.
UptimeCheckRegion_EUROPE UptimeCheckRegion = 2
// Allows checks to run from locations within the continent of South
// America.
UptimeCheckRegion_SOUTH_AMERICA UptimeCheckRegion = 3
// Allows checks to run from locations within the Asia Pacific area (ex:
// Singapore).
UptimeCheckRegion_ASIA_PACIFIC UptimeCheckRegion = 4
// Allows checks to run from locations within the western United States of
// America
UptimeCheckRegion_USA_OREGON UptimeCheckRegion = 5
// Allows checks to run from locations within the central United States of
// America
UptimeCheckRegion_USA_IOWA UptimeCheckRegion = 6
// Allows checks to run from locations within the eastern United States of
// America
UptimeCheckRegion_USA_VIRGINIA UptimeCheckRegion = 7
)
func (UptimeCheckRegion) Descriptor() protoreflect.EnumDescriptor
func (x UptimeCheckRegion) Enum() *UptimeCheckRegion
func (UptimeCheckRegion) EnumDescriptor() ([]byte, []int)
Deprecated: Use UptimeCheckRegion.Descriptor instead.
func (x UptimeCheckRegion) Number() protoreflect.EnumNumber
func (x UptimeCheckRegion) String() string
func (UptimeCheckRegion) Type() protoreflect.EnumType
UptimeCheckServiceClient is the client API for UptimeCheckService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type UptimeCheckServiceClient interface {
// Lists the existing valid Uptime check configurations for the project
// (leaving out any invalid configurations).
ListUptimeCheckConfigs(ctx context.Context, in *ListUptimeCheckConfigsRequest, opts ...grpc.CallOption) (*ListUptimeCheckConfigsResponse, error)
// Gets a single Uptime check configuration.
GetUptimeCheckConfig(ctx context.Context, in *GetUptimeCheckConfigRequest, opts ...grpc.CallOption) (*UptimeCheckConfig, error)
// Creates a new Uptime check configuration.
CreateUptimeCheckConfig(ctx context.Context, in *CreateUptimeCheckConfigRequest, opts ...grpc.CallOption) (*UptimeCheckConfig, error)
// Updates an Uptime check configuration. You can either replace the entire
// configuration with a new one or replace only certain fields in the current
// configuration by specifying the fields to be updated via `updateMask`.
// Returns the updated configuration.
UpdateUptimeCheckConfig(ctx context.Context, in *UpdateUptimeCheckConfigRequest, opts ...grpc.CallOption) (*UptimeCheckConfig, error)
// Deletes an Uptime check configuration. Note that this method will fail
// if the Uptime check configuration is referenced by an alert policy or
// other dependent configs that would be rendered invalid by the deletion.
DeleteUptimeCheckConfig(ctx context.Context, in *DeleteUptimeCheckConfigRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns the list of IP addresses that checkers run from
ListUptimeCheckIps(ctx context.Context, in *ListUptimeCheckIpsRequest, opts ...grpc.CallOption) (*ListUptimeCheckIpsResponse, error)
}
func NewUptimeCheckServiceClient(cc grpc.ClientConnInterface) UptimeCheckServiceClient
UptimeCheckServiceServer is the server API for UptimeCheckService service.
type UptimeCheckServiceServer interface {
// Lists the existing valid Uptime check configurations for the project
// (leaving out any invalid configurations).
ListUptimeCheckConfigs(context.Context, *ListUptimeCheckConfigsRequest) (*ListUptimeCheckConfigsResponse, error)
// Gets a single Uptime check configuration.
GetUptimeCheckConfig(context.Context, *GetUptimeCheckConfigRequest) (*UptimeCheckConfig, error)
// Creates a new Uptime check configuration.
CreateUptimeCheckConfig(context.Context, *CreateUptimeCheckConfigRequest) (*UptimeCheckConfig, error)
// Updates an Uptime check configuration. You can either replace the entire
// configuration with a new one or replace only certain fields in the current
// configuration by specifying the fields to be updated via `updateMask`.
// Returns the updated configuration.
UpdateUptimeCheckConfig(context.Context, *UpdateUptimeCheckConfigRequest) (*UptimeCheckConfig, error)
// Deletes an Uptime check configuration. Note that this method will fail
// if the Uptime check configuration is referenced by an alert policy or
// other dependent configs that would be rendered invalid by the deletion.
DeleteUptimeCheckConfig(context.Context, *DeleteUptimeCheckConfigRequest) (*emptypb.Empty, error)
// Returns the list of IP addresses that checkers run from
ListUptimeCheckIps(context.Context, *ListUptimeCheckIpsRequest) (*ListUptimeCheckIpsResponse, error)
}
The `VerifyNotificationChannel` request.
type VerifyNotificationChannelRequest struct {
// Required. The notification channel to verify.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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).
Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
// contains filtered or unexported fields
}
func (*VerifyNotificationChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use VerifyNotificationChannelRequest.ProtoReflect.Descriptor instead.
func (x *VerifyNotificationChannelRequest) GetCode() string
func (x *VerifyNotificationChannelRequest) GetName() string
func (*VerifyNotificationChannelRequest) ProtoMessage()
func (x *VerifyNotificationChannelRequest) ProtoReflect() protoreflect.Message
func (x *VerifyNotificationChannelRequest) Reset()
func (x *VerifyNotificationChannelRequest) String() string
A `WindowsBasedSli` defines `good_service` as the count of time windows for which the provided service was of good quality. Criteria for determining if service was good are embedded in the `window_criterion`.
type WindowsBasedSli struct {
// The criterion to use for evaluating window goodness.
//
// Types that are assignable to WindowCriterion:
//
// *WindowsBasedSli_GoodBadMetricFilter
// *WindowsBasedSli_GoodTotalRatioThreshold
// *WindowsBasedSli_MetricMeanInRange
// *WindowsBasedSli_MetricSumInRange
WindowCriterion isWindowsBasedSli_WindowCriterion `protobuf_oneof:"window_criterion"`
// Duration over which window quality is evaluated. Must be an integer
// fraction of a day and at least `60s`.
WindowPeriod *durationpb.Duration `protobuf:"bytes,4,opt,name=window_period,json=windowPeriod,proto3" json:"window_period,omitempty"`
// contains filtered or unexported fields
}
func (*WindowsBasedSli) Descriptor() ([]byte, []int)
Deprecated: Use WindowsBasedSli.ProtoReflect.Descriptor instead.
func (x *WindowsBasedSli) GetGoodBadMetricFilter() string
func (x *WindowsBasedSli) GetGoodTotalRatioThreshold() *WindowsBasedSli_PerformanceThreshold
func (x *WindowsBasedSli) GetMetricMeanInRange() *WindowsBasedSli_MetricRange
func (x *WindowsBasedSli) GetMetricSumInRange() *WindowsBasedSli_MetricRange
func (m *WindowsBasedSli) GetWindowCriterion() isWindowsBasedSli_WindowCriterion
func (x *WindowsBasedSli) GetWindowPeriod() *durationpb.Duration
func (*WindowsBasedSli) ProtoMessage()
func (x *WindowsBasedSli) ProtoReflect() protoreflect.Message
func (x *WindowsBasedSli) Reset()
func (x *WindowsBasedSli) String() string
type WindowsBasedSli_GoodBadMetricFilter struct {
// 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.
GoodBadMetricFilter string `protobuf:"bytes,5,opt,name=good_bad_metric_filter,json=goodBadMetricFilter,proto3,oneof"`
}
type WindowsBasedSli_GoodTotalRatioThreshold struct {
// A window is good if its `performance` is high enough.
GoodTotalRatioThreshold *WindowsBasedSli_PerformanceThreshold `protobuf:"bytes,2,opt,name=good_total_ratio_threshold,json=goodTotalRatioThreshold,proto3,oneof"`
}
type WindowsBasedSli_MetricMeanInRange struct {
// A window is good if the metric's value is in a good range, averaged
// across returned streams.
MetricMeanInRange *WindowsBasedSli_MetricRange `protobuf:"bytes,6,opt,name=metric_mean_in_range,json=metricMeanInRange,proto3,oneof"`
}
A `MetricRange` is used when each window is good when the value x of a single `TimeSeries` satisfies `range.min <= x <= range.max`. The provided `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and `MetricKind = GAUGE`.
type WindowsBasedSli_MetricRange struct {
// A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
// specifying the `TimeSeries` to use for evaluating window quality.
TimeSeries string `protobuf:"bytes,1,opt,name=time_series,json=timeSeries,proto3" json:"time_series,omitempty"`
// Range of values considered "good." For a one-sided range, set one bound
// to an infinite value.
Range *Range `protobuf:"bytes,4,opt,name=range,proto3" json:"range,omitempty"`
// contains filtered or unexported fields
}
func (*WindowsBasedSli_MetricRange) Descriptor() ([]byte, []int)
Deprecated: Use WindowsBasedSli_MetricRange.ProtoReflect.Descriptor instead.
func (x *WindowsBasedSli_MetricRange) GetRange() *Range
func (x *WindowsBasedSli_MetricRange) GetTimeSeries() string
func (*WindowsBasedSli_MetricRange) ProtoMessage()
func (x *WindowsBasedSli_MetricRange) ProtoReflect() protoreflect.Message
func (x *WindowsBasedSli_MetricRange) Reset()
func (x *WindowsBasedSli_MetricRange) String() string
type WindowsBasedSli_MetricSumInRange struct {
// A window is good if the metric's value is in a good range, summed across
// returned streams.
MetricSumInRange *WindowsBasedSli_MetricRange `protobuf:"bytes,7,opt,name=metric_sum_in_range,json=metricSumInRange,proto3,oneof"`
}
A `PerformanceThreshold` is used when each window is good when that window has a sufficiently high `performance`.
type WindowsBasedSli_PerformanceThreshold struct {
// The means, either a request-based SLI or a basic SLI, by which to compute
// performance over a window.
//
// Types that are assignable to Type:
//
// *WindowsBasedSli_PerformanceThreshold_Performance
// *WindowsBasedSli_PerformanceThreshold_BasicSliPerformance
Type isWindowsBasedSli_PerformanceThreshold_Type `protobuf_oneof:"type"`
// If window `performance >= threshold`, the window is counted as good.
Threshold float64 `protobuf:"fixed64,2,opt,name=threshold,proto3" json:"threshold,omitempty"`
// contains filtered or unexported fields
}
func (*WindowsBasedSli_PerformanceThreshold) Descriptor() ([]byte, []int)
Deprecated: Use WindowsBasedSli_PerformanceThreshold.ProtoReflect.Descriptor instead.
func (x *WindowsBasedSli_PerformanceThreshold) GetBasicSliPerformance() *BasicSli
func (x *WindowsBasedSli_PerformanceThreshold) GetPerformance() *RequestBasedSli
func (x *WindowsBasedSli_PerformanceThreshold) GetThreshold() float64
func (m *WindowsBasedSli_PerformanceThreshold) GetType() isWindowsBasedSli_PerformanceThreshold_Type
func (*WindowsBasedSli_PerformanceThreshold) ProtoMessage()
func (x *WindowsBasedSli_PerformanceThreshold) ProtoReflect() protoreflect.Message
func (x *WindowsBasedSli_PerformanceThreshold) Reset()
func (x *WindowsBasedSli_PerformanceThreshold) String() string
type WindowsBasedSli_PerformanceThreshold_BasicSliPerformance struct {
// `BasicSli` to evaluate to judge window quality.
BasicSliPerformance *BasicSli `protobuf:"bytes,3,opt,name=basic_sli_performance,json=basicSliPerformance,proto3,oneof"`
}
type WindowsBasedSli_PerformanceThreshold_Performance struct {
// `RequestBasedSli` to evaluate to judge window quality.
Performance *RequestBasedSli `protobuf:"bytes,1,opt,name=performance,proto3,oneof"`
}