Class: Google::Apis::CloudsearchV1::AppsDynamiteSharedMessageSearchInfo

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 used to describe how to render a message in search results page, e.g., highlighting and snipetting. In future, we can use this proto to return more search specific data attached to a message.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AppsDynamiteSharedMessageSearchInfo

Returns a new instance of AppsDynamiteSharedMessageSearchInfo.



2028
2029
2030
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2028

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

Instance Attribute Details

#matched_segments_in_text_body ⇒ Array<Google::Apis::CloudsearchV1::AppsDynamiteSharedTextSegmentsWithDescription>

Current usage: - DescriptionType=KEYWORD_MATCH is populated in this field to return metadata for keyword matches, which clients can use to highlight matched segments in a message's text_body. - DescriptionType=SNIPPET can be used to return metadata describing how a message's text_body can be broken up to provide a snippet. Corresponds to the JSON property matchedSegmentsInTextBody

Returns:



2026
2027
2028
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2026

def matched_segments_in_text_body
  @matched_segments_in_text_body
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2033
2034
2035
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2033

def update!(**args)
  @matched_segments_in_text_body = args[:matched_segments_in_text_body] if args.key?(:matched_segments_in_text_body)
end