Class SearchResponse.Summary (0.38.0)

Version 0.38.0

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchResponse.Summary

Implements

SearchResponse.SummaryOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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

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

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchResponse.Summary getDefaultInstanceForType()

Returns
Type	Description
SearchResponse.Summary

getParserForType()

public Parser<SearchResponse.Summary> getParserForType()

Returns
Type	Description
Parser<Summary>

Overrides

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException