- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class SearchResponse.Summary.Builder extends GeneratedMessageV3.Builder<SearchResponse.Summary.Builder> implements SearchResponse.SummaryOrBuilderSummary of the top N search result specified by the summary spec.
Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Summary
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.Summary.BuilderImplements
SearchResponse.SummaryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllSummarySkippedReasons(Iterable<? extends SearchResponse.Summary.SummarySkippedReason> values)
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;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason>The summarySkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
addAllSummarySkippedReasonsValue(Iterable<Integer> values)
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;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<Integer>The enum numeric values on the wire for summarySkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.Summary.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
addSummarySkippedReasons(SearchResponse.Summary.SummarySkippedReason value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | SearchResponse.Summary.SummarySkippedReasonThe summarySkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
addSummarySkippedReasonsValue(int value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for summarySkippedReasons to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
build()
public SearchResponse.Summary build()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary | |
buildPartial()
public SearchResponse.Summary buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary | |
clear()
public SearchResponse.Summary.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.Summary.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.Summary.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
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 | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
clearSummaryText()
public SearchResponse.Summary.Builder clearSummaryText()The summary content.
string summary_text = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
clearSummaryWithMetadata()
public SearchResponse.Summary.Builder clearSummaryWithMetadata()Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
clone()
public SearchResponse.Summary.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
getDefaultInstanceForType()
public SearchResponse.Summary getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SafetyAttributes | The safetyAttributes. |
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;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SafetyAttributes.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SafetyAttributesOrBuilder | |
getSummarySkippedReasons(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummarySkippedReason | The summarySkippedReasons at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int | The count of summarySkippedReasons. |
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;
| Returns | |
|---|---|
| Type | Description |
List<SummarySkippedReason> | A list containing the summarySkippedReasons. |
getSummarySkippedReasonsValue(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire of summarySkippedReasons at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for summarySkippedReasons. |
getSummaryText()
public String getSummaryText()The summary content.
string summary_text = 1;
| Returns | |
|---|---|
| Type | Description |
String | The summaryText. |
getSummaryTextBytes()
public ByteString getSummaryTextBytes()The summary content.
string summary_text = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for summaryText. |
getSummaryWithMetadata()
public SearchResponse.Summary.SummaryWithMetadata getSummaryWithMetadata()Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummaryWithMetadata | The summaryWithMetadata. |
getSummaryWithMetadataBuilder()
public SearchResponse.Summary.SummaryWithMetadata.Builder getSummaryWithMetadataBuilder()Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummaryWithMetadata.Builder | |
getSummaryWithMetadataOrBuilder()
public SearchResponse.Summary.SummaryWithMetadataOrBuilder getSummaryWithMetadataOrBuilder()Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.SummaryWithMetadataOrBuilder | |
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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the safetyAttributes field is set. |
hasSummaryWithMetadata()
public boolean hasSummaryWithMetadata()Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the summaryWithMetadata field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(SearchResponse.Summary other)
public SearchResponse.Summary.Builder mergeFrom(SearchResponse.Summary other)| Parameter | |
|---|---|
| Name | Description |
other | SearchResponse.Summary |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponse.Summary.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public SearchResponse.Summary.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
mergeSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | SearchResponse.Summary.SafetyAttributes |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
mergeSummaryWithMetadata(SearchResponse.Summary.SummaryWithMetadata value)
public SearchResponse.Summary.Builder mergeSummaryWithMetadata(SearchResponse.Summary.SummaryWithMetadata value)Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Parameter | |
|---|---|
| Name | Description |
value | SearchResponse.Summary.SummaryWithMetadata |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.Summary.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.Summary.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.Summary.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
setSafetyAttributes(SearchResponse.Summary.SafetyAttributes value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | SearchResponse.Summary.SafetyAttributes |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
setSafetyAttributes(SearchResponse.Summary.SafetyAttributes.Builder builderForValue)
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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | SearchResponse.Summary.SafetyAttributes.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
setSummarySkippedReasons(int index, SearchResponse.Summary.SummarySkippedReason value)
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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | SearchResponse.Summary.SummarySkippedReasonThe summarySkippedReasons to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
setSummarySkippedReasonsValue(int index, int value)
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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | intThe enum numeric value on the wire for summarySkippedReasons to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
setSummaryText(String value)
public SearchResponse.Summary.Builder setSummaryText(String value)The summary content.
string summary_text = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe summaryText to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
setSummaryTextBytes(ByteString value)
public SearchResponse.Summary.Builder setSummaryTextBytes(ByteString value)The summary content.
string summary_text = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for summaryText to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | This builder for chaining. |
setSummaryWithMetadata(SearchResponse.Summary.SummaryWithMetadata value)
public SearchResponse.Summary.Builder setSummaryWithMetadata(SearchResponse.Summary.SummaryWithMetadata value)Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Parameter | |
|---|---|
| Name | Description |
value | SearchResponse.Summary.SummaryWithMetadata |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
setSummaryWithMetadata(SearchResponse.Summary.SummaryWithMetadata.Builder builderForValue)
public SearchResponse.Summary.Builder setSummaryWithMetadata(SearchResponse.Summary.SummaryWithMetadata.Builder builderForValue)Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | SearchResponse.Summary.SummaryWithMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.Summary.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Summary.Builder | |