Method: projects.locations.requirements.checkRequirement

Eine bestimmte Anforderung prüfen

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
location

string

Erforderlich. Vollständiger Ressourcenname des Standorts. projects/{project_number_or_id}/locations/{location} formatieren

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
Felder
requirementType

string

Der Typ, der die zu prüfende Anforderung angibt. Folgende Typen werden unterstützt:

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

Die Ressourcen, die für diese Anforderung geprüft werden müssen. Der für die überwachten Ressourcen erforderliche Typ:

  • discoveryengine.googleapis.com/Branch.

    • Die für diese Ressource erforderlichen Labels:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • Die für diese Ressource erforderlichen Labels:
      • project_number
      • location_id
      • collection_id
      • datastore_id

Antworttext

Antwort für die Methode „requirements.checkRequirement“.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

object (Requirement)

Anforderungsdefinition.
requirementCondition

object (Expr)

Die Bedingung für die Auswertung des Anforderungsergebnisses.
metricResults[]

object (MetricQueryResult)

Messwertergebnisse
oldestMetricTimestamp

string (Timestamp format)

Zeitstempel des ältesten berechneten Messwerts (d.h. des Messwerts mit der größten Zeitverzögerung). Gibt an, dass die result möglicherweise nicht alle Aktualisierungen von Ereignis- und Produktkatalogen widerspiegelt, die nach diesem Zeitpunkt vorgenommen wurden.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
result

string

Das Ergebnis der Anforderung. Es sollte eines der severity-Felder in der Anforderungsdefinition sein. Wenn während der Auswertung ein Fehler auftritt, ist der Wert UNKNOWN.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

Anforderung

Eine Datenanforderung.

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

string

Der Anforderungstyp, der als Kennung verwendet wird. Muss eindeutig sein.

Der Typ sollte mit dem Dienstnamen beginnen, um mögliche Konflikte zu vermeiden. Es wird empfohlen, ähnliche Anforderungen in natürlichen hierarchischen Gruppen zusammenzufassen.

Beispiele:

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

string

Der Name der Anforderung.
description

string

Die Beschreibung der Anforderung.
condition

object (Expr)

Die Bedingung für die Auswertung des Anforderungsergebnisses.

Variablen im Ausdruck sollten von metrics_bindings oder thresholdBindings bereitgestellt werden. Dabei werden metrics_bindings für berechnete Messwerte und thresholdBindings zum Definieren von Grenzwerten für die entsprechenden metricBindings verwendet.
metricBindings[]

object (MetricBinding)

Eine Liste der Messwertbindungen, die in condition verwendet werden sollen.
thresholdBindings[]

object (ThresholdBinding)

Eine Liste der Schwellenwertbindungen, die in condition verwendet werden sollen.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Eine Liste der Messwertbindungen, die in condition verwendet werden sollen.
severity[]

string

Der Schweregrad von Fehlern, wenn die Anforderung nicht erfüllt ist. Sie muss von der strengsten zur am wenigsten strengen Regel sortiert sein. Beispiele:

  • BLOCKING
  • CRITICAL
  • WARNING

Alle Grenzwerte in der Anforderung müssen alle Schweregrade hier haben.

MetricBinding

Gibt eine Messwertabfrage an und bindet ihr Ergebnis an eine Variable, die in condition verwendet wird.

JSON-Darstellung 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
Felder
variableId

string

Die Variablen-ID, auf die in condition verwiesen werden soll.
resourceType

string

Die Ressource, die für den Messwert überwacht wird.
metricFilter

string

Der Filterstring, der für die Messwertabfrage verwendet wird.

Beispiel:

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

string

Eine für Menschen lesbare Beschreibung des entsprechenden Messwertfilters.
category

string

Die Kategorie der Zielressource des Messwerts. Beispiel: „Events“

ThresholdBinding

Gibt einen mehrstufigen Schwellenwert an, der auf ein metricBindings im CEL-Ausdruck condition angewendet werden soll.

JSON-Darstellung 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
Felder
variableId

string

Die Variablen-ID, auf die in condition verwiesen werden soll. Muss für alle metricBindings und thresholdBindings eindeutig sein.
description

string

Für Menschen lesbare Beschreibung der entsprechenden Mindestanforderung und untergeordneten Anforderung.
thresholdValues[]

object (ThresholdValue)

Die Werte des Schwellenwerts. Die Werte sollten vom strengsten zum am wenigsten strengen sortiert werden.

ThresholdValue

Gibt einen Schwellenwert für einen bestimmten Schweregrad an.

JSON-Darstellung 
{
  "severity": string,
  "value": number
}
Felder
severity

string

Der Schweregrad von Fehlern, wenn der Grenzwert nicht erreicht wird. Es sollte eines der severity-Felder in der Anforderung sein.
value

number

Der Wert des Schwellenwerts.

ViolationSamplesBinding

Gibt eine Abfrage für Stichproben an und bindet ihr Ergebnis an eine Variable, die in condition verwendet wird.

JSON-Darstellung 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
Felder
variableId

string

Die Variablen-ID, auf die in condition verwiesen werden soll.
sampleFilter

string

Der Filterstring, der für die Beispielabfrage verwendet wird.

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

string

Beschreibung dieser Beispielbindung. Wird von der Benutzeroberfläche verwendet, um nutzerfreundliche Beschreibungen für jede Anforderungsbedingung zu rendern.

Sollte weniger als 128 Zeichen lang sein.

MetricQueryResult

Messwertergebnis. Die Messwerte sind in der requirementCondition enthalten.

JSON-Darstellung 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
Felder
name

string

Dieser Name der Messwertabfrage wird Variablen in der requirementCondition zugeordnet.
value

object (TypedValue)

Wert der Messwertabfrage.
timestamp

string (Timestamp format)

Zeit, zu der dieser Messwert berechnet wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
unit

string

Die Einheit, in der dieser Messwert angegeben wird. Folgen

Unified Code for Units of Measure-Standard.
metricType

string

Typkennzeichnung des Messwerts, der diesem Abfrageergebnis entspricht.