Class SearchDocumentChunksResponse.Builder (0.1.0)

public static final class SearchDocumentChunksResponse.Builder extends GeneratedMessage.Builder<SearchDocumentChunksResponse.Builder> implements SearchDocumentChunksResponseOrBuilder

Response message for DeveloperKnowledge.SearchDocumentChunks.

Protobuf type google.developers.knowledge.v1.SearchDocumentChunksResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllResults(Iterable<? extends DocumentChunk> values)

public SearchDocumentChunksResponse.Builder addAllResults(Iterable<? extends DocumentChunk> values)

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
values Iterable<? extends com.google.developers.knowledge.v1.DocumentChunk>
Returns
Type Description
SearchDocumentChunksResponse.Builder

addResults(DocumentChunk value)

public SearchDocumentChunksResponse.Builder addResults(DocumentChunk value)

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
value DocumentChunk
Returns
Type Description
SearchDocumentChunksResponse.Builder

addResults(DocumentChunk.Builder builderForValue)

public SearchDocumentChunksResponse.Builder addResults(DocumentChunk.Builder builderForValue)

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
builderForValue DocumentChunk.Builder
Returns
Type Description
SearchDocumentChunksResponse.Builder

addResults(int index, DocumentChunk value)

public SearchDocumentChunksResponse.Builder addResults(int index, DocumentChunk value)

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;

Parameters
Name Description
index int
value DocumentChunk
Returns
Type Description
SearchDocumentChunksResponse.Builder

addResults(int index, DocumentChunk.Builder builderForValue)

public SearchDocumentChunksResponse.Builder addResults(int index, DocumentChunk.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue DocumentChunk.Builder
Returns
Type Description
SearchDocumentChunksResponse.Builder

addResultsBuilder()

public DocumentChunk.Builder addResultsBuilder()

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
DocumentChunk.Builder

addResultsBuilder(int index)

public DocumentChunk.Builder addResultsBuilder(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.Builder

build()

public SearchDocumentChunksResponse build()
Returns
Type Description
SearchDocumentChunksResponse

buildPartial()

public SearchDocumentChunksResponse buildPartial()
Returns
Type Description
SearchDocumentChunksResponse

clear()

public SearchDocumentChunksResponse.Builder clear()
Returns
Type Description
SearchDocumentChunksResponse.Builder
Overrides

clearNextPageToken()

public SearchDocumentChunksResponse.Builder clearNextPageToken()

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
SearchDocumentChunksResponse.Builder

This builder for chaining.

clearResults()

public SearchDocumentChunksResponse.Builder clearResults()

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
SearchDocumentChunksResponse.Builder

getDefaultInstanceForType()

public SearchDocumentChunksResponse getDefaultInstanceForType()
Returns
Type Description
SearchDocumentChunksResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getNextPageToken()

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

getResultsBuilder(int index)

public DocumentChunk.Builder getResultsBuilder(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.Builder

getResultsBuilderList()

public List<DocumentChunk.Builder> getResultsBuilderList()

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

getResultsCount()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchDocumentChunksResponse other)

public SearchDocumentChunksResponse.Builder mergeFrom(SearchDocumentChunksResponse other)
Parameter
Name Description
other SearchDocumentChunksResponse
Returns
Type Description
SearchDocumentChunksResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchDocumentChunksResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchDocumentChunksResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchDocumentChunksResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchDocumentChunksResponse.Builder
Overrides

removeResults(int index)

public SearchDocumentChunksResponse.Builder removeResults(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
SearchDocumentChunksResponse.Builder

setNextPageToken(String value)

public SearchDocumentChunksResponse.Builder setNextPageToken(String value)

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];

Parameter
Name Description
value String

The nextPageToken to set.

Returns
Type Description
SearchDocumentChunksResponse.Builder

This builder for chaining.

setNextPageTokenBytes(ByteString value)

public SearchDocumentChunksResponse.Builder setNextPageTokenBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for nextPageToken to set.

Returns
Type Description
SearchDocumentChunksResponse.Builder

This builder for chaining.

setResults(int index, DocumentChunk value)

public SearchDocumentChunksResponse.Builder setResults(int index, DocumentChunk value)

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;

Parameters
Name Description
index int
value DocumentChunk
Returns
Type Description
SearchDocumentChunksResponse.Builder

setResults(int index, DocumentChunk.Builder builderForValue)

public SearchDocumentChunksResponse.Builder setResults(int index, DocumentChunk.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue DocumentChunk.Builder
Returns
Type Description
SearchDocumentChunksResponse.Builder