The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, seeProjects.
↳ include_gcp_public_datasets
bool
Iftrue, include Google Cloud public datasets in search results. By default, they are excluded. SeeGoogle Cloud Public Datasetsfor more information.
↳ restricted_locations
array
Optional. The list of locations to search within. If empty, all locations are searched. Returns an error if any location in the list isn't one of theSupported regions. If a location is unreachable, its name is returned in theSearchCatalogResponse.unreachablefield. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.
↳ starred_only
bool
Optional. Iftrue, search only among starred entries. By default, all results are returned, starred or not.
↳ include_public_tag_templates
bool
Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.
Optional. The list of locations to search within. If empty, all locations
are searched.
Returns an error if any location in the list isn't one of theSupported
regions.
If a location is unreachable, its name is returned in theSearchCatalogResponse.unreachablefield. To get additional information
on the error, repeat the search request and set the location name as the
value of this parameter.
Optional. The list of locations to search within. If empty, all locations
are searched.
Returns an error if any location in the list isn't one of theSupported
regions.
If a location is unreachable, its name is returned in theSearchCatalogResponse.unreachablefield. To get additional information
on the error, repeat the search request and set the location name as the
value of this parameter.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getStarredOnly
Optional. Iftrue, search only among starred entries.
By default, all results are returned, starred or not.
Returns
Type
Description
bool
setStarredOnly
Optional. Iftrue, search only among starred entries.
By default, all results are returned, starred or not.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getIncludePublicTagTemplates
Optional. This field is deprecated. The search mechanism for public and
private tag templates is the same.
Returns
Type
Description
bool
setIncludePublicTagTemplates
Optional. This field is deprecated. The search mechanism for public and
private tag templates is the same.
[[["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-04 UTC."],[],[],null,["# Google Cloud Data Catalog V1 Client - Class Scope (2.3.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.2 (latest)](/php/docs/reference/cloud-data-catalog/latest/V1.SearchCatalogRequest.Scope)\n- [2.3.1](/php/docs/reference/cloud-data-catalog/2.3.1/V1.SearchCatalogRequest.Scope)\n- [2.2.4](/php/docs/reference/cloud-data-catalog/2.2.4/V1.SearchCatalogRequest.Scope)\n- [2.1.0](/php/docs/reference/cloud-data-catalog/2.1.0/V1.SearchCatalogRequest.Scope)\n- [2.0.2](/php/docs/reference/cloud-data-catalog/2.0.2/V1.SearchCatalogRequest.Scope)\n- [1.10.3](/php/docs/reference/cloud-data-catalog/1.10.3/V1.SearchCatalogRequest.Scope)\n- [1.9.1](/php/docs/reference/cloud-data-catalog/1.9.1/V1.SearchCatalogRequest.Scope)\n- [1.8.2](/php/docs/reference/cloud-data-catalog/1.8.2/V1.SearchCatalogRequest.Scope)\n- [1.7.1](/php/docs/reference/cloud-data-catalog/1.7.1/V1.SearchCatalogRequest.Scope)\n- [1.6.0](/php/docs/reference/cloud-data-catalog/1.6.0/V1.SearchCatalogRequest.Scope)\n- [1.5.1](/php/docs/reference/cloud-data-catalog/1.5.1/V1.SearchCatalogRequest.Scope)\n- [1.4.2](/php/docs/reference/cloud-data-catalog/1.4.2/V1.SearchCatalogRequest.Scope)\n- [1.3.9](/php/docs/reference/cloud-data-catalog/1.3.9/V1.SearchCatalogRequest.Scope) \nReference documentation and code samples for the Google Cloud Data Catalog V1 Client class Scope.\n\nThe criteria that select the subspace used for query matching.\n\nGenerated from protobuf message `google.cloud.datacatalog.v1.SearchCatalogRequest.Scope`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataCatalog \\\\ V1 \\\\ SearchCatalogRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIncludeOrgIds\n\nThe list of organization IDs to search within.\n\nTo find your organization ID, follow the steps from\n[Creating and managing organizations](/resource-manager/docs/creating-managing-organization).\n\n### setIncludeOrgIds\n\nThe list of organization IDs to search within.\n\nTo find your organization ID, follow the steps from\n[Creating and managing organizations](/resource-manager/docs/creating-managing-organization).\n\n### getIncludeProjectIds\n\nThe list of project IDs to search within.\n\nFor more information on the distinction between project names, IDs, and\nnumbers, see [Projects](/docs/overview#projects).\n\n### setIncludeProjectIds\n\nThe list of project IDs to search within.\n\nFor more information on the distinction between project names, IDs, and\nnumbers, see [Projects](/docs/overview#projects).\n\n### getIncludeGcpPublicDatasets\n\nIf `true`, include Google Cloud public datasets in\nsearch results. By default, they are excluded.\n\nSee [Google Cloud Public Datasets](/public-datasets) for more\ninformation.\n\n### setIncludeGcpPublicDatasets\n\nIf `true`, include Google Cloud public datasets in\nsearch results. By default, they are excluded.\n\nSee [Google Cloud Public Datasets](/public-datasets) for more\ninformation.\n\n### getRestrictedLocations\n\nOptional. The list of locations to search within. If empty, all locations\nare searched.\n\nReturns an error if any location in the list isn't one of the [Supported\nregions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).\nIf a location is unreachable, its name is returned in the\n`SearchCatalogResponse.unreachable` field. To get additional information\non the error, repeat the search request and set the location name as the\nvalue of this parameter.\n\n### setRestrictedLocations\n\nOptional. The list of locations to search within. If empty, all locations\nare searched.\n\nReturns an error if any location in the list isn't one of the [Supported\nregions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).\nIf a location is unreachable, its name is returned in the\n`SearchCatalogResponse.unreachable` field. To get additional information\non the error, repeat the search request and set the location name as the\nvalue of this parameter.\n\n### getStarredOnly\n\nOptional. If `true`, search only among starred entries.\n\nBy default, all results are returned, starred or not.\n\n### setStarredOnly\n\nOptional. If `true`, search only among starred entries.\n\nBy default, all results are returned, starred or not.\n\n### getIncludePublicTagTemplates\n\nOptional. This field is deprecated. The search mechanism for public and\nprivate tag templates is the same.\n\n### setIncludePublicTagTemplates\n\nOptional. This field is deprecated. The search mechanism for public and\nprivate tag templates is the same."]]
