REST Resource: projects.locations.dataStores.controls

Recurso: Control

Define um comportamento condicionado a ser usado durante a veiculação. Precisa estar anexado a um ServingConfig para ser considerado no momento da veiculação. Ações permitidas dependem de SolutionType.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
Campos
name

string

Imutável. Nome totalmente qualificado projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obrigatório. Nome legível. O identificador usado nas visualizações da UI.

Precisa ser uma string codificada em UTF-8. O limite de tamanho é de 128 caracteres. Caso contrário, um erro INVALID ARGUMENT será gerado.
associatedServingConfigIds[]

string

Apenas saída. Lista de todos os IDs ServingConfig a que esse controle está anexado. Pode levar até 10 minutos para atualizar após as mudanças.
solutionType

enum (SolutionType)

Obrigatório. Imutável. A qual solução o controle pertence.

Precisa ser compatível com a categoria do recurso. Caso contrário, um erro INVALID ARGUMENT será gerado.
useCases[]

enum (SearchUseCase)

Especifica o caso de uso do controle. Afeta quais campos de condição podem ser definidos. Válido apenas para SOLUTION_TYPE_SEARCH. No momento, só é permitido um caso de uso por controle. Precisa ser definido quando "solutionType" for SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Determina quando a ação associada será acionada.

Omita para sempre aplicar a ação. No momento, só é possível especificar uma condição. Caso contrário, um erro INVALID ARGUMENT será gerado.

Campo de união action. As ações são restritas por setor e solução

Obrigatório. action pode ser apenas de um dos tipos a seguir:
boostAction

object (BoostAction)

Define um controle do tipo boost.
filterAction

object (FilterAction)

Define um controle de tipo de filtro. No momento, não é compatível com a recomendação.
redirectAction

object (RedirectAction)

Define um controle do tipo redirecionamento.
synonymsAction

object (SynonymsAction)

Trata um grupo de termos como sinônimos.
promoteAction

object (PromoteAction)

Promover determinados links com base em consultas de acionamento predefinidas.

Métodos

create

 Cria um controle.

delete

 Exclui um controle.

get

 Recebe um Control.

list

 Lista todos os controles pelo recurso pai DataStore.

patch

 Atualiza um controle.