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

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

Overview

Metadata of a matched search result.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Metadata

Returns a new instance of Metadata.



2532
2533
2534
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2532

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) 


2487
2488
2489
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2487

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:



2492
2493
2494
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2492

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:



2497
2498
2499
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2497

def fields
  @fields
end

#mime_type ⇒ String

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

Returns:

  • (String) 


2502
2503
2504
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2502

def mime_type
  @mime_type
end

#object_type ⇒ String

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

Returns:

  • (String) 


2507
2508
2509
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2507

def object_type
  @object_type
end

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

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

Returns:



2512
2513
2514
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2512

def owner
  @owner
end

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

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

Returns:



2517
2518
2519
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2517

def source
  @source
end

#thumbnail_url ⇒ String

The thumbnail URL of the result. Corresponds to the JSON property thumbnailUrl

Returns:

  • (String) 


2522
2523
2524
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2522

def thumbnail_url
  @thumbnail_url
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) 


2530
2531
2532
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2530

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2537

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)
  @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
  @update_time = args[:update_time] if args.key?(:update_time)
end