Method: projects.locations.sampleQuerySets.sampleQueries.list

Obtém uma lista de SampleQuerys.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

Se o autor da chamada não tiver autorização para listar SampleQuerys neste conjunto de consultas de exemplo, independentemente de este conjunto de consultas de exemplo existir ou não, é devolvido um erro PERMISSION_DENIED.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de SampleQuerys a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Os valores acima de 1000 são forçados a 1000.

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.
pageToken

string

Um token de página ListSampleQueriesResponse.next_page_token, recebido de uma chamada SampleQueryService.ListSampleQueries anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a SampleQueryService.ListSampleQueries têm de corresponder à chamada que forneceu o token da página. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

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

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

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

object (SampleQuery)

Os anos SampleQuery.
nextPageToken

string

Um token que pode ser enviado como ListSampleQueriesRequest.page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

Â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.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.sampleQueries.list

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