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.



2987
2988
2989
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2987

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) 


2942
2943
2944
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2942

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:



2947
2948
2949
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2947

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:



2952
2953
2954
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2952

def fields
  @fields
end

#mime_type ⇒ String

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

Returns:

  • (String) 


2957
2958
2959
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2957

def mime_type
  @mime_type
end

#object_type ⇒ String

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

Returns:

  • (String) 


2962
2963
2964
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2962

def object_type
  @object_type
end

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

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

Returns:



2967
2968
2969
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2967

def owner
  @owner
end

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

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

Returns:



2972
2973
2974
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2972

def source
  @source
end

#thumbnail_url ⇒ String

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

Returns:

  • (String) 


2977
2978
2979
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2977

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) 


2985
2986
2987
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2985

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2992

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