Class SearchRequest.ContentSearchSpec.SummarySpec (0.16.0)

public static final class SearchRequest.ContentSearchSpec.SummarySpec extends GeneratedMessageV3 implements SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

The specification that configs the summary in the search response.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec

Inheritance

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

Static Fields

SUMMARY_RESULT_COUNT_FIELD_NUMBER

public static final int SUMMARY_RESULT_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSummaryResultCount()

public int getSummaryResultCount()

The number of top results the summary should be generated from. If the number of returned results is less than summary_result_count, then the summary would be derived from all the results; otherwise, the summary would be derived from the top results.

At most 5 results can be used for generating summary.

int32 summary_result_count = 1;

Returns
Type Description
int

The summaryResultCount.

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.SummarySpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec.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.SummarySpec.Builder toBuilder()
Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

writeTo(CodedOutputStream output)

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