Method: projects.locations.sampleQuerySets.list

Obtém uma lista de SampleQuerySets.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso de localização principal, como projects/{project}/locations/{location}.

Se o autor da chamada não tiver autorização para listar SampleQuerySets nesta localização, independentemente de esta localização existir ou não, é devolvido um erro PERMISSION_DENIED.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de SampleQuerySets 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 ListSampleQuerySetsResponse.next_page_token, recebido de uma chamada SampleQuerySetService.ListSampleQuerySets anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a SampleQuerySetService.ListSampleQuerySets 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 SampleQuerySetService.ListSampleQuerySets.

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

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

object (SampleQuerySet)

Os anos SampleQuerySet.

nextPageToken

string

Um token que pode ser enviado como ListSampleQuerySetsRequest.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.sampleQuerySets.list

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