Class SearchResponse.Summary (0.36.0)

public static final class SearchResponse.Summary extends GeneratedMessageV3 implements SearchResponse.SummaryOrBuilder

Summary of the top N search result 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
TypeDescription
int

SUMMARY_SKIPPED_REASONS_FIELD_NUMBER

public static final int SUMMARY_SKIPPED_REASONS_FIELD_NUMBER
Field Value
TypeDescription
int

SUMMARY_TEXT_FIELD_NUMBER

public static final int SUMMARY_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

SUMMARY_WITH_METADATA_FIELD_NUMBER

public static final int SUMMARY_WITH_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchResponse.Summary getDefaultInstance()
Returns
TypeDescription
SearchResponse.Summary

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchResponse.Summary.Builder newBuilder()
Returns
TypeDescription
SearchResponse.Summary.Builder

newBuilder(SearchResponse.Summary prototype)

public static SearchResponse.Summary.Builder newBuilder(SearchResponse.Summary prototype)
Parameter
NameDescription
prototypeSearchResponse.Summary
Returns
TypeDescription
SearchResponse.Summary.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.Summary parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchResponse.Summary parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.Summary parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.Summary parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchResponse.Summary parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.Summary parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchResponse.Summary getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse.Summary

getParserForType()

public Parser<SearchResponse.Summary> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
SearchResponse.Summary.SafetyAttributesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
String

The summaryText.

getSummaryTextBytes()

public ByteString getSummaryTextBytes()

The summary content.

string summary_text = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the summaryWithMetadata field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchResponse.Summary.Builder newBuilderForType()
Returns
TypeDescription
SearchResponse.Summary.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Summary.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchResponse.Summary.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchResponse.Summary.Builder toBuilder()
Returns
TypeDescription
SearchResponse.Summary.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException