SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder (Google Discovery Engine API Parent 0.20.0 API)

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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`getMaxSnippetCount()`	Deprecated. google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated.
`boolean`	`getReferenceOnly()`	Deprecated. google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated.
`boolean`	`getReturnSnippet()`	If `true`, then return snippet.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

- Method Detail
  - getMaxSnippetCount
```
@Deprecated
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:
    
    The maxSnippetCount.
  - getReferenceOnly
```
@Deprecated
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:
    
    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.