Class SearchRequest.ContentSearchSpec (0.45.0)

public static final class SearchRequest.ContentSearchSpec extends GeneratedMessageV3 implements SearchRequest.ContentSearchSpecOrBuilder

A specification for configuring the behavior of content search.

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

Inheritance

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

Static Fields

CHUNK_SPEC_FIELD_NUMBER

public static final int CHUNK_SPEC_FIELD_NUMBER
Field Value
Type Description
int

EXTRACTIVE_CONTENT_SPEC_FIELD_NUMBER

public static final int EXTRACTIVE_CONTENT_SPEC_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_RESULT_MODE_FIELD_NUMBER

public static final int SEARCH_RESULT_MODE_FIELD_NUMBER
Field Value
Type Description
int

SNIPPET_SPEC_FIELD_NUMBER

public static final int SNIPPET_SPEC_FIELD_NUMBER
Field Value
Type Description
int

SUMMARY_SPEC_FIELD_NUMBER

public static final int SUMMARY_SPEC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.ContentSearchSpec getDefaultInstance()
Returns
Type Description
SearchRequest.ContentSearchSpec

getDescriptor()

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

newBuilder()

public static SearchRequest.ContentSearchSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

newBuilder(SearchRequest.ContentSearchSpec prototype)

public static SearchRequest.ContentSearchSpec.Builder newBuilder(SearchRequest.ContentSearchSpec prototype)
Parameter
Name Description
prototype SearchRequest.ContentSearchSpec
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.ContentSearchSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest.ContentSearchSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.ContentSearchSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.ContentSearchSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest.ContentSearchSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.ContentSearchSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.ContentSearchSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.ContentSearchSpec> parser()
Returns
Type Description
Parser<ContentSearchSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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

getParserForType()

public Parser<SearchRequest.ContentSearchSpec> getParserForType()
Returns
Type Description
Parser<ContentSearchSpec>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.ContentSearchSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.ContentSearchSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchRequest.ContentSearchSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.ContentSearchSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException