Method: projects.locations.requirements.checkRequirement

Verifique um requisito específico.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
location

string

Obrigatório. Nome completo do recurso do local. Formatar projects/{project_number_or_id}/locations/{location}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
Campos
requirementType

string

O tipo que especifica o requisito a ser verificado. Os tipos compatíveis são:

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

Os recursos a serem verificados para este requisito. O tipo necessário para os recursos monitorados:

  • discoveryengine.googleapis.com/Branch.

    • Os rótulos necessários para este recurso:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • Os rótulos necessários para este recurso:
      • project_number
      • location_id
      • collection_id
      • datastore_id

Corpo da resposta

Resposta para o método "requirements.checkRequirement".

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
Campos
requirement

object (Requirement)

Definição de requisito.
requirementCondition

object (Expr)

A condição para avaliar o resultado do requisito.
metricResults[]

object (MetricQueryResult)

Resultados de métricas.
oldestMetricTimestamp

string (Timestamp format)

Carimbo de data/hora da métrica calculada mais antiga (ou seja, a métrica mais desatualizada). Indica que o result pode não refletir com precisão as atualizações de eventos e catálogo de produtos realizadas depois desse horário.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
result

string

O resultado do requisito. Precisa ser um dos campos severity na definição do requisito. Se ocorrer algum erro durante a avaliação, ele será UNKNOWN.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Requisito

Um requisito de dados.

Representação JSON 
{
  "type": string,
  "displayName": string,
  "description": string,
  "condition": {
    object (Expr)
  },
  "metricBindings": [
    {
      object (MetricBinding)
    }
  ],
  "thresholdBindings": [
    {
      object (ThresholdBinding)
    }
  ],
  "violationSamplesBindings": [
    {
      object (ViolationSamplesBinding)
    }
  ],
  "severity": [
    string
  ]
}
Campos
type

string

O tipo de requisito, usado como um identificador. Precisa ser exclusivo.

O tipo precisa ter o prefixo do nome do serviço para evitar possíveis conflitos. É recomendável usar o agrupamento hierárquico natural para requisitos semelhantes.

Exemplos:

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

string

O nome do requisito.
description

string

A descrição do requisito.
condition

object (Expr)

A condição para avaliar o resultado do requisito.

As variáveis na expressão precisam ser fornecidas por metrics_bindings ou thresholdBindings. Em que metrics_bindings são usados para métricas calculadas e thresholdBindings são usados para definir limites para metricBindings correspondentes.
metricBindings[]

object (MetricBinding)

Uma lista das vinculações de métricas a serem usadas em condition.
thresholdBindings[]

object (ThresholdBinding)

Uma lista de vinculações de limite a serem usadas em condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Uma lista das vinculações de métricas a serem usadas em condition.
severity[]

string

A gravidade dos erros se o requisito não for atendido. Ela precisa ser ordenada da mais estrita para a menos estrita. Exemplos:

  • BLOCKING
  • CRITICAL
  • WARNING

Todos os limites no requisito precisam ter toda a gravidade aqui.

MetricBinding

Especifica uma consulta de métricas e vincula o resultado dela a uma variável que será usada no condition.

Representação JSON 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
Campos
variableId

string

O ID da variável a ser referenciada em condition.
resourceType

string

O recurso monitorado para a métrica.
metricFilter

string

A string de filtro usada para consulta de métricas.

Exemplo:

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

string

Descrição legível do filtro de métricas correspondente.
category

string

A categoria do recurso de destino da métrica. Exemplo: "Eventos"

ThresholdBinding

Especifica um limite multinível a ser aplicado a um metricBindings na expressão CEL condition.

Representação JSON 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
Campos
variableId

string

O ID da variável a ser referenciada em condition. Precisa ser único em todos os metricBindings e thresholdBindings.
description

string

Descrição legível do limite e do subrequisito correspondentes.
thresholdValues[]

object (ThresholdValue)

Os valores do limite. Os valores precisam ser ordenados do mais estrito para o menos estrito.

ThresholdValue

Especifica um valor de limite para uma determinada gravidade.

Representação JSON 
{
  "severity": string,
  "value": number
}
Campos
severity

string

A gravidade dos erros se o limite não for atendido. Precisa ser um dos campos severity no requisito.
value

number

O valor do limite.

ViolationSamplesBinding

Especifica uma consulta de amostras e vincula o resultado dela a uma variável que será usada no condition.

Representação JSON 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
Campos
variableId

string

O ID da variável a ser referenciada em condition.
sampleFilter

string

A string de filtro usada para a consulta de amostras.

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

string

Descrição desta vinculação de amostra. Usado pela UI para renderizar descrições fáceis de usar para cada condição de requisito.

Precisa ter menos de 128 caracteres.

MetricQueryResult

Resultado da métrica. A métrica está em "requirementCondition".

Representação JSON 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
Campos
name

string

Esse nome de consulta de métrica está sendo mapeado para variáveis em requirementCondition.
value

object (TypedValue)

Valor da consulta de métrica.
timestamp

string (Timestamp format)

Hora em que esse valor de métrica foi calculado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
unit

string

A unidade em que essa métrica é informada. Seguidores

O padrão Unified Code for Units of Measure (em inglês).
metricType

string

Identificador de tipo da métrica correspondente a este resultado da consulta.