Package com.google.cloud.discoveryengine.v1beta

Class Answer.Step.Action.Observation.SearchResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1beta.Answer.Step.Action.Observation.SearchResult

All Implemented Interfaces:

Answer.Step.Action.Observation.SearchResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Answer.Step.Action.Observation

public static final class Answer.Step.Action.Observation.SearchResult
extends com.google.protobuf.GeneratedMessage
implements Answer.Step.Action.Observation.SearchResultOrBuilder

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Answer.Step.Action.Observation.SearchResult.Builder	Protobuf type google.cloud.discoveryengine.v1beta.Answer.Step.Action.Observation.SearchResult
static final class	Answer.Step.Action.Observation.SearchResult.ChunkInfo	Chunk information.
static interface	Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder
static final class	Answer.Step.Action.Observation.SearchResult.SnippetInfo	Snippet information.
static interface	Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHUNK_INFO_FIELD_NUMBER
static final int	DOCUMENT_FIELD_NUMBER
static final int	SNIPPET_INFO_FIELD_NUMBER
static final int	STRUCT_DATA_FIELD_NUMBER
static final int	TITLE_FIELD_NUMBER
static final int	URI_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Answer.Step.Action.Observation.SearchResult.ChunkInfo	getChunkInfo(int index)	If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
int	getChunkInfoCount()	If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
List<Answer.Step.Action.Observation.SearchResult.ChunkInfo>	getChunkInfoList()	If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder	getChunkInfoOrBuilder(int index)	If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
List<? extends Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder>	getChunkInfoOrBuilderList()	If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
static Answer.Step.Action.Observation.SearchResult	getDefaultInstance()
Answer.Step.Action.Observation.SearchResult	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDocument()	Document resource name.
com.google.protobuf.ByteString	getDocumentBytes()	Document resource name.
com.google.protobuf.Parser<Answer.Step.Action.Observation.SearchResult>	getParserForType()
int	getSerializedSize()
Answer.Step.Action.Observation.SearchResult.SnippetInfo	getSnippetInfo(int index)	If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
int	getSnippetInfoCount()	If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
List<Answer.Step.Action.Observation.SearchResult.SnippetInfo>	getSnippetInfoList()	If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder	getSnippetInfoOrBuilder(int index)	If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
List<? extends Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder>	getSnippetInfoOrBuilderList()	If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
com.google.protobuf.Struct	getStructData()	Data representation.
com.google.protobuf.StructOrBuilder	getStructDataOrBuilder()	Data representation.
String	getTitle()	Title.
com.google.protobuf.ByteString	getTitleBytes()	Title.
String	getUri()	URI for the document.
com.google.protobuf.ByteString	getUriBytes()	URI for the document.
int	hashCode()
boolean	hasStructData()	Data representation.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Answer.Step.Action.Observation.SearchResult.Builder	newBuilder()
static Answer.Step.Action.Observation.SearchResult.Builder	newBuilder(Answer.Step.Action.Observation.SearchResult prototype)
Answer.Step.Action.Observation.SearchResult.Builder	newBuilderForType()
protected Answer.Step.Action.Observation.SearchResult.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Answer.Step.Action.Observation.SearchResult	parseDelimitedFrom(InputStream input)
static Answer.Step.Action.Observation.SearchResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.Step.Action.Observation.SearchResult	parseFrom(byte[] data)
static Answer.Step.Action.Observation.SearchResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.Step.Action.Observation.SearchResult	parseFrom(com.google.protobuf.ByteString data)
static Answer.Step.Action.Observation.SearchResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.Step.Action.Observation.SearchResult	parseFrom(com.google.protobuf.CodedInputStream input)
static Answer.Step.Action.Observation.SearchResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.Step.Action.Observation.SearchResult	parseFrom(InputStream input)
static Answer.Step.Action.Observation.SearchResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Answer.Step.Action.Observation.SearchResult	parseFrom(ByteBuffer data)
static Answer.Step.Action.Observation.SearchResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Answer.Step.Action.Observation.SearchResult>	parser()
Answer.Step.Action.Observation.SearchResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

See Also:

• Constant Field Values

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

See Also:

• Constant Field Values

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

See Also:

• Constant Field Values

SNIPPET_INFO_FIELD_NUMBER

public static final int SNIPPET_INFO_FIELD_NUMBER

See Also:

• Constant Field Values

CHUNK_INFO_FIELD_NUMBER

public static final int CHUNK_INFO_FIELD_NUMBER

See Also:

• Constant Field Values

STRUCT_DATA_FIELD_NUMBER

public static final int STRUCT_DATA_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getDocument

public String getDocument()

 Document resource name.
 

string document = 1;

Specified by:

getDocument in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

The document.

getDocumentBytes

public com.google.protobuf.ByteString getDocumentBytes()

 Document resource name.
 

string document = 1;

Specified by:

getDocumentBytes in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

The bytes for document.

getUri

public String getUri()

 URI for the document.
 

string uri = 2;

Specified by:

getUri in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

The uri.

getUriBytes

public com.google.protobuf.ByteString getUriBytes()

 URI for the document.
 

string uri = 2;

Specified by:

getUriBytes in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

The bytes for uri.

getTitle

public String getTitle()

 Title.
 

string title = 3;

Specified by:

getTitle in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

The title.

getTitleBytes

public com.google.protobuf.ByteString getTitleBytes()

 Title.
 

string title = 3;

Specified by:

getTitleBytes in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

The bytes for title.

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.v1beta.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Specified by:

getSnippetInfoList in interface Answer.Step.Action.Observation.SearchResultOrBuilder

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.v1beta.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Specified by:

getSnippetInfoOrBuilderList in interface Answer.Step.Action.Observation.SearchResultOrBuilder

getSnippetInfoCount

public int getSnippetInfoCount()

 If citation_type is DOCUMENT_LEVEL_CITATION, populate document
 level snippets.
 

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

Specified by:

getSnippetInfoCount in interface Answer.Step.Action.Observation.SearchResultOrBuilder

getSnippetInfo

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.v1beta.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Specified by:

getSnippetInfo in interface Answer.Step.Action.Observation.SearchResultOrBuilder

getSnippetInfoOrBuilder

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.v1beta.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Specified by:

getSnippetInfoOrBuilder in interface Answer.Step.Action.Observation.SearchResultOrBuilder

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.v1beta.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Specified by:

getChunkInfoList in interface Answer.Step.Action.Observation.SearchResultOrBuilder

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.v1beta.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Specified by:

getChunkInfoOrBuilderList in interface Answer.Step.Action.Observation.SearchResultOrBuilder

getChunkInfoCount

public int getChunkInfoCount()

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

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

Specified by:

getChunkInfoCount in interface Answer.Step.Action.Observation.SearchResultOrBuilder

getChunkInfo

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.v1beta.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Specified by:

getChunkInfo in interface Answer.Step.Action.Observation.SearchResultOrBuilder

getChunkInfoOrBuilder

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.v1beta.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Specified by:

getChunkInfoOrBuilder in interface Answer.Step.Action.Observation.SearchResultOrBuilder

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;

Specified by:

hasStructData in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

Whether the structData field is set.

getStructData

public com.google.protobuf.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;

Specified by:

getStructData in interface Answer.Step.Action.Observation.SearchResultOrBuilder

Returns:

The structData.

getStructDataOrBuilder

public com.google.protobuf.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;

Specified by:

getStructDataOrBuilder in interface Answer.Step.Action.Observation.SearchResultOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(ByteBuffer data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(com.google.protobuf.ByteString data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(byte[] data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

public static Answer.Step.Action.Observation.SearchResult parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Throws:

IOException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(com.google.protobuf.CodedInputStream input)
                                                             throws IOException

Throws:

IOException

parseFrom

public static Answer.Step.Action.Observation.SearchResult parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

newBuilderForType

public Answer.Step.Action.Observation.SearchResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

newBuilder

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

toBuilder

public Answer.Step.Action.Observation.SearchResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Answer.Step.Action.Observation.SearchResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

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

parser

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

getParserForType

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

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder