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.
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.
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][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
field of the response to a previous
[SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
call.
public SearchCatalogRequest.Types.Scope Scope { get; set; }
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe webpage provides reference documentation for the \u003ccode\u003eSearchCatalogRequest\u003c/code\u003e class within the Google Cloud Data Catalog v1 API for .NET.\u003c/p\u003e\n"],["\u003cp\u003eThis class, \u003ccode\u003eSearchCatalogRequest\u003c/code\u003e, is used to construct request messages for searching the Data Catalog.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation lists available versions of the \u003ccode\u003eSearchCatalogRequest\u003c/code\u003e class, with the latest being version 2.14.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSearchCatalogRequest\u003c/code\u003e class includes properties like \u003ccode\u003eAdminSearch\u003c/code\u003e, \u003ccode\u003eOrderBy\u003c/code\u003e, \u003ccode\u003ePageSize\u003c/code\u003e, \u003ccode\u003ePageToken\u003c/code\u003e, \u003ccode\u003eQuery\u003c/code\u003e, and \u003ccode\u003eScope\u003c/code\u003e for customizing search requests, also having constructors for the purpose of creating \u003ccode\u003eSearchCatalogRequests\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation describes the implementation of the class, which inherits from object and implements several interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIPageRequest\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Data Catalog v1 API - Class SearchCatalogRequest (2.16.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.16.0 (latest)](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/latest/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.15.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.14.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.14.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.13.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.13.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.12.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.12.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.11.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.11.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.10.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.10.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.9.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.8.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.7.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.6.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.5.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.4.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.3.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.2.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.1.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/2.0.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/1.8.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/1.7.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/1.6.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/1.5.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/1.4.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/1.3.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/1.2.0/Google.Cloud.DataCatalog.V1.SearchCatalogRequest) \n\n public sealed class SearchCatalogRequest : IMessage\u003cSearchCatalogRequest\u003e, IEquatable\u003cSearchCatalogRequest\u003e, IDeepCloneable\u003cSearchCatalogRequest\u003e, IBufferMessage, IMessage, IPageRequest\n\nReference documentation and code samples for the Data Catalog v1 API class SearchCatalogRequest.\n\nRequest message for\n\\[SearchCatalog\\]\\[google.cloud.datacatalog.v1.DataCatalog.SearchCatalog\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e SearchCatalogRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[SearchCatalogRequest](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/latest/Google.Cloud.DataCatalog.V1.SearchCatalogRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SearchCatalogRequest](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/latest/Google.Cloud.DataCatalog.V1.SearchCatalogRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[SearchCatalogRequest](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/latest/Google.Cloud.DataCatalog.V1.SearchCatalogRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DataCatalog.V1](/dotnet/docs/reference/Google.Cloud.DataCatalog.V1/latest/Google.Cloud.DataCatalog.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DataCatalog.V1.dll\n\nConstructors\n------------\n\n### SearchCatalogRequest()\n\n public SearchCatalogRequest()\n\n### SearchCatalogRequest(SearchCatalogRequest)\n\n public SearchCatalogRequest(SearchCatalogRequest other)\n\nProperties\n----------\n\n### AdminSearch\n\n public bool AdminSearch { get; set; }\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.\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### OrderBy\n\n public string OrderBy { get; set; }\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\n\nSearch queries don't guarantee full recall. Results that match your query\nmight not be returned, even in subsequent result pages. Additionally,\nreturned (and not returned) results can vary if you repeat search queries.\nIf you are experiencing recall issues and you don't have to fetch the\nresults in any specific order, consider setting this parameter to\n`default`.\n\nIf this parameter is omitted, it defaults to the descending `relevance`.\n\n### PageSize\n\n public int PageSize { get; set; }\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### PageToken\n\n public string PageToken { get; set; }\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\\]\\[google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token\\]\nfield of the response to a previous\n\\[SearchCatalogRequest\\]\\[google.cloud.datacatalog.v1.DataCatalog.SearchCatalog\\]\ncall.\n\n### Query\n\n public string Query { get; set; }\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.\n\nA query string can be a simple `xyz` or qualified by predicates:\n\n- `name:x`\n- `column:y`\n- `description:z`\n\n### Scope\n\n public SearchCatalogRequest.Types.Scope Scope { get; set; }\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."]]
