Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequest
- Inherits:
-
Object
- Object
- Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/datacatalog_v1beta1/classes.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb,
generated/google/apis/datacatalog_v1beta1/representations.rb
Overview
Request message for SearchCatalog.
Instance Attribute Summary collapse
-
#order_by ⇒ String
Specifies the ordering of results, currently supported case-sensitive choices are: *
relevance
, only supports descending *last_modified_timestamp [asc|desc]
, defaults to descending if not specified If not specified, defaults torelevance
descending. -
#page_size ⇒ Fixnum
Number of results in the search page.
-
#page_token ⇒ String
Optional.
-
#query ⇒ String
Required.
-
#scope ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1SearchCatalogRequest
constructor
A new instance of GoogleCloudDatacatalogV1beta1SearchCatalogRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1SearchCatalogRequest
Returns a new instance of GoogleCloudDatacatalogV1beta1SearchCatalogRequest.
1041 1042 1043 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1041 def initialize(**args) update!(**args) end |
Instance Attribute Details
#order_by ⇒ String
Specifies the ordering of results, currently supported case-sensitive choices are:
relevance
, only supports descendinglast_modified_timestamp [asc|desc]
, defaults to descending if not specified If not specified, defaults torelevance
descending. Corresponds to the JSON propertyorderBy
1006 1007 1008 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1006 def order_by @order_by end |
#page_size ⇒ Fixnum
Number of results in the search page. If <=0 then defaults to 10. Max limit
for page_size is 1000. Throws an invalid argument for page_size > 1000.
Corresponds to the JSON property pageSize
1012 1013 1014 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1012 def page_size @page_size end |
#page_token ⇒ String
Optional. Pagination token returned in an earlier
SearchCatalogResponse.next_page_token, which
indicates that this is a continuation of a prior
SearchCatalogRequest
call, and that the system should return the next page of data. If empty,
the first page is returned.
Corresponds to the JSON property pageToken
1022 1023 1024 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1022 def page_token @page_token end |
#query ⇒ String
Required. The query string in search query syntax. The query must be non-empty. Query strings can be simple as "x" or more qualified as:
- name:x
- column:x
- description:y
Note: Query tokens need to have a minimum of 3 characters for substring
matching to work correctly. See Data Catalog Search
Syntax for more information.
Corresponds to the JSON property
query
1034 1035 1036 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1034 def query @query end |
#scope ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope
Required. The scope of this search request.
Corresponds to the JSON property scope
1039 1040 1041 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1039 def scope @scope end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1046 1047 1048 1049 1050 1051 1052 |
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 1046 def update!(**args) @order_by = args[:order_by] if args.key?(:order_by) @page_size = args[:page_size] if args.key?(:page_size) @page_token = args[:page_token] if args.key?(:page_token) @query = args[:query] if args.key?(:query) @scope = args[:scope] if args.key?(:scope) end |