Required. The scope of this search request. The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.
↳ query
string
Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple xyz or qualified by predicates: * * name:x * * column:y * * description:z
↳ page_size
int
Upper bound on the number of results you can get in a single response. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.
↳ page_token
string
Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page. This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.
↳ order_by
string
Specifies the order of results. Currently supported case-sensitive values are: * * relevance that can only be descending * * last_modified_timestamp [asc|desc] with descending (desc) as default * * default that can only be descending Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to default. If this parameter is omitted, it defaults to the descending relevance.
↳ admin_search
bool
Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results.
getScope
Required. The scope of this search request.
The scope is invalid if include_org_ids, include_project_ids are
empty AND include_gcp_public_datasets is set to false. In this case,
the request returns an error.
The scope is invalid if include_org_ids, include_project_ids are
empty AND include_gcp_public_datasets is set to false. In this case,
the request returns an error.
Optional. The query string with a minimum of 3 characters and specific
syntax. For more information, see Data Catalog search
syntax.
An empty query string returns all data assets (in the specified scope)
that you have access to.
A query string can be a simple xyz or qualified by predicates:
name:x
column:y
description:z
Returns
Type
Description
string
setQuery
Optional. The query string with a minimum of 3 characters and specific
syntax. For more information, see Data Catalog search
syntax.
An empty query string returns all data assets (in the specified scope)
that you have access to.
A query string can be a simple xyz or qualified by predicates:
name:x
column:y
description:z
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Upper bound on the number of results you can get in a single response.
Can't be negative or 0, defaults to 10 in this case.
The maximum number is 1000. If exceeded, throws an "invalid argument"
exception.
Returns
Type
Description
int
setPageSize
Upper bound on the number of results you can get in a single response.
Can't be negative or 0, defaults to 10 in this case.
The maximum number is 1000. If exceeded, throws an "invalid argument"
exception.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. Pagination token that, if specified, returns the next page of
search results. If empty, returns the first page.
last_modified_timestamp [asc|desc] with descending (desc) as default
default that can only be descending
Search queries don't guarantee full recall. Results that match your query
might not be returned, even in subsequent result pages. Additionally,
returned (and not returned) results can vary if you repeat search queries.
If you are experiencing recall issues and you don't have to fetch the
results in any specific order, consider setting this parameter to
default.
If this parameter is omitted, it defaults to the descending relevance.
Returns
Type
Description
string
setOrderBy
Specifies the order of results.
Currently supported case-sensitive values are:
relevance that can only be descending
last_modified_timestamp [asc|desc] with descending (desc) as default
default that can only be descending
Search queries don't guarantee full recall. Results that match your query
might not be returned, even in subsequent result pages. Additionally,
returned (and not returned) results can vary if you repeat search queries.
If you are experiencing recall issues and you don't have to fetch the
results in any specific order, consider setting this parameter to
default.
If this parameter is omitted, it defaults to the descending relevance.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAdminSearch
Optional. If set, use searchAll permission granted on organizations from
include_org_ids and projects from include_project_ids instead of the
fine grained per resource permissions when filtering the search results.
The only allowed order_by criteria for admin_search mode is default.
Using this flags guarantees a full recall of the search results.
Returns
Type
Description
bool
setAdminSearch
Optional. If set, use searchAll permission granted on organizations from
include_org_ids and projects from include_project_ids instead of the
fine grained per resource permissions when filtering the search results.
The only allowed order_by criteria for admin_search mode is default.
Using this flags guarantees a full recall of the search results.
The scope is invalid if include_org_ids, include_project_ids are
empty AND include_gcp_public_datasets is set to false. In this case,
the request returns an error.
query
string
Optional. The query string with a minimum of 3 characters and specific
syntax. For more information, see Data Catalog search
syntax.
An empty query string returns all data assets (in the specified scope)
that you have access to.
A query string can be a simple xyz or qualified by predicates:
[[["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-09-09 UTC."],[],[],null,["# Google Cloud Data Catalog V1 Client - Class SearchCatalogRequest (2.3.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.2 (latest)](/php/docs/reference/cloud-data-catalog/latest/V1.SearchCatalogRequest)\n- [2.3.1](/php/docs/reference/cloud-data-catalog/2.3.1/V1.SearchCatalogRequest)\n- [2.2.4](/php/docs/reference/cloud-data-catalog/2.2.4/V1.SearchCatalogRequest)\n- [2.1.0](/php/docs/reference/cloud-data-catalog/2.1.0/V1.SearchCatalogRequest)\n- [2.0.2](/php/docs/reference/cloud-data-catalog/2.0.2/V1.SearchCatalogRequest)\n- [1.10.3](/php/docs/reference/cloud-data-catalog/1.10.3/V1.SearchCatalogRequest)\n- [1.9.1](/php/docs/reference/cloud-data-catalog/1.9.1/V1.SearchCatalogRequest)\n- [1.8.2](/php/docs/reference/cloud-data-catalog/1.8.2/V1.SearchCatalogRequest)\n- [1.7.1](/php/docs/reference/cloud-data-catalog/1.7.1/V1.SearchCatalogRequest)\n- [1.6.0](/php/docs/reference/cloud-data-catalog/1.6.0/V1.SearchCatalogRequest)\n- [1.5.1](/php/docs/reference/cloud-data-catalog/1.5.1/V1.SearchCatalogRequest)\n- [1.4.2](/php/docs/reference/cloud-data-catalog/1.4.2/V1.SearchCatalogRequest)\n- [1.3.9](/php/docs/reference/cloud-data-catalog/1.3.9/V1.SearchCatalogRequest) \nReference documentation and code samples for the Google Cloud Data Catalog V1 Client class SearchCatalogRequest.\n\nRequest message for\nSearchCatalog.\n\nGenerated from protobuf message `google.cloud.datacatalog.v1.SearchCatalogRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataCatalog \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getScope\n\nRequired. The scope of this search request.\n\nThe `scope` is invalid if `include_org_ids`, `include_project_ids` are\nempty AND `include_gcp_public_datasets` is set to `false`. In this case,\nthe request returns an error.\n\n### hasScope\n\n### clearScope\n\n### setScope\n\nRequired. The scope of this search request.\n\nThe `scope` is invalid if `include_org_ids`, `include_project_ids` are\nempty AND `include_gcp_public_datasets` is set to `false`. In this case,\nthe request returns an error.\n\n### getQuery\n\nOptional. The query string with a minimum of 3 characters and specific\nsyntax. For more information, see [Data Catalog search\nsyntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).\n\nAn empty query string returns all data assets (in the specified scope)\nthat you have access to.\nA query string can be a simple `xyz` or qualified by predicates:\n\n- `name:x`\n- `column:y`\n- `description:z`\n\n### setQuery\n\nOptional. The query string with a minimum of 3 characters and specific\nsyntax. For more information, see [Data Catalog search\nsyntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).\n\nAn empty query string returns all data assets (in the specified scope)\nthat you have access to.\nA query string can be a simple `xyz` or qualified by predicates:\n\n- `name:x`\n- `column:y`\n- `description:z`\n\n### getPageSize\n\nUpper bound on the number of results you can get in a single response.\n\nCan't be negative or 0, defaults to 10 in this case.\nThe maximum number is 1000. If exceeded, throws an \"invalid argument\"\nexception.\n\n### setPageSize\n\nUpper bound on the number of results you can get in a single response.\n\nCan't be negative or 0, defaults to 10 in this case.\nThe maximum number is 1000. If exceeded, throws an \"invalid argument\"\nexception.\n\n### getPageToken\n\nOptional. Pagination token that, if specified, returns the next page of\nsearch results. If empty, returns the first page.\n\nThis token is returned in the\n[SearchCatalogResponse.next_page_token](/php/docs/reference/cloud-data-catalog/latest/V1.SearchCatalogResponse#_Google_Cloud_DataCatalog_V1_SearchCatalogResponse__getNextPageToken__)\nfield of the response to a previous\nSearchCatalogRequest\ncall.\n\n### setPageToken\n\nOptional. Pagination token that, if specified, returns the next page of\nsearch results. If empty, returns the first page.\n\nThis token is returned in the\n[SearchCatalogResponse.next_page_token](/php/docs/reference/cloud-data-catalog/latest/V1.SearchCatalogResponse#_Google_Cloud_DataCatalog_V1_SearchCatalogResponse__getNextPageToken__)\nfield of the response to a previous\nSearchCatalogRequest\ncall.\n\n### getOrderBy\n\nSpecifies the order of results.\n\nCurrently supported case-sensitive values are:\n\n- `relevance` that can only be descending\n- `last_modified_timestamp [asc|desc]` with descending (`desc`) as default\n- `default` that can only be descending Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to `default`. If this parameter is omitted, it defaults to the descending `relevance`.\n\n### setOrderBy\n\nSpecifies the order of results.\n\nCurrently supported case-sensitive values are:\n\n- `relevance` that can only be descending\n- `last_modified_timestamp [asc|desc]` with descending (`desc`) as default\n- `default` that can only be descending Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to `default`. If this parameter is omitted, it defaults to the descending `relevance`.\n\n### getAdminSearch\n\nOptional. If set, use searchAll permission granted on organizations from\n`include_org_ids` and projects from `include_project_ids` instead of the\nfine grained per resource permissions when filtering the search results.\n\nThe only allowed `order_by` criteria for admin_search mode is `default`.\nUsing this flags guarantees a full recall of the search results.\n\n### setAdminSearch\n\nOptional. If set, use searchAll permission granted on organizations from\n`include_org_ids` and projects from `include_project_ids` instead of the\nfine grained per resource permissions when filtering the search results.\n\nThe only allowed `order_by` criteria for admin_search mode is `default`.\nUsing this flags guarantees a full recall of the search results.\n\n### static::build"]]
