Class SearchResponse.Summary.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
- com.google.cloud.discoveryengine.v1.SearchResponse.Summary.Builder
-
- All Implemented Interfaces:
SearchResponse.SummaryOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- SearchResponse.Summary
public static final class SearchResponse.Summary.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder> implements SearchResponse.SummaryOrBuilder
Summary of the top N search result specified by the summary spec.
Protobuf typegoogle.cloud.discoveryengine.v1.SearchResponse.Summary
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchResponse.Summary.BuilderaddAllSummarySkippedReasons(Iterable<? extends SearchResponse.Summary.SummarySkippedReason> values)Additional summary-skipped reasons.SearchResponse.Summary.BuilderaddAllSummarySkippedReasonsValue(Iterable<Integer> values)Additional summary-skipped reasons.SearchResponse.Summary.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchResponse.Summary.BuilderaddSummarySkippedReasons(SearchResponse.Summary.SummarySkippedReason value)Additional summary-skipped reasons.SearchResponse.Summary.BuilderaddSummarySkippedReasonsValue(int value)Additional summary-skipped reasons.SearchResponse.Summarybuild()SearchResponse.SummarybuildPartial()SearchResponse.Summary.Builderclear()SearchResponse.Summary.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)SearchResponse.Summary.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)SearchResponse.Summary.BuilderclearSafetyAttributes()A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.BuilderclearSummarySkippedReasons()Additional summary-skipped reasons.SearchResponse.Summary.BuilderclearSummaryText()The summary content.SearchResponse.Summary.Builderclone()SearchResponse.SummarygetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()SearchResponse.Summary.SafetyAttributesgetSafetyAttributes()A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.SafetyAttributes.BuildergetSafetyAttributesBuilder()A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.SafetyAttributesOrBuildergetSafetyAttributesOrBuilder()A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.SummarySkippedReasongetSummarySkippedReasons(int index)Additional summary-skipped reasons.intgetSummarySkippedReasonsCount()Additional summary-skipped reasons.List<SearchResponse.Summary.SummarySkippedReason>getSummarySkippedReasonsList()Additional summary-skipped reasons.intgetSummarySkippedReasonsValue(int index)Additional summary-skipped reasons.List<Integer>getSummarySkippedReasonsValueList()Additional summary-skipped reasons.StringgetSummaryText()The summary content.com.google.protobuf.ByteStringgetSummaryTextBytes()The summary content.booleanhasSafetyAttributes()A collection of Safety Attribute categories and their associated confidence scores.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()SearchResponse.Summary.BuildermergeFrom(SearchResponse.Summary other)SearchResponse.Summary.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)SearchResponse.Summary.BuildermergeFrom(com.google.protobuf.Message other)SearchResponse.Summary.BuildermergeSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)SearchResponse.Summary.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchResponse.Summary.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)SearchResponse.Summary.BuildersetSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.BuildersetSafetyAttributes(SearchResponse.Summary.SafetyAttributes.Builder builderForValue)A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.BuildersetSummarySkippedReasons(int index, SearchResponse.Summary.SummarySkippedReason value)Additional summary-skipped reasons.SearchResponse.Summary.BuildersetSummarySkippedReasonsValue(int index, int value)Additional summary-skipped reasons.SearchResponse.Summary.BuildersetSummaryText(String value)The summary content.SearchResponse.Summary.BuildersetSummaryTextBytes(com.google.protobuf.ByteString value)The summary content.SearchResponse.Summary.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
clear
public SearchResponse.Summary.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
getDefaultInstanceForType
public SearchResponse.Summary getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public SearchResponse.Summary build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public SearchResponse.Summary buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public SearchResponse.Summary.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
setField
public SearchResponse.Summary.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
clearField
public SearchResponse.Summary.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
clearOneof
public SearchResponse.Summary.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
setRepeatedField
public SearchResponse.Summary.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
addRepeatedField
public SearchResponse.Summary.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
mergeFrom
public SearchResponse.Summary.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.Summary.Builder>
-
mergeFrom
public SearchResponse.Summary.Builder mergeFrom(SearchResponse.Summary other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
mergeFrom
public SearchResponse.Summary.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.Summary.Builder>- Throws:
IOException
-
getSummaryText
public String getSummaryText()
The summary content.
string summary_text = 1;- Specified by:
getSummaryTextin interfaceSearchResponse.SummaryOrBuilder- Returns:
- The summaryText.
-
getSummaryTextBytes
public com.google.protobuf.ByteString getSummaryTextBytes()
The summary content.
string summary_text = 1;- Specified by:
getSummaryTextBytesin interfaceSearchResponse.SummaryOrBuilder- Returns:
- The bytes for summaryText.
-
setSummaryText
public SearchResponse.Summary.Builder setSummaryText(String value)
The summary content.
string summary_text = 1;- Parameters:
value- The summaryText to set.- Returns:
- This builder for chaining.
-
clearSummaryText
public SearchResponse.Summary.Builder clearSummaryText()
The summary content.
string summary_text = 1;- Returns:
- This builder for chaining.
-
setSummaryTextBytes
public SearchResponse.Summary.Builder setSummaryTextBytes(com.google.protobuf.ByteString value)
The summary content.
string summary_text = 1;- Parameters:
value- The bytes for summaryText to set.- Returns:
- This builder for chaining.
-
getSummarySkippedReasonsList
public List<SearchResponse.Summary.SummarySkippedReason> getSummarySkippedReasonsList()
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Specified by:
getSummarySkippedReasonsListin interfaceSearchResponse.SummaryOrBuilder- Returns:
- A list containing the summarySkippedReasons.
-
getSummarySkippedReasonsCount
public int getSummarySkippedReasonsCount()
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Specified by:
getSummarySkippedReasonsCountin interfaceSearchResponse.SummaryOrBuilder- Returns:
- The count of summarySkippedReasons.
-
getSummarySkippedReasons
public SearchResponse.Summary.SummarySkippedReason getSummarySkippedReasons(int index)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Specified by:
getSummarySkippedReasonsin interfaceSearchResponse.SummaryOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The summarySkippedReasons at the given index.
-
setSummarySkippedReasons
public SearchResponse.Summary.Builder setSummarySkippedReasons(int index, SearchResponse.Summary.SummarySkippedReason value)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Parameters:
index- The index to set the value at.value- The summarySkippedReasons to set.- Returns:
- This builder for chaining.
-
addSummarySkippedReasons
public SearchResponse.Summary.Builder addSummarySkippedReasons(SearchResponse.Summary.SummarySkippedReason value)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Parameters:
value- The summarySkippedReasons to add.- Returns:
- This builder for chaining.
-
addAllSummarySkippedReasons
public SearchResponse.Summary.Builder addAllSummarySkippedReasons(Iterable<? extends SearchResponse.Summary.SummarySkippedReason> values)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Parameters:
values- The summarySkippedReasons to add.- Returns:
- This builder for chaining.
-
clearSummarySkippedReasons
public SearchResponse.Summary.Builder clearSummarySkippedReasons()
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Returns:
- This builder for chaining.
-
getSummarySkippedReasonsValueList
public List<Integer> getSummarySkippedReasonsValueList()
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Specified by:
getSummarySkippedReasonsValueListin interfaceSearchResponse.SummaryOrBuilder- Returns:
- A list containing the enum numeric values on the wire for summarySkippedReasons.
-
getSummarySkippedReasonsValue
public int getSummarySkippedReasonsValue(int index)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Specified by:
getSummarySkippedReasonsValuein interfaceSearchResponse.SummaryOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of summarySkippedReasons at the given index.
-
setSummarySkippedReasonsValue
public SearchResponse.Summary.Builder setSummarySkippedReasonsValue(int index, int value)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for summarySkippedReasons to set.- Returns:
- This builder for chaining.
-
addSummarySkippedReasonsValue
public SearchResponse.Summary.Builder addSummarySkippedReasonsValue(int value)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Parameters:
value- The enum numeric value on the wire for summarySkippedReasons to add.- Returns:
- This builder for chaining.
-
addAllSummarySkippedReasonsValue
public SearchResponse.Summary.Builder addAllSummarySkippedReasonsValue(Iterable<Integer> values)
Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;- Parameters:
values- The enum numeric values on the wire for summarySkippedReasons to add.- Returns:
- This builder for chaining.
-
hasSafetyAttributes
public boolean hasSafetyAttributes()
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;- Specified by:
hasSafetyAttributesin interfaceSearchResponse.SummaryOrBuilder- Returns:
- Whether the safetyAttributes field is set.
-
getSafetyAttributes
public SearchResponse.Summary.SafetyAttributes getSafetyAttributes()
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;- Specified by:
getSafetyAttributesin interfaceSearchResponse.SummaryOrBuilder- Returns:
- The safetyAttributes.
-
setSafetyAttributes
public SearchResponse.Summary.Builder setSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
-
setSafetyAttributes
public SearchResponse.Summary.Builder setSafetyAttributes(SearchResponse.Summary.SafetyAttributes.Builder builderForValue)
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
-
mergeSafetyAttributes
public SearchResponse.Summary.Builder mergeSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
-
clearSafetyAttributes
public SearchResponse.Summary.Builder clearSafetyAttributes()
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
-
getSafetyAttributesBuilder
public SearchResponse.Summary.SafetyAttributes.Builder getSafetyAttributesBuilder()
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
-
getSafetyAttributesOrBuilder
public SearchResponse.Summary.SafetyAttributesOrBuilder getSafetyAttributesOrBuilder()
A collection of Safety Attribute categories and their associated confidence scores.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;- Specified by:
getSafetyAttributesOrBuilderin interfaceSearchResponse.SummaryOrBuilder
-
setUnknownFields
public final SearchResponse.Summary.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
mergeUnknownFields
public final SearchResponse.Summary.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
-