Discovery Engine v1 API - Class SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec (1.5.0)

Version 1.5.0

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public sealed class SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec : IMessage<SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec>, IEquatable<SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec>, IDeepCloneable<SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec.

A specification for configuring snippets in a search response.

Inheritance

object > SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec

Implements

IMessageSearchRequestTypesContentSearchSpecTypesSnippetSpec, IEquatableSearchRequestTypesContentSearchSpecTypesSnippetSpec, IDeepCloneableSearchRequestTypesContentSearchSpecTypesSnippetSpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

SnippetSpec()

public SnippetSpec()

SnippetSpec(SnippetSpec)

public SnippetSpec(SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec other)

Parameter
Name	Description
other	SearchRequestTypesContentSearchSpecTypesSnippetSpec

Properties

MaxSnippetCount

[Obsolete]
public int MaxSnippetCount { get; set; }

[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.

Property Value
Type	Description
int

ReferenceOnly

[Obsolete]
public bool ReferenceOnly { get; set; }

[DEPRECATED] This field is deprecated and will have no affect on the snippet.

Property Value
Type	Description
bool

ReturnSnippet

public bool ReturnSnippet { get; set; }

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.

Property Value
Type	Description
bool