Method: projects.locations.sampleQuerySets.sampleQueries.list
Stay organized with collections
Save and categorize content based on your preferences.
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 the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This API endpoint retrieves a list of SampleQueries within a specified sample query set using a GET request."],["The `parent` path parameter is required, specifying the sample query set's resource name, and the user must have permission to list SampleQueries under this set."],["You can control the number of SampleQueries returned per page using the `pageSize` query parameter, with a default of 100 and a maximum of 1000, or use `pageToken` to paginate through results."],["The request body must be empty, and the successful response includes an array of `sampleQueries` objects and an optional `nextPageToken` for pagination."],["Access to this API requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope and the `discoveryengine.sampleQueries.list` IAM permission on the parent resource."]]],[]]
