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.v1beta.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.v1beta.SearchResponse.Summary
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchResponse.Summary.Builder
addAllSummarySkippedReasons(Iterable<? extends SearchResponse.Summary.SummarySkippedReason> values)
Additional summary-skipped reasons.SearchResponse.Summary.Builder
addAllSummarySkippedReasonsValue(Iterable<Integer> values)
Additional summary-skipped reasons.SearchResponse.Summary.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchResponse.Summary.Builder
addSummarySkippedReasons(SearchResponse.Summary.SummarySkippedReason value)
Additional summary-skipped reasons.SearchResponse.Summary.Builder
addSummarySkippedReasonsValue(int value)
Additional summary-skipped reasons.SearchResponse.Summary
build()
SearchResponse.Summary
buildPartial()
SearchResponse.Summary.Builder
clear()
SearchResponse.Summary.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchResponse.Summary.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchResponse.Summary.Builder
clearSafetyAttributes()
A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.Builder
clearSummarySkippedReasons()
Additional summary-skipped reasons.SearchResponse.Summary.Builder
clearSummaryText()
The summary content.SearchResponse.Summary.Builder
clone()
SearchResponse.Summary
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
SearchResponse.Summary.SafetyAttributes
getSafetyAttributes()
A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.SafetyAttributes.Builder
getSafetyAttributesBuilder()
A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.SafetyAttributesOrBuilder
getSafetyAttributesOrBuilder()
A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.SummarySkippedReason
getSummarySkippedReasons(int index)
Additional summary-skipped reasons.int
getSummarySkippedReasonsCount()
Additional summary-skipped reasons.List<SearchResponse.Summary.SummarySkippedReason>
getSummarySkippedReasonsList()
Additional summary-skipped reasons.int
getSummarySkippedReasonsValue(int index)
Additional summary-skipped reasons.List<Integer>
getSummarySkippedReasonsValueList()
Additional summary-skipped reasons.String
getSummaryText()
The summary content.com.google.protobuf.ByteString
getSummaryTextBytes()
The summary content.boolean
hasSafetyAttributes()
A collection of Safety Attribute categories and their associated confidence scores.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
SearchResponse.Summary.Builder
mergeFrom(SearchResponse.Summary other)
SearchResponse.Summary.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchResponse.Summary.Builder
mergeFrom(com.google.protobuf.Message other)
SearchResponse.Summary.Builder
mergeSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)
A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchResponse.Summary.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchResponse.Summary.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchResponse.Summary.Builder
setSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)
A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.Builder
setSafetyAttributes(SearchResponse.Summary.SafetyAttributes.Builder builderForValue)
A collection of Safety Attribute categories and their associated confidence scores.SearchResponse.Summary.Builder
setSummarySkippedReasons(int index, SearchResponse.Summary.SummarySkippedReason value)
Additional summary-skipped reasons.SearchResponse.Summary.Builder
setSummarySkippedReasonsValue(int index, int value)
Additional summary-skipped reasons.SearchResponse.Summary.Builder
setSummaryText(String value)
The summary content.SearchResponse.Summary.Builder
setSummaryTextBytes(com.google.protobuf.ByteString value)
The summary content.SearchResponse.Summary.Builder
setUnknownFields(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:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
clear
public SearchResponse.Summary.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
getDefaultInstanceForType
public SearchResponse.Summary getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public SearchResponse.Summary build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public SearchResponse.Summary buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public SearchResponse.Summary.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
setField
public SearchResponse.Summary.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
clearField
public SearchResponse.Summary.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
clearOneof
public SearchResponse.Summary.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in 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:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
addRepeatedField
public SearchResponse.Summary.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
mergeFrom
public SearchResponse.Summary.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.Summary.Builder>
-
mergeFrom
public SearchResponse.Summary.Builder mergeFrom(SearchResponse.Summary other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in 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:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.Summary.Builder>
- Throws:
IOException
-
getSummaryText
public String getSummaryText()
The summary content.
string summary_text = 1;
- Specified by:
getSummaryText
in interfaceSearchResponse.SummaryOrBuilder
- Returns:
- The summaryText.
-
getSummaryTextBytes
public com.google.protobuf.ByteString getSummaryTextBytes()
The summary content.
string summary_text = 1;
- Specified by:
getSummaryTextBytes
in 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.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
- Specified by:
getSummarySkippedReasonsList
in 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.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
- Specified by:
getSummarySkippedReasonsCount
in 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.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
- Specified by:
getSummarySkippedReasons
in 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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
- Specified by:
getSummarySkippedReasonsValueList
in 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.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
- Specified by:
getSummarySkippedReasonsValue
in 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.v1beta.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.v1beta.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.v1beta.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.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
- Specified by:
hasSafetyAttributes
in 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.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
- Specified by:
getSafetyAttributes
in 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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
- Specified by:
getSafetyAttributesOrBuilder
in interfaceSearchResponse.SummaryOrBuilder
-
setUnknownFields
public final SearchResponse.Summary.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
mergeUnknownFields
public final SearchResponse.Summary.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Summary.Builder>
-
-