Class SearchRequest.ContentSearchSpec.SummarySpec.Builder (0.14.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

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

getDescriptorForType()

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

The summaryResultCount.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value int

The summaryResultCount to set.

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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