Method: projects.locations.sampleQuerySets.sampleQueries.list

获取 SampleQuery 的列表。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父级示例查询集资源名称，例如 projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}。

如果调用者没有列出相应示例查询集下的 SampleQuery 的权限，无论该示例查询集是否存在，系统都会返回 PERMISSION_DENIED 错误。

查询参数

参数
pageSize

integer

要返回的 SampleQuery 数量上限。如果未指定，则默认为 100。允许的最大值为 1000。大于 1000 的值会强制转换为 1000。

如果此字段为负数，则返回 INVALID_ARGUMENT 错误。
pageToken

string

从之前的 SampleQueryService.ListSampleQueries 调用接收的页面令牌 ListSampleQueriesResponse.next_page_token。利用其进行后续页面检索。

进行分页时，提供给 SampleQueryService.ListSampleQueries 的所有其他参数必须与提供页面令牌的调用匹配。 否则，系统将返回 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

SampleQueryService.ListSampleQueries 方法的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ],
  "nextPageToken": string
}
字段
sampleQueries[]

object (SampleQuery)

SampleQuery。
nextPageToken

string

可作为 ListSampleQueriesRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

  • discoveryengine.sampleQueries.list

如需了解详情，请参阅 IAM 文档。