Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::SearchCatalogRequest.
Request message for SearchCatalog.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#admin_search
def admin_search() -> ::Boolean
-
(::Boolean) — Optional. If set, use searchAll permission granted on organizations from
include_org_ids
and projects frominclude_project_ids
instead of the fine grained per resource permissions when filtering the search results. The only allowedorder_by
criteria for admin_search mode isdefault
. Using this flags guarantees a full recall of the search results.
#admin_search=
def admin_search=(value) -> ::Boolean
-
value (::Boolean) — Optional. If set, use searchAll permission granted on organizations from
include_org_ids
and projects frominclude_project_ids
instead of the fine grained per resource permissions when filtering the search results. The only allowedorder_by
criteria for admin_search mode isdefault
. Using this flags guarantees a full recall of the search results.
-
(::Boolean) — Optional. If set, use searchAll permission granted on organizations from
include_org_ids
and projects frominclude_project_ids
instead of the fine grained per resource permissions when filtering the search results. The only allowedorder_by
criteria for admin_search mode isdefault
. Using this flags guarantees a full recall of the search results.
#order_by
def order_by() -> ::String
-
(::String) — Specifies the order of results.
Currently supported case-sensitive values are:
relevance
that can only be descendinglast_modified_timestamp [asc|desc]
with descending (desc
) as defaultdefault
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
.
#order_by=
def order_by=(value) -> ::String
-
value (::String) — Specifies the order of results.
Currently supported case-sensitive values are:
relevance
that can only be descendinglast_modified_timestamp [asc|desc]
with descending (desc
) as defaultdefault
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
.
-
(::String) — Specifies the order of results.
Currently supported case-sensitive values are:
relevance
that can only be descendinglast_modified_timestamp [asc|desc]
with descending (desc
) as defaultdefault
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
.
#page_size
def page_size() -> ::Integer
-
(::Integer) — 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_size=
def page_size=(value) -> ::Integer
-
value (::Integer) — 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.
-
(::Integer) — 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
def page_token() -> ::String
-
(::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.
#page_token=
def page_token=(value) -> ::String
-
value (::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.
-
(::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.
#query
def query() -> ::String
-
(::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
#query=
def query=(value) -> ::String
-
value (::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
-
(::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
#scope
def scope() -> ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope
-
(::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope) — Required. The scope of this search request.
The
scope
is invalid ifinclude_org_ids
,include_project_ids
are empty ANDinclude_gcp_public_datasets
is set tofalse
. In this case, the request returns an error.
#scope=
def scope=(value) -> ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope
-
value (::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope) — Required. The scope of this search request.
The
scope
is invalid ifinclude_org_ids
,include_project_ids
are empty ANDinclude_gcp_public_datasets
is set tofalse
. In this case, the request returns an error.
-
(::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope) — Required. The scope of this search request.
The
scope
is invalid ifinclude_org_ids
,include_project_ids
are empty ANDinclude_gcp_public_datasets
is set tofalse
. In this case, the request returns an error.