public static final class SearchResponse.Summary extends GeneratedMessageV3 implements SearchResponse.SummaryOrBuilder
Summary of the top N search results specified by the summary spec.
Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Summary
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
SAFETY_ATTRIBUTES_FIELD_NUMBER
public static final int SAFETY_ATTRIBUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUMMARY_SKIPPED_REASONS_FIELD_NUMBER
public static final int SUMMARY_SKIPPED_REASONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUMMARY_TEXT_FIELD_NUMBER
public static final int SUMMARY_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SUMMARY_WITH_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchResponse.Summary getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchResponse.Summary.Builder newBuilder()
newBuilder(SearchResponse.Summary prototype)
public static SearchResponse.Summary.Builder newBuilder(SearchResponse.Summary prototype)
public static SearchResponse.Summary parseDelimitedFrom(InputStream input)
public static SearchResponse.Summary parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchResponse.Summary parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Summary parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchResponse.Summary parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Summary parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Summary parseFrom(CodedInputStream input)
public static SearchResponse.Summary parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Summary parseFrom(InputStream input)
public static SearchResponse.Summary parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchResponse.Summary parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Summary parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchResponse.Summary> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SearchResponse.Summary getDefaultInstanceForType()
getParserForType()
public Parser<SearchResponse.Summary> getParserForType()
Overrides
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;
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 |
int
The index of the element to return.
|
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;
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 |
int
The 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.
|
public SearchResponse.Summary.SummaryWithMetadata getSummaryWithMetadata()
Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
public SearchResponse.Summary.SummaryWithMetadataOrBuilder getSummaryWithMetadataOrBuilder()
Summary with metadata information.
.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
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.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchResponse.Summary.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchResponse.Summary.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchResponse.Summary.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
