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.



2356
2357
2358
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2356

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)


2316
2317
2318
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2316

def create_time
  @create_time
end

#display_optionsGoogle::Apis::CloudsearchV1::ResultDisplayMetadata

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



2321
2322
2323
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2321

def display_options
  @display_options
end

#fieldsArray<Google::Apis::CloudsearchV1::NamedProperty>

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



2326
2327
2328
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2326

def fields
  @fields
end

#mime_typeString

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

Returns:

  • (String)


2331
2332
2333
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2331

def mime_type
  @mime_type
end

#object_typeString

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

Returns:

  • (String)


2336
2337
2338
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2336

def object_type
  @object_type
end

#ownerGoogle::Apis::CloudsearchV1::Person

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



2341
2342
2343
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2341

def owner
  @owner
end

#sourceGoogle::Apis::CloudsearchV1::Source

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



2346
2347
2348
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2346

def source
  @source
end

#update_timeString

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)


2354
2355
2356
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2354

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2361

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