Method: projects.locations.sampleQuerySets.sampleQueries.list

Gets a list of SampleQuerys.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent sample query set resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters
pageSize

integer

Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.
pageToken

string

A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Request body

The request body must be empty.

Response body

Response message for SampleQueryService.ListSampleQueries method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ],
  "nextPageToken": string
}
Fields
sampleQueries[]

object (SampleQuery)

The SampleQuerys.
nextPageToken

string

A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.sampleQueries.list

For more information, see the IAM documentation.