com.google.cloud.discoveryengine.v1beta

Interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest.ContentSearchSpec.SnippetSpec, SearchRequest.ContentSearchSpec.SnippetSpec.Builder

Enclosing class:

SearchRequest.ContentSearchSpec

public static interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getMaxSnippetCount() Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=304
boolean	getReferenceOnly() Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=308
boolean	getReturnSnippet() If `true`, then return snippet.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getMaxSnippetCount

@Deprecated
int getMaxSnippetCount()

Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1beta/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:

The maxSnippetCount.

getReferenceOnly

@Deprecated
boolean getReferenceOnly()

Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1beta/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:

The referenceOnly.

getReturnSnippet

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:

The returnSnippet.