Class SearchRequest.ContentSearchSpec.SummarySpec.Builder (0.17.0)

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

The specification that configs the summary in the search response.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

build()

public SearchRequest.ContentSearchSpec.SummarySpec build()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec

buildPartial()

public SearchRequest.ContentSearchSpec.SummarySpec buildPartial()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec

clear()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clear()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

clearSummaryResultCount()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearSummaryResultCount()

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
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

clone()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clone()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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
TypeDescription
int

The summaryResultCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)
Parameter
NameDescription
otherSearchRequest.ContentSearchSpec.SummarySpec
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

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

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

setSummaryResultCount(int value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setSummaryResultCount(int value)

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;

Parameter
NameDescription
valueint

The summaryResultCount to set.

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.SummarySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides