Interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder (0.28.0)

Version 0.28.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMaxSnippetCount() (deprecated)

public abstract int getMaxSnippetCount()

Deprecated. google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1/search_service.proto;l=304

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

int32 max_snippet_count = 1 [deprecated = true];

Returns
Type	Description
int	The maxSnippetCount.

getReferenceOnly() (deprecated)

public abstract boolean getReferenceOnly()

Deprecated. google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1/search_service.proto;l=308

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

bool reference_only = 2 [deprecated = true];

Returns
Type	Description
boolean	The referenceOnly.

getReturnSnippet()

public abstract boolean getReturnSnippet()

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.

bool return_snippet = 3;

Returns
Type	Description
boolean	The returnSnippet.