Interface SearchDocumentChunksResponseOrBuilder (0.1.0)

public interface SearchDocumentChunksResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getNextPageToken()

public abstract String getNextPageToken()

Optional. Provides a token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public abstract ByteString getNextPageTokenBytes()

Optional. Provides a token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for nextPageToken.

getResults(int index)

public abstract DocumentChunk getResults(int index)

Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.

repeated .google.developers.knowledge.v1.DocumentChunk results = 1;

Parameter
Name Description
index int
Returns
Type Description
DocumentChunk

getResultsCount()

public abstract int getResultsCount()

Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.

repeated .google.developers.knowledge.v1.DocumentChunk results = 1;

Returns
Type Description
int

getResultsList()

public abstract List<DocumentChunk> getResultsList()

Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.

repeated .google.developers.knowledge.v1.DocumentChunk results = 1;

Returns
Type Description
List<DocumentChunk>

getResultsOrBuilder(int index)

public abstract DocumentChunkOrBuilder getResultsOrBuilder(int index)

Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.

repeated .google.developers.knowledge.v1.DocumentChunk results = 1;

Parameter
Name Description
index int
Returns
Type Description
DocumentChunkOrBuilder

getResultsOrBuilderList()

public abstract List<? extends DocumentChunkOrBuilder> getResultsOrBuilderList()

Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.

repeated .google.developers.knowledge.v1.DocumentChunk results = 1;

Returns
Type Description
List<? extends com.google.developers.knowledge.v1.DocumentChunkOrBuilder>