Method: projects.locations.sampleQuerySets.sampleQueries.list

Obtient la liste des SampleQuery.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource de l'ensemble d'exemples de requêtes parent, par exemple projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Si l'appelant n'est pas autorisé à lister les SampleQuery sous cet ensemble d'exemples de requêtes, qu'il existe ou non, une erreur PERMISSION_DENIED est renvoyée.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de SampleQuery à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. La valeur maximale autorisée est 1 000. Les valeurs supérieures à 1 000 seront forcées à 1 000.

Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée.
pageToken

string

Jeton de page ListSampleQueriesResponse.next_page_token reçu d'un appel SampleQueryService.ListSampleQueries précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à SampleQueryService.ListSampleQueries doivent correspondre à l'appel ayant fourni le jeton de page. Sinon, une erreur INVALID_ARGUMENT est renvoyée.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la méthode SampleQueryService.ListSampleQueries.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ],
  "nextPageToken": string
}
Champs
sampleQueries[]

object (SampleQuery)

Les SampleQuery.
nextPageToken

string

Jeton qui peut être envoyé en tant que ListSampleQueriesRequest.page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.sampleQueries.list

Pour en savoir plus, consultez la documentation IAM.