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



2234
2235
2236
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2234

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) 


2194
2195
2196
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2194

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:



2199
2200
2201
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2199

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:



2204
2205
2206
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2204

def fields
  @fields
end

#mime_type ⇒ String

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

Returns:

  • (String) 


2209
2210
2211
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2209

def mime_type
  @mime_type
end

#object_type ⇒ String

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

Returns:

  • (String) 


2214
2215
2216
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2214

def object_type
  @object_type
end

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

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

Returns:



2219
2220
2221
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2219

def owner
  @owner
end

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

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

Returns:



2224
2225
2226
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2224

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) 


2232
2233
2234
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2232

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2239

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