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.



2314
2315
2316
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2314

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

Instance Attribute Details

#admin_search ⇒ Boolean Also known as: admin_search?

Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results. Corresponds to the JSON property adminSearch

Returns:

  • (Boolean) 


2268
2269
2270
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2268

def admin_search
  @admin_search
end

#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 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. Corresponds to the JSON property orderBy

Returns:

  • (String) 


2282
2283
2284
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2282

def order_by
  @order_by
end

#page_size ⇒ Fixnum

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. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


2289
2290
2291
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2289

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) 


2297
2298
2299
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2297

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) 


2307
2308
2309
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2307

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:



2312
2313
2314
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2312

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2319
2320
2321
2322
2323
2324
2325
2326
 
# File 'lib/google/apis/datacatalog_v1/classes.rb', line 2319

def update!(**args)
  @admin_search = args[:admin_search] if args.key?(:admin_search)
  @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