Class SearchRequest.ContentSearchSpec (0.29.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.v1beta.SearchRequest.ContentSearchSpec

Inheritance

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

Static Fields

EXTRACTIVE_CONTENT_SPEC_FIELD_NUMBER

public static final int EXTRACTIVE_CONTENT_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

SNIPPET_SPEC_FIELD_NUMBER

public static final int SNIPPET_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

SUMMARY_SPEC_FIELD_NUMBER

public static final int SUMMARY_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchRequest.ContentSearchSpec getDefaultInstance()
Returns
TypeDescription
SearchRequest.ContentSearchSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchRequest.ContentSearchSpec.Builder newBuilder()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.Builder

newBuilder(SearchRequest.ContentSearchSpec prototype)

public static SearchRequest.ContentSearchSpec.Builder newBuilder(SearchRequest.ContentSearchSpec prototype)
Parameter
NameDescription
prototypeSearchRequest.ContentSearchSpec
Returns
TypeDescription
SearchRequest.ContentSearchSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.ContentSearchSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchRequest.ContentSearchSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.ContentSearchSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.ContentSearchSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchRequest.ContentSearchSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.ContentSearchSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec getDefaultInstanceForType()
Returns
TypeDescription
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.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
TypeDescription
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.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
TypeDescription
SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSnippetSpec()

public SearchRequest.ContentSearchSpec.SnippetSpec getSnippetSpec()

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

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

Returns
TypeDescription
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.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
TypeDescription
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.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
TypeDescription
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.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

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.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

Returns
TypeDescription
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.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

Returns
TypeDescription
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.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

Returns
TypeDescription
boolean

Whether the summarySpec field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchRequest.ContentSearchSpec.Builder newBuilderForType()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.ContentSearchSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchRequest.ContentSearchSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchRequest.ContentSearchSpec.Builder toBuilder()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException