Method: projects.locations.requirements.checkRequirement

string

Required. Full resource name of the location. Format projects/{project_number_or_id}/locations/{location}

{
  "type": string,
  "labels": {
    string: string,
    ...
  }
}

string

Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. Some descriptors include the service name in the type; for example, the type of a Datastream stream is datastream.googleapis.com/Stream.

map (key: string, value: string)

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "projectId", "instanceId", and "zone".

{
  "type": string,
  "displayName": string,
  "description": string,
  "condition": {
    object (Expr)
  },
  "metricBindings": [
    {
      object (MetricBinding)
    }
  ],
  "thresholdBindings": [
    {
      object (ThresholdBinding)
    }
  ],
  "violationSamplesBindings": [
    {
      object (ViolationSamplesBinding)
    }
  ]
}

string

The requirement type, used as an identifier. Must be unique.

The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements.

Examples:

• library.googleapis.com/books/min_available_books
• discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate

string

The name of the requirement.

string

The description of the requirement.

object (Expr)

The condition for evaluating the requirement result.

Variables in the expression should be provided by metrics_bindings or thresholdBindings. Where metrics_bindings are used for computed metrics and thresholdBindings are used to define thresholds for corresponding metricBindings.

object (MetricBinding)

A list of the metric bindings to be used in condition.

object (ThresholdBinding)

A list of threshold bindings to be used in condition.

object (ViolationSamplesBinding)

A list of the metric bindings to be used in condition.

{
  "expression": string,
  "title": string,
  "description": string,
  "location": string
}

string

Textual representation of an expression in Common Expression Language syntax.

string

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}

string

The variable id to be referenced in condition.

string

The resource being monitored for the metric.

string

The filter string used for metrics query.

Example:

"metric.type = "discoveryengine.googleapis.com/events/day_count" AND " "metric.conditions.time_range = "NINETY_DAYS""

string

Human readable description of the corresponding metric filter.

string

The category of the metric's target resource. Example: "Events"

{
  "variableId": string,
  "warningThreshold": number,
  "blockingThreshold": number,
  "description": string
}

string

The variable id to be referenced in condition. Must be unique across all metricBindings and thresholdBindings.

number

Threshold to trigger a warning. If not met, the requirement will evaluate as a WARNING.

number

Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a FAILURE.

string

Human readable description of the corresponding threshold and sub-requirement.

{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}

string

The variable id to be referenced in condition.

string

The filter string used for samples query.

Example: "sample.type = "retail.googleapis.com/userEvent" AND " "sample.labels.event_type = "PURCHASE" "

string

Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition.

Should be less than 128 characters long.

{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}

string

This metric query name is mapping to variables in the requirementCondition.

object (TypedValue)

Value of the metric query.

string (Timestamp format)

Time corresponding to when this metric value was calculated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string

The unit in which this metric is reported. Follows The Unified Code for Units of Measure standard.

string

Type identifier of the metric corresponding to this query result.

{

  // Union field value can be only one of the following:
  "boolValue": boolean,
  "int64Value": string,
  "doubleValue": number,
  "stringValue": string,
  "distributionValue": {
    object (Distribution)
  }
  // End of list of possible types for union field value.
}

boolean

A Boolean value: true or false.

string (int64 format)

A 64-bit integer. Its range is approximately ±9.2x10¹⁸.

number

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

string

A variable-length string value.

object (Distribution)

A distribution value.

{
  "count": string,
  "mean": number,
  "sumOfSquaredDeviation": number,
  "range": {
    object (Range)
  },
  "bucketOptions": {
    object (BucketOptions)
  },
  "bucketCounts": [
    string
  ],
  "exemplars": [
    {
      object (Exemplar)
    }
  ]
}

string (int64 format)

The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucketCounts if a histogram is provided.

number

The arithmetic mean of the values in the population. If count is zero then this field must be zero.

number

The sum of squared deviations from the mean of the values in the population. For values x_i this is:

Sum[i=1..n]((x_i - mean)^2)

Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass.

If count is zero then this field must be zero.

object (Range)

If specified, contains the range of the population values. The field must not be present if the count is zero.

object (BucketOptions)

Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.

string (int64 format)

The number of values in each bucket of the histogram, as described in bucketOptions. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in bucketCounts must equal the value in the count field of the distribution.

If present, bucketCounts should contain N values, where N is the number of buckets specified in bucketOptions. If you supply fewer than N values, the remaining values are assumed to be 0.

The order of the values in bucketCounts follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in bucketCounts is the count for the overflow bucket (number N-1).

object (Exemplar)

Must be in increasing order of value field.

{
  "min": number,
  "max": number
}

number

The minimum of the population values.

number

The maximum of the population values.

{

  // Union field options can be only one of the following:
  "linearBuckets": {
    object (Linear)
  },
  "exponentialBuckets": {
    object (Exponential)
  },
  "explicitBuckets": {
    object (Explicit)
  }
  // End of list of possible types for union field options.
}

object (Linear)

The linear bucket.

object (Exponential)

The exponential buckets.

object (Explicit)

The explicit buckets.

{
  "numFiniteBuckets": integer,
  "width": number,
  "offset": number
}

integer

Must be greater than 0.

number

Must be greater than 0.

number

Lower bound of the first bucket.

{
  "numFiniteBuckets": integer,
  "growthFactor": number,
  "scale": number
}

integer

Must be greater than 0.

number

Must be greater than 1.

number

Must be greater than 0.

{
  "bounds": [
    number
  ]
}

number

The values must be monotonically increasing.

{
  "value": number,
  "timestamp": string,
  "attachments": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}

number

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

string (Timestamp format)

The observation (sampling) time of the above value.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.