Class Answer.Step.Action.Observation.SearchResult (0.45.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

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).

.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 (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).

.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 (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).

.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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

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
Exceptions
Type Description
IOException