Class: Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1SearchCatalogRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1/classes.rb,
lib/google/apis/datacatalog_v1/representations.rb,
lib/google/apis/datacatalog_v1/representations.rb

Overview

Request message for SearchCatalog.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1SearchCatalogRequest

Returns a new instance of GoogleCloudDatacatalogV1SearchCatalogRequest.



1860
1861
1862
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1860

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#order_by ⇒ String

Specifies the order of results. Currently supported case-sensitive values are:

  • relevance that can only be descending * last_modified_timestamp [asc|desc] with descending (desc) as default * default that can only be descending If this parameter is omitted, it defaults to the descending relevance. Corresponds to the JSON property orderBy

Returns:

  • (String) 


1828
1829
1830
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1828

def order_by
  @order_by
end

#page_size ⇒ Fixnum

Number of results to return in a single search page. Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1835
1836
1837
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1835

def page_size
  @page_size
end

#page_token ⇒ 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. Corresponds to the JSON property pageToken

Returns:

  • (String) 


1843
1844
1845
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1843

def page_token
  @page_token
end

#query ⇒ 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 Corresponds to the JSON property query

Returns:

  • (String) 


1853
1854
1855
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1853

def query
  @query
end

#scope ⇒ Google::Apis::DatacatalogV1::GoogleCloudDatacatalogV1SearchCatalogRequestScope

The criteria that select the subspace used for query matching. Corresponds to the JSON property scope

Returns:



1858
1859
1860
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1858

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 1865

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