Class Answer.Step.Action.Observation.SearchResult (0.49.0)

Version latest

• 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 Answer.Step.Action.Observation.SearchResult extends GeneratedMessageV3 implements Answer.Step.Action.Observation.SearchResultOrBuilder

Protobuf type google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Answer.Step.Action.Observation.SearchResult

Implements

Answer.Step.Action.Observation.SearchResultOrBuilder

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

CHUNK_INFO_FIELD_NUMBER

public static final int CHUNK_INFO_FIELD_NUMBER

Field Value
Type	Description
int

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

Field Value
Type	Description
int

SNIPPET_INFO_FIELD_NUMBER

public static final int SNIPPET_INFO_FIELD_NUMBER

Field Value
Type	Description
int

STRUCT_DATA_FIELD_NUMBER

public static final int STRUCT_DATA_FIELD_NUMBER

Field Value
Type	Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

Field Value
Type	Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Answer.Step.Action.Observation.SearchResult getDefaultInstance()

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Answer.Step.Action.Observation.SearchResult.Builder newBuilder()

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.Builder

newBuilder(Answer.Step.Action.Observation.SearchResult prototype)

public static Answer.Step.Action.Observation.SearchResult.Builder newBuilder(Answer.Step.Action.Observation.SearchResult prototype)

Parameter
Name	Description
prototype	Answer.Step.Action.Observation.SearchResult

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.Builder

parseDelimitedFrom(InputStream input)

public static Answer.Step.Action.Observation.SearchResult parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Answer.Step.Action.Observation.SearchResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Answer.Step.Action.Observation.SearchResult parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Answer.Step.Action.Observation.SearchResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Answer.Step.Action.Observation.SearchResult parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Answer.Step.Action.Observation.SearchResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Answer.Step.Action.Observation.SearchResult parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Answer.Step.Action.Observation.SearchResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Answer.Step.Action.Observation.SearchResult parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Answer.Step.Action.Observation.SearchResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Answer.Step.Action.Observation.SearchResult parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Answer.Step.Action.Observation.SearchResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Answer.Step.Action.Observation.SearchResult> parser()

Returns
Type	Description
Parser<SearchResult>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getChunkInfo(int index)

public Answer.Step.Action.Observation.SearchResult.ChunkInfo getChunkInfo(int index)

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.ChunkInfo

getChunkInfoCount()

public int getChunkInfoCount()

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Returns
Type	Description
int

getChunkInfoList()

public List<Answer.Step.Action.Observation.SearchResult.ChunkInfo> getChunkInfoList()

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Returns
Type	Description
List<ChunkInfo>

getChunkInfoOrBuilder(int index)

public Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder getChunkInfoOrBuilder(int index)

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder

getChunkInfoOrBuilderList()

public List<? extends Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder> getChunkInfoOrBuilderList()

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder>

getDefaultInstanceForType()

public Answer.Step.Action.Observation.SearchResult getDefaultInstanceForType()

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult

getDocument()

public String getDocument()

Document resource name.

string document = 1;

Returns
Type	Description
String	The document.

getDocumentBytes()

public ByteString getDocumentBytes()

Document resource name.

string document = 1;

Returns
Type	Description
ByteString	The bytes for document.

getParserForType()

public Parser<Answer.Step.Action.Observation.SearchResult> getParserForType()

Returns
Type	Description
Parser<SearchResult>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSnippetInfo(int index)

public Answer.Step.Action.Observation.SearchResult.SnippetInfo getSnippetInfo(int index)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.SnippetInfo

getSnippetInfoCount()

public int getSnippetInfoCount()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Returns
Type	Description
int

getSnippetInfoList()

public List<Answer.Step.Action.Observation.SearchResult.SnippetInfo> getSnippetInfoList()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Returns
Type	Description
List<SnippetInfo>

getSnippetInfoOrBuilder(int index)

public Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder getSnippetInfoOrBuilder(int index)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder

getSnippetInfoOrBuilderList()

public List<? extends Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder> getSnippetInfoOrBuilderList()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder>

getStructData()

public Struct getStructData()

Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

.google.protobuf.Struct struct_data = 6;

Returns
Type	Description
Struct	The structData.

getStructDataOrBuilder()

public StructOrBuilder getStructDataOrBuilder()

Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

.google.protobuf.Struct struct_data = 6;

Returns
Type	Description
StructOrBuilder

getTitle()

public String getTitle()

Title.

string title = 3;

Returns
Type	Description
String	The title.

getTitleBytes()

public ByteString getTitleBytes()

Title.

string title = 3;

Returns
Type	Description
ByteString	The bytes for title.

getUri()

public String getUri()

URI for the document.

string uri = 2;

Returns
Type	Description
String	The uri.

getUriBytes()

public ByteString getUriBytes()

URI for the document.

string uri = 2;

Returns
Type	Description
ByteString	The bytes for uri.

hasStructData()

public boolean hasStructData()

Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

.google.protobuf.Struct struct_data = 6;

Returns
Type	Description
boolean	Whether the structData 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 Answer.Step.Action.Observation.SearchResult.Builder newBuilderForType()

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Answer.Step.Action.Observation.SearchResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.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 Answer.Step.Action.Observation.SearchResult.Builder toBuilder()

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException