Method: projects.locations.collections.engines.list

Lista todos os Engines associados ao projeto.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*}/engines

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai, como projects/{project}/locations/{location}/collections/{collectionId}.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Incompatível.
pageToken

string

Opcional. Incompatível.
filter

string

Opcional. Filtre por tipo de solução. Por exemplo: solutionType=SOLUTION_TYPE_SEARCH

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método EngineService.ListEngines.

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

Representação JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ],
  "nextPageToken": string
}
Campos
engines[]

object (Engine)

Todos os Engines do cliente.
nextPageToken

string

Incompatível.

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.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.engines.list

Para mais informações, consulte a documentação do IAM.