Method: projects.locations.sampleQuerySets.sampleQueries.list

Obtiene una lista de SampleQuerys.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso del conjunto de muestras de consultas principal, como projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Si el llamador no tiene permiso para enumerar los SampleQuerys en este conjunto de consultas de ejemplo, independientemente de si existe o no este conjunto de consultas de ejemplo, se devuelve un error PERMISSION_DENIED.

Parámetros de consulta

Parámetros
pageSize

integer

Es la cantidad máxima de SampleQuerys que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000. Los valores superiores a 1,000 se limitarán automáticamente a 1,000.

Si este campo es negativo, se devuelve un error de INVALID_ARGUMENT.
pageToken

string

Es un token de página ListSampleQueriesResponse.next_page_token, recibido de una llamada SampleQueryService.ListSampleQueries anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a SampleQueryService.ListSampleQueries deben coincidir con la llamada que proporcionó el token de la página. De lo contrario, se devuelve un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para el método SampleQueryService.ListSampleQueries.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ],
  "nextPageToken": string
}
Campos
sampleQueries[]

object (SampleQuery)

Los SampleQuery.
nextPageToken

string

Es un token que se puede enviar como ListSampleQueriesRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.sampleQueries.list

Para obtener más información, consulta la documentación de IAM.