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.



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

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) 


2898
2899
2900
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2898

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:



2903
2904
2905
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2903

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:



2908
2909
2910
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2908

def fields
  @fields
end

#mime_type ⇒ String

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

Returns:

  • (String) 


2913
2914
2915
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2913

def mime_type
  @mime_type
end

#object_type ⇒ String

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

Returns:

  • (String) 


2918
2919
2920
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2918

def object_type
  @object_type
end

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

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

Returns:



2923
2924
2925
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2923

def owner
  @owner
end

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

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

Returns:



2928
2929
2930
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2928

def source
  @source
end

#thumbnail_url ⇒ String

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

Returns:

  • (String) 


2933
2934
2935
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2933

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) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2948

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