Class SearchRequest.ContentSearchSpec.SnippetSpec.Builder (0.51.0)

public static final class SearchRequest.ContentSearchSpec.SnippetSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder> implements SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

A specification for configuring snippets in a search response.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.ContentSearchSpec.SnippetSpec.Builder

Implements

SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchRequest.ContentSearchSpec.SnippetSpec build()

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec`

buildPartial()

public SearchRequest.ContentSearchSpec.SnippetSpec buildPartial()

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec`

clear()

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clear()

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMaxSnippetCount() (deprecated)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearMaxSnippetCount()

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

[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
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReferenceOnly() (deprecated)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearReferenceOnly()

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

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

bool reference_only = 2 [deprecated = true];

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	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
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	This builder for chaining.

clone()

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clone()

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.SnippetSpec getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMaxSnippetCount() (deprecated)

public int getMaxSnippetCount()

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

[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 boolean getReferenceOnly()

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest.ContentSearchSpec.SnippetSpec other)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.SnippetSpec other)

Parameter
Name	Description
`other`	`SearchRequest.ContentSearchSpec.SnippetSpec`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMaxSnippetCount(int value) (deprecated)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setMaxSnippetCount(int value)

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

[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];

Parameter
Name	Description
`value`	`int` The maxSnippetCount to set.

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	This builder for chaining.

setReferenceOnly(boolean value) (deprecated)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setReferenceOnly(boolean value)

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

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

bool reference_only = 2 [deprecated = true];

Parameter
Name	Description
`value`	`boolean` The referenceOnly to set.

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReturnSnippet(boolean value)

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;

Parameter
Name	Description
`value`	`boolean` The returnSnippet to set.

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.SnippetSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.ContentSearchSpec.SnippetSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)