Interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder (0.31.0)

public static interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMaxSnippetCount() (deprecated)

public abstract int getMaxSnippetCount()

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

[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
TypeDescription
int

The maxSnippetCount.

getReferenceOnly() (deprecated)

public abstract boolean getReferenceOnly()

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

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

bool reference_only = 2 [deprecated = true];

Returns
TypeDescription
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
TypeDescription
boolean

The returnSnippet.