Class SearchResponse.Summary (0.41.0)

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

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

SUMMARY_WITH_METADATA_FIELD_NUMBER

public static final int SUMMARY_WITH_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchResponse.Summary getDefaultInstance()
Returns
Type Description
SearchResponse.Summary

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchResponse.Summary.Builder newBuilder()
Returns
Type Description
SearchResponse.Summary.Builder

newBuilder(SearchResponse.Summary prototype)

public static SearchResponse.Summary.Builder newBuilder(SearchResponse.Summary prototype)
Parameter
Name Description
prototype SearchResponse.Summary
Returns
Type Description
SearchResponse.Summary.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.Summary parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchResponse.Summary parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.Summary parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.Summary parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchResponse.Summary parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.Summary parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse.Summary> parser()
Returns
Type Description
Parser<Summary>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchResponse.Summary getDefaultInstanceForType()
Returns
Type Description
SearchResponse.Summary

getParserForType()

public Parser<SearchResponse.Summary> getParserForType()
Returns
Type Description
Parser<Summary>
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;

Returns
Type Description
SearchResponse.Summary.SafetyAttributes

The safetyAttributes.

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

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.

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 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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchResponse.Summary.Builder newBuilderForType()
Returns
Type Description
SearchResponse.Summary.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Summary.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.Summary.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchResponse.Summary.Builder toBuilder()
Returns
Type Description
SearchResponse.Summary.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException