Method: projects.locations.sampleQuerySets.sampleQueries.list

Recebe uma lista de SampleQuerys.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai do conjunto de consultas de amostra, como projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Se o autor da chamada não tiver permissão para listar SampleQuerys nesse conjunto de consultas de exemplo, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de SampleQuerys a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores acima de 1.000 serão convertidos para 1.000.

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.
pageToken

string

Um token de página ListSampleQueriesResponse.next_page_token recebido de uma chamada SampleQueryService.ListSampleQueries anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para SampleQueryService.ListSampleQueries precisam corresponder à chamada que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o método SampleQueryService.ListSampleQueries.

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

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

object (SampleQuery)

Os SampleQuerys.
nextPageToken

string

Um token que pode ser enviado como ListSampleQueriesRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

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.sampleQueries.list

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