Method: projects.locations.requirements.checkRequirement

Check a particular requirement.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}/requirements:checkRequirement

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
Fields
requirementType

string

The type specifying the requirement to check. The supported types are:

  • discoveryengine.googleapis.com/media_recs/general/all/warning
  • discoveryengine.googleapis.com/media_recs/oyml/cvr/warning
  • discoveryengine.googleapis.com/media_recs/rfy/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mlt/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mp/cvr/warning
  • discoveryengine.googleapis.com/media_recs/oyml/wdps/warning
  • discoveryengine.googleapis.com/media_recs/rfy/wdps/warning
  • discoveryengine.googleapis.com/media_recs/mlt/wdps/warning
resources[]

object (MonitoredResource)

The resources to be checked for this requirement. The type needed for the monitored resources:

  • discoveryengine.googleapis.com/Branch.

    • The labels needed for this resource:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • The labels needed for this resource:
      • project_number
      • location_id
      • collection_id
      • datastore_id

Response body

Response for the requirements.checkRequirement method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
Fields
requirement

object (Requirement)

Requirement definition.
requirementCondition

object (Expr)

The condition for evaluating the requirement result.
metricResults[]

object (MetricQueryResult)

Metric results.
oldestMetricTimestamp

string (Timestamp format)

Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the result may not accurately reflect any Event and Product Catalog updates performed after this time.

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

string

The result of the requirement. It should be one of the severity fields in the requirement definition. If any error happens during the evaluation, it will be UNKNOWN.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

MonitoredResource

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone":

{ "type": "gce_instance",
  "labels": { "project_id": "my-project",
              "instance_id": "12345678901234",
              "zone": "us-central1-a" }}
JSON representation 
{
  "type": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
type

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

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 "project_id", "instance_id", and "zone".

Requirement

A data requirement.

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

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
displayName

string

The name of the requirement.
description

string

The description of the requirement.
condition

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.
metricBindings[]

object (MetricBinding)

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

object (ThresholdBinding)

A list of threshold bindings to be used in condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

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

string

The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples:

  • BLOCKING
  • CRITICAL
  • WARNING

All thresholds in the requirement must have all the severity here.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.

Example (Comparison):

title: "Summary size limit"
description: "Determines if a summary is less than 100 chars"
expression: "document.summary.size() < 100"

Example (Equality):

title: "Requestor is owner"
description: "Determines if requestor is the document owner"
expression: "document.owner == request.auth.claims.email"

Example (Logic):

title: "Public documents"
description: "Determine whether the document should be publicly visible"
expression: "document.type != 'private' && document.type != 'internal'"

Example (Data Manipulation):

title: "Notification string"
description: "Create a notification string with a timestamp."
expression: "'New message received at ' + string(document.create_time)"

The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

JSON representation 
{
  "expression": string,
  "title": string,
  "description": string,
  "location": string
}
Fields
expression

string

Textual representation of an expression in Common Expression Language syntax.
title

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

string

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

string

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

MetricBinding

Specifies a metrics query and bind its result to a variable which will be used in the condition.

JSON representation 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
Fields
variableId

string

The variable id to be referenced in condition.
resourceType

string

The resource being monitored for the metric.
metricFilter

string

The filter string used for metrics query.

Example:

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

string

Human readable description of the corresponding metric filter.
category

string

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

ThresholdBinding

Specifies a multi-level threshold to apply to apply to a metricBindings in the condition CEL expression.

JSON representation 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
Fields
variableId

string

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

string

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

object (ThresholdValue)

The values of the threshold. The values should be ordered from the most strict to the least strict.

ThresholdValue

Specifies a threshold value for a given severity.

JSON representation 
{
  "severity": string,
  "value": number
}
Fields
severity

string

The severity of errors if the threshold is not met. It should be one of the severity fields in the requirement.
value

number

The value of the threshold.

ViolationSamplesBinding

Specifies a samples query and bind its result to a variable which will be used in the condition.

JSON representation 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
Fields
variableId

string

The variable id to be referenced in condition.
sampleFilter

string

The filter string used for samples query.

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

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.

MetricQueryResult

Metric result. The metric are in the requirementCondition.

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

string

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

object (TypedValue)

Value of the metric query.
timestamp

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

string

The unit in which this metric is reported. Follows

The Unified Code for Units of Measure standard.
metricType

string

Type identifier of the metric corresponding to this query result.

TypedValue

A single strongly-typed value.

JSON representation 
{

  // 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.
}
Fields
Union field value. The typed value field. value can be only one of the following:
boolValue

boolean

A Boolean value: true or false.
int64Value

string (int64 format)

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

number

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

string

A variable-length string value.
distributionValue

object (Distribution)

A distribution value.

Distribution

Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.

The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.

Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sumOfSquaredDeviation fields meaningless.

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

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

number

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

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

object (Range)

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

object (BucketOptions)

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

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).
exemplars[]

object (Exemplar)

Must be in increasing order of value field.

Range

The range of the population values.

JSON representation 
{
  "min": number,
  "max": number
}
Fields
min

number

The minimum of the population values.
max

number

The maximum of the population values.

BucketOptions

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.

A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.

JSON representation 
{

  // 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.
}
Fields
Union field options. Exactly one of these three fields must be set. options can be only one of the following:
linearBuckets

object (Linear)

The linear bucket.
exponentialBuckets

object (Exponential)

The exponential buckets.
explicitBuckets

object (Explicit)

The explicit buckets.

Linear

Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.

There are numFiniteBuckets + 2 (= N) buckets. Bucket i has the following boundaries:

Upper bound (0 <= i < N-1): offset + (width * i).

Lower bound (1 <= i < N): offset + (width * (i - 1)).

JSON representation 
{
  "numFiniteBuckets": integer,
  "width": number,
  "offset": number
}
Fields
numFiniteBuckets

integer

Must be greater than 0.
width

number

Must be greater than 0.
offset

number

Lower bound of the first bucket.

Exponential

Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.

There are numFiniteBuckets + 2 (= N) buckets. Bucket i has the following boundaries:

Upper bound (0 <= i < N-1): scale * (growthFactor ^ i).

Lower bound (1 <= i < N): scale * (growthFactor ^ (i - 1)).

JSON representation 
{
  "numFiniteBuckets": integer,
  "growthFactor": number,
  "scale": number
}
Fields
numFiniteBuckets

integer

Must be greater than 0.
growthFactor

number

Must be greater than 1.
scale

number

Must be greater than 0.

Explicit

Specifies a set of buckets with arbitrary widths.

There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:

Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1]

The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.

JSON representation 
{
  "bounds": [
    number
  ]
}
Fields
bounds[]

number

The values must be monotonically increasing.

Exemplar

Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a

trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.

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

number

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

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".
attachments[]

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