Class: Google::Apis::CloudsearchV1::Metadata

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb

Overview

Metadata of a matched search result.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Metadata

Returns a new instance of Metadata



2450
2451
2452
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2450

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

Instance Attribute Details

#create_time ⇒ String

The creation time for this document or object in the search result. Corresponds to the JSON property createTime

Returns:

  • (String) 


2410
2411
2412
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2410

def create_time
  @create_time
end

#display_options ⇒ Google::Apis::CloudsearchV1::ResultDisplayMetadata

Options that specify how to display a structured data search result. Corresponds to the JSON property displayOptions

Returns:



2415
2416
2417
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2415

def display_options
  @display_options
end

#fields ⇒ Array<Google::Apis::CloudsearchV1::NamedProperty>

Indexed fields in structured data, returned as a generic named property. Corresponds to the JSON property fields

Returns:



2420
2421
2422
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2420

def fields
  @fields
end

#mime_type ⇒ String

Mime type of the search result. Corresponds to the JSON property mimeType

Returns:

  • (String) 


2425
2426
2427
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2425

def mime_type
  @mime_type
end

#object_type ⇒ String

Object type of the search result. Corresponds to the JSON property objectType

Returns:

  • (String) 


2430
2431
2432
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2430

def object_type
  @object_type
end

#owner ⇒ Google::Apis::CloudsearchV1::Person

Object to represent a person. Corresponds to the JSON property owner

Returns:



2435
2436
2437
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2435

def owner
  @owner
end

#source ⇒ Google::Apis::CloudsearchV1::Source

Defines sources for the suggest/search APIs. Corresponds to the JSON property source

Returns:



2440
2441
2442
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2440

def source
  @source
end

#update_time ⇒ String

The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When updateTime is used for calculating freshness and is not set, this value defaults to 2 years from the current time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2448
2449
2450
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2448

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2455

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_options = args[:display_options] if args.key?(:display_options)
  @fields = args[:fields] if args.key?(:fields)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @object_type = args[:object_type] if args.key?(:object_type)
  @owner = args[:owner] if args.key?(:owner)
  @source = args[:source] if args.key?(:source)
  @update_time = args[:update_time] if args.key?(:update_time)
end