value (::Boolean) — Optional. This field is deprecated. The search mechanism for public and
private tag templates is the same.
Returns
(::Boolean) — Optional. This field is deprecated. The search mechanism for public and
private tag templates is the same.
#restricted_locations
defrestricted_locations()->::Array<::String>
Returns
(::Array<::String>) — 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 the Supported
regions.
If a location is unreachable, its name is returned in the
SearchCatalogResponse.unreachable field. To get additional information
on the error, repeat the search request and set the location name as the
value of this parameter.
value (::Array<::String>) — 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 the Supported
regions.
If a location is unreachable, its name is returned in the
SearchCatalogResponse.unreachable field. To get additional information
on the error, repeat the search request and set the location name as the
value of this parameter.
Returns
(::Array<::String>) — 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 the Supported
regions.
If a location is unreachable, its name is returned in the
SearchCatalogResponse.unreachable field. To get additional information
on the error, repeat the search request and set the location name as the
value of this parameter.
#starred_only
defstarred_only()->::Boolean
Returns
(::Boolean) — Optional. If true, search only among starred entries.
By default, all results are returned, starred or not.
#starred_only=
defstarred_only=(value)->::Boolean
Parameter
value (::Boolean) — Optional. If true, search only among starred entries.
By default, all results are returned, starred or not.
Returns
(::Boolean) — Optional. If true, search only among starred entries.
By default, all results are returned, starred or not.
[[["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,["# Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope (v2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/ruby/docs/reference/google-cloud-data_catalog-v1/latest/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [2.3.0](/ruby/docs/reference/google-cloud-data_catalog-v1/2.3.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [2.2.2](/ruby/docs/reference/google-cloud-data_catalog-v1/2.2.2/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [2.1.1](/ruby/docs/reference/google-cloud-data_catalog-v1/2.1.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [2.0.0](/ruby/docs/reference/google-cloud-data_catalog-v1/2.0.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [1.4.0](/ruby/docs/reference/google-cloud-data_catalog-v1/1.4.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [1.3.1](/ruby/docs/reference/google-cloud-data_catalog-v1/1.3.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [1.2.0](/ruby/docs/reference/google-cloud-data_catalog-v1/1.2.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [1.1.0](/ruby/docs/reference/google-cloud-data_catalog-v1/1.1.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [1.0.1](/ruby/docs/reference/google-cloud-data_catalog-v1/1.0.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.23.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.23.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.22.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.22.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.21.2](/ruby/docs/reference/google-cloud-data_catalog-v1/0.21.2/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.20.1](/ruby/docs/reference/google-cloud-data_catalog-v1/0.20.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.19.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.19.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.18.1](/ruby/docs/reference/google-cloud-data_catalog-v1/0.18.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.17.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.17.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.16.1](/ruby/docs/reference/google-cloud-data_catalog-v1/0.16.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.15.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.15.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.14.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.14.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.13.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.13.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.12.1](/ruby/docs/reference/google-cloud-data_catalog-v1/0.12.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.11.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.11.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.10.0](/ruby/docs/reference/google-cloud-data_catalog-v1/0.10.0/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope)\n- [0.9.1](/ruby/docs/reference/google-cloud-data_catalog-v1/0.9.1/Google-Cloud-DataCatalog-V1-SearchCatalogRequest-Scope) \nReference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope.\n\nThe criteria that select the subspace used for query matching. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #include_gcp_public_datasets\n\n def include_gcp_public_datasets() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If `true`, include Google Cloud public datasets in search results. By default, they are excluded.\n\n\n See [Google Cloud Public Datasets](/public-datasets) for more\n information.\n\n### #include_gcp_public_datasets=\n\n def include_gcp_public_datasets=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If `true`, include Google Cloud public datasets in search results. By default, they are excluded.\n\n\n See [Google Cloud Public Datasets](/public-datasets) for more\ninformation. \n**Returns**\n\n- (::Boolean) --- If `true`, include Google Cloud public datasets in search results. By default, they are excluded.\n\n\n See [Google Cloud Public Datasets](/public-datasets) for more\n information.\n\n### #include_org_ids\n\n def include_org_ids() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- The list of organization IDs to search within.\n\n To find your organization ID, follow the steps from\n [Creating and managing organizations](/resource-manager/docs/creating-managing-organization).\n\n### #include_org_ids=\n\n def include_org_ids=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- The list of organization IDs to search within.\n\n\n To find your organization ID, follow the steps from\n[Creating and managing organizations](/resource-manager/docs/creating-managing-organization). \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- The list of organization IDs to search within.\n\n To find your organization ID, follow the steps from\n [Creating and managing organizations](/resource-manager/docs/creating-managing-organization).\n\n### #include_project_ids\n\n def include_project_ids() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- The list of project IDs to search within.\n\n For more information on the distinction between project names, IDs, and\n numbers, see [Projects](/docs/overview#projects).\n\n### #include_project_ids=\n\n def include_project_ids=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- The list of project IDs to search within.\n\n\n For more information on the distinction between project names, IDs, and\nnumbers, see [Projects](/docs/overview#projects). \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- The list of project IDs to search within.\n\n For more information on the distinction between project names, IDs, and\n numbers, see [Projects](/docs/overview#projects).\n\n### #include_public_tag_templates\n\n def include_public_tag_templates() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.\n\n### #include_public_tag_templates=\n\n def include_public_tag_templates=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. This field is deprecated. The search mechanism for public and private tag templates is the same. \n**Returns**\n\n- (::Boolean) --- Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.\n\n### #restricted_locations\n\n def restricted_locations() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. The list of locations to search within. If empty, all locations are searched.\n\n Returns an error if any location in the list isn't one of the [Supported\n regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).\n\n If a location is unreachable, its name is returned in the\n `SearchCatalogResponse.unreachable` field. To get additional information\n on the error, repeat the search request and set the location name as the\n value of this parameter.\n\n### #restricted_locations=\n\n def restricted_locations=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. The list of locations to search within. If empty, all locations are searched.\n\n\n Returns an error if any location in the list isn't one of the [Supported\n regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).\n\n If a location is unreachable, its name is returned in the\n `SearchCatalogResponse.unreachable` field. To get additional information\n on the error, repeat the search request and set the location name as the\nvalue of this parameter. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. The list of locations to search within. If empty, all locations are searched.\n\n Returns an error if any location in the list isn't one of the [Supported\n regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).\n\n If a location is unreachable, its name is returned in the\n `SearchCatalogResponse.unreachable` field. To get additional information\n on the error, repeat the search request and set the location name as the\n value of this parameter.\n\n### #starred_only\n\n def starred_only() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. If `true`, search only among starred entries.\n\n\n By default, all results are returned, starred or not.\n\n### #starred_only=\n\n def starred_only=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If `true`, search only among starred entries.\n\n\nBy default, all results are returned, starred or not. \n**Returns**\n\n- (::Boolean) --- Optional. If `true`, search only among starred entries.\n\n\n By default, all results are returned, starred or not."]]
