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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1beta1/classes.rb,
lib/google/apis/datacatalog_v1beta1/representations.rb,
lib/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.



1112
1113
1114
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1112

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 * default that can only be descending If not specified, defaults to relevance descending. Corresponds to the JSON property orderBy

Returns:

  • (String) 


1080
1081
1082
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1080

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) 


1086
1087
1088
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1086

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) 


1094
1095
1096
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1094

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) 


1105
1106
1107
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1105

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:



1110
1111
1112
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1110

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1117
1118
1119
1120
1121
1122
1123
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1117

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