Method: projects.locations.requirements.checkRequirement

Verificar um requisito específico.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
location

string

Obrigatório. Nome de recurso completo da localização. Formatar projects/{project_number_or_id}/locations/{location}

Corpo do pedido

O corpo do pedido 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 verificar. Os tipos suportados 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 verificar para este requisito. O tipo necessário para os recursos monitorizados:

  • discoveryengine.googleapis.com/Branch.

    • As etiquetas necessárias para este recurso:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • As etiquetas necessárias para este recurso:
      • project_number
      • location_id
      • collection_id
      • datastore_id

Corpo da resposta

Resposta para o método requirements.checkRequirement.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

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 das métricas.
oldestMetricTimestamp

string (Timestamp format)

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 do catálogo de produtos e eventos realizadas após este período.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. Deve ser um dos campos severity na definição do requisito. Se ocorrer algum erro durante a avaliação, o resultado é UNKNOWN.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o 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. Tem de ser único.

O tipo deve ter o prefixo do nome do serviço para evitar uma possível colisão. Recomendamos que use 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 devem ser fornecidas por metrics_bindings ou thresholdBindings. Onde 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 associações de métricas a usar em condition.
thresholdBindings[]

object (ThresholdBinding)

Uma lista de associações de limites a usar em condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

Uma lista das associações de métricas a usar em condition.
severity[]

string

A gravidade dos erros se o requisito não for cumprido. Tem de ser ordenado do mais rigoroso para o menos rigoroso. Exemplos:

  • BLOCKING
  • CRITICAL
  • WARNING

Todos os limites no requisito têm de ter toda a gravidade aqui.

MetricBinding

Especifica uma consulta de métricas e associa o respetivo resultado a uma variável que vai 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 referenciado em condition.
resourceType

string

O recurso que está a ser monitorizado para a métrica.
metricFilter

string

A string de filtro usada para a 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 aplicar 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 referenciado em condition. Tem de ser exclusivo em todos os metricBindings e thresholdBindings.
description

string

Descrição legível do limite e do sub-requisito correspondentes.
thresholdValues[]

object (ThresholdValue)

Os valores do limite. Os valores devem ser ordenados do mais rigoroso para o menos rigoroso.

ThresholdValue

Especifica um valor 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 atingido. Deve ser um dos campos severity no requisito.
value

number

O valor do limite.

ViolationSamplesBinding

Especifica uma consulta de exemplos e associa o respetivo resultado a uma variável que vai ser usada no condition.

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

string

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

string

A string de filtro usada para a consulta de exemplos.

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

string

Descrição desta associação de exemplo. Usado pela IU para renderizar descrições fáceis de usar para cada condição de requisito.

Deve ter menos de 128 carateres.

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

Este nome de consulta de métricas está a ser mapeado para variáveis na requirementCondition.
value

object (TypedValue)

Valor da consulta de métricas.
timestamp

string (Timestamp format)

Hora correspondente ao momento em que este valor da métrica foi calculado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 esta métrica é comunicada. Seguimentos

A norma do código unificado para unidades de medida.
metricType

string

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