Class SearchRequest.ContentSearchSpec.Builder (0.44.0)

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

A specification for configuring the behavior of content search.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

build()

public SearchRequest.ContentSearchSpec build()
Returns
Type Description
SearchRequest.ContentSearchSpec

buildPartial()

public SearchRequest.ContentSearchSpec buildPartial()
Returns
Type Description
SearchRequest.ContentSearchSpec

clear()

public SearchRequest.ContentSearchSpec.Builder clear()
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

clearChunkSpec()

public SearchRequest.ContentSearchSpec.Builder clearChunkSpec()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

clearExtractiveContentSpec()

public SearchRequest.ContentSearchSpec.Builder clearExtractiveContentSpec()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.ContentSearchSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.ContentSearchSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

clearSearchResultMode()

public SearchRequest.ContentSearchSpec.Builder clearSearchResultMode()

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;

Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

This builder for chaining.

clearSnippetSpec()

public SearchRequest.ContentSearchSpec.Builder clearSnippetSpec()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

clearSummarySpec()

public SearchRequest.ContentSearchSpec.Builder clearSummarySpec()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

clone()

public SearchRequest.ContentSearchSpec.Builder clone()
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

getChunkSpec()

public SearchRequest.ContentSearchSpec.ChunkSpec getChunkSpec()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec

The chunkSpec.

getChunkSpecBuilder()

public SearchRequest.ContentSearchSpec.ChunkSpec.Builder getChunkSpecBuilder()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec.Builder

getChunkSpecOrBuilder()

public SearchRequest.ContentSearchSpec.ChunkSpecOrBuilder getChunkSpecOrBuilder()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpecOrBuilder

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.ContentSearchSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExtractiveContentSpec()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getExtractiveContentSpec()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec

The extractiveContentSpec.

getExtractiveContentSpecBuilder()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder getExtractiveContentSpecBuilder()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder

getExtractiveContentSpecOrBuilder()

public SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder getExtractiveContentSpecOrBuilder()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type Description
SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

getSearchResultMode()

public SearchRequest.ContentSearchSpec.SearchResultMode getSearchResultMode()

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;

Returns
Type Description
SearchRequest.ContentSearchSpec.SearchResultMode

The searchResultMode.

getSearchResultModeValue()

public int getSearchResultModeValue()

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;

Returns
Type Description
int

The enum numeric value on the wire for searchResultMode.

getSnippetSpec()

public SearchRequest.ContentSearchSpec.SnippetSpec getSnippetSpec()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type Description
SearchRequest.ContentSearchSpec.SnippetSpec

The snippetSpec.

getSnippetSpecBuilder()

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder getSnippetSpecBuilder()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type Description
SearchRequest.ContentSearchSpec.SnippetSpec.Builder

getSnippetSpecOrBuilder()

public SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder getSnippetSpecOrBuilder()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type Description
SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

getSummarySpec()

public SearchRequest.ContentSearchSpec.SummarySpec getSummarySpec()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec

The summarySpec.

getSummarySpecBuilder()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder getSummarySpecBuilder()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

getSummarySpecOrBuilder()

public SearchRequest.ContentSearchSpec.SummarySpecOrBuilder getSummarySpecOrBuilder()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

hasChunkSpec()

public boolean hasChunkSpec()

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Returns
Type Description
boolean

Whether the chunkSpec field is set.

hasExtractiveContentSpec()

public boolean hasExtractiveContentSpec()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
Type Description
boolean

Whether the extractiveContentSpec field is set.

hasSnippetSpec()

public boolean hasSnippetSpec()

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
Type Description
boolean

Whether the snippetSpec field is set.

hasSummarySpec()

public boolean hasSummarySpec()

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
Type Description
boolean

Whether the summarySpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec value)

public SearchRequest.ContentSearchSpec.Builder mergeChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec value)

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.ChunkSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

mergeExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec value)

public SearchRequest.ContentSearchSpec.Builder mergeExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec value)

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

mergeFrom(SearchRequest.ContentSearchSpec other)

public SearchRequest.ContentSearchSpec.Builder mergeFrom(SearchRequest.ContentSearchSpec other)
Parameter
Name Description
other SearchRequest.ContentSearchSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.ContentSearchSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchRequest.ContentSearchSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

mergeSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec value)

public SearchRequest.ContentSearchSpec.Builder mergeSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec value)

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.SnippetSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

mergeSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

public SearchRequest.ContentSearchSpec.Builder mergeSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.SummarySpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

setChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec value)

public SearchRequest.ContentSearchSpec.Builder setChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec value)

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.ChunkSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec.Builder builderForValue)

public SearchRequest.ContentSearchSpec.Builder setChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec.Builder builderForValue)

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

Parameter
Name Description
builderForValue SearchRequest.ContentSearchSpec.ChunkSpec.Builder
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec value)

public SearchRequest.ContentSearchSpec.Builder setExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec value)

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder builderForValue)

public SearchRequest.ContentSearchSpec.Builder setExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder builderForValue)

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Parameter
Name Description
builderForValue SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

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

public SearchRequest.ContentSearchSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

setSearchResultMode(SearchRequest.ContentSearchSpec.SearchResultMode value)

public SearchRequest.ContentSearchSpec.Builder setSearchResultMode(SearchRequest.ContentSearchSpec.SearchResultMode value)

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.SearchResultMode

The searchResultMode to set.

Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

This builder for chaining.

setSearchResultModeValue(int value)

public SearchRequest.ContentSearchSpec.Builder setSearchResultModeValue(int value)

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for searchResultMode to set.

Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

This builder for chaining.

setSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec value)

public SearchRequest.ContentSearchSpec.Builder setSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec value)

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.SnippetSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec.Builder builderForValue)

public SearchRequest.ContentSearchSpec.Builder setSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec.Builder builderForValue)

If snippetSpec is not specified, snippets are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Parameter
Name Description
builderForValue SearchRequest.ContentSearchSpec.SnippetSpec.Builder
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

public SearchRequest.ContentSearchSpec.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.SummarySpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue)

public SearchRequest.ContentSearchSpec.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue)

If summarySpec is not specified, summaries are not included in the search response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Parameter
Name Description
builderForValue SearchRequest.ContentSearchSpec.SummarySpec.Builder
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides