Method: projects.locations.sampleQuerySets.sampleQueries.list

Obtiene una lista de SampleQuerys.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso del conjunto de consultas de ejemplo superior, como projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Si la persona que llama no tiene permiso para enumerar SampleQuerys en este conjunto de consultas de ejemplo, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Los parámetros de consulta

Parámetros
pageSize

integer

Número máximo de SampleQuerys que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1000. Los valores superiores a 1000 se convertirán a 1000.

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

string

Un token de página ListSampleQueriesResponse.next_page_token, recibido de una llamada SampleQueryService.ListSampleQueries anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a SampleQueryService.ListSampleQueries deben ser los mismos que aparecen en 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 del método SampleQueryService.ListSampleQueries.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (SampleQuery)

Los SampleQuery.
nextPageToken

string

Token que se puede enviar como ListSampleQueriesRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.sampleQueries.list

Para obtener más información, consulta la documentación de gestión de identidades y accesos.