Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

A specification for configuring snippets in a search response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec.



13335
13336
13337
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 13335

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

Instance Attribute Details

#max_snippet_count ⇒ Fixnum

[DEPRECATED] This field is deprecated. To control snippet return, use return_snippet field. For backwards compatibility, we will return snippet if max_snippet_count > 0. Corresponds to the JSON property maxSnippetCount

Returns:

  • (Fixnum) 


13319
13320
13321
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 13319

def max_snippet_count
  @max_snippet_count
end

#reference_only ⇒ Boolean Also known as: reference_only?

[DEPRECATED] This field is deprecated and will have no affect on the snippet. Corresponds to the JSON property referenceOnly

Returns:

  • (Boolean) 


13324
13325
13326
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 13324

def reference_only
  @reference_only
end

#return_snippet ⇒ Boolean Also known as: return_snippet?

If true, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A snippet_status with SUCCESS or NO_SNIPPET_AVAILABLE will also be returned. Corresponds to the JSON property returnSnippet

Returns:

  • (Boolean) 


13332
13333
13334
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 13332

def return_snippet
  @return_snippet
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13340
13341
13342
13343
13344
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 13340

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