Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequest

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1SearchCatalogRequest

Returns a new instance of GoogleCloudDatacatalogV1beta1SearchCatalogRequest.



989
990
991
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 989

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 descending * last_modified_timestamp [asc| desc], defaults to descending if not specified If not specified, defaults to relevance descending. Corresponds to the JSON property orderBy

Returns:

  • (String) 


957
958
959
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 957

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

Returns:

  • (Fixnum) 


963
964
965
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 963

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

Returns:

  • (String) 


971
972
973
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 971

def page_token
  @page_token
end

#query ⇒ String

Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to. 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

Returns:

  • (String) 


982
983
984
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 982

def query
  @query
end

#scope ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope

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

Returns:



987
988
989
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 987

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



994
995
996
997
998
999
1000
 
# File 'generated/google/apis/datacatalog_v1beta1/classes.rb', line 994

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