SearchRequest.ContentSearchSpec.SnippetSpec.Builder (proto-google-cloud-discoveryengine-v1alpha 0.45.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
    - - com.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.Builder

All Implemented Interfaces:

SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchRequest.ContentSearchSpec.SnippetSpec
```
public static final class SearchRequest.ContentSearchSpec.SnippetSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
implements SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
```
```
 A specification for configuring snippets in a search response.
 
```
Protobuf type google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SearchRequest.ContentSearchSpec.SnippetSpec`	`build()`
`SearchRequest.ContentSearchSpec.SnippetSpec`	`buildPartial()`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`clear()`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`clearMaxSnippetCount()` Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=406
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`clearReferenceOnly()` Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=410
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`clearReturnSnippet()` If `true`, then return snippet.
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`clone()`
`SearchRequest.ContentSearchSpec.SnippetSpec`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`int`	`getMaxSnippetCount()` Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=406
`boolean`	`getReferenceOnly()` Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=410
`boolean`	`getReturnSnippet()` If `true`, then return snippet.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`mergeFrom(SearchRequest.ContentSearchSpec.SnippetSpec other)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`setMaxSnippetCount(int value)` Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=406
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`setReferenceOnly(boolean value)` Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=410
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`setReturnSnippet(boolean value)` If `true`, then return snippet.
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - clear
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - getDefaultInstanceForType
```
public SearchRequest.ContentSearchSpec.SnippetSpec getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public SearchRequest.ContentSearchSpec.SnippetSpec build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public SearchRequest.ContentSearchSpec.SnippetSpec buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - setField
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                    Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - clearField
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - clearOneof
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - setRepeatedField
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                            int index,
                                                                            Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - addRepeatedField
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                            Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - mergeFrom
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - mergeFrom
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.SnippetSpec other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - mergeFrom
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
    
    Throws:
    
    IOException
  - getMaxSnippetCount
```
@Deprecated
public int getMaxSnippetCount()
```
    Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=406
```
 [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];
    Specified by:
    
    getMaxSnippetCount in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
    
    Returns:
    
    The maxSnippetCount.
  - setMaxSnippetCount
```
@Deprecated
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setMaxSnippetCount(int value)
```
    Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=406
```
 [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];
    Parameters:
    
    value - The maxSnippetCount to set.
    
    Returns:
    
    This builder for chaining.
  - clearMaxSnippetCount
```
@Deprecated
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearMaxSnippetCount()
```
    Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=406
```
 [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:
    
    This builder for chaining.
  - getReferenceOnly
```
@Deprecated
public boolean getReferenceOnly()
```
    Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=410
```
 [DEPRECATED] This field is deprecated and will have no affect on the
 snippet.
 
```
    bool reference_only = 2 [deprecated = true];
    Specified by:
    
    getReferenceOnly in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
    
    Returns:
    
    The referenceOnly.
  - setReferenceOnly
```
@Deprecated
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setReferenceOnly(boolean value)
```
    Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=410
```
 [DEPRECATED] This field is deprecated and will have no affect on the
 snippet.
 
```
    bool reference_only = 2 [deprecated = true];
    Parameters:
    
    value - The referenceOnly to set.
    
    Returns:
    
    This builder for chaining.
  - clearReferenceOnly
```
@Deprecated
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearReferenceOnly()
```
    Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=410
```
 [DEPRECATED] This field is deprecated and will have no affect on the
 snippet.
 
```
    bool reference_only = 2 [deprecated = true];
    Returns:
    
    This builder for chaining.
  - getReturnSnippet
```
public 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;
    Specified by:
    
    getReturnSnippet in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
    
    Returns:
    
    The returnSnippet.
  - setReturnSnippet
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setReturnSnippet(boolean value)
```
```
 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;
    Parameters:
    
    value - The returnSnippet to set.
    
    Returns:
    
    This builder for chaining.
  - clearReturnSnippet
```
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearReturnSnippet()
```
```
 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:
    
    This builder for chaining.
  - setUnknownFields
```
public final SearchRequest.ContentSearchSpec.SnippetSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
  - mergeUnknownFields
```
public final SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>

Class SearchRequest.ContentSearchSpec.SnippetSpec.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getMaxSnippetCount

setMaxSnippetCount

clearMaxSnippetCount

getReferenceOnly

setReferenceOnly

clearReferenceOnly

getReturnSnippet

setReturnSnippet

clearReturnSnippet

setUnknownFields

mergeUnknownFields