Class SearchDocumentChunksResponse (0.3.0)

public final class SearchDocumentChunksResponse extends GeneratedMessage implements SearchDocumentChunksResponseOrBuilder

Response message for DeveloperKnowledge.SearchDocumentChunks.

Protobuf type google.developers.knowledge.v1.SearchDocumentChunksResponse

Inheritance

Object > com.google.protobuf.AbstractMessageLite > com.google.protobuf.AbstractMessage > com.google.protobuf.GeneratedMessage > SearchDocumentChunksResponse

Static Fields

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchDocumentChunksResponse getDefaultInstance()
Returns
Type Description
SearchDocumentChunksResponse

getDescriptor()

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

newBuilder()

public static SearchDocumentChunksResponse.Builder newBuilder()
Returns
Type Description
SearchDocumentChunksResponse.Builder

newBuilder(SearchDocumentChunksResponse prototype)

public static SearchDocumentChunksResponse.Builder newBuilder(SearchDocumentChunksResponse prototype)
Parameter
Name Description
prototype SearchDocumentChunksResponse
Returns
Type Description
SearchDocumentChunksResponse.Builder

parseDelimitedFrom(InputStream input)

public static SearchDocumentChunksResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentChunksResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchDocumentChunksResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentChunksResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchDocumentChunksResponse parseFrom(ByteString data)
Parameter
Name Description
data com.google.protobuf.ByteString
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentChunksResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data com.google.protobuf.ByteString
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchDocumentChunksResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input com.google.protobuf.CodedInputStream
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentChunksResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input com.google.protobuf.CodedInputStream
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchDocumentChunksResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentChunksResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchDocumentChunksResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchDocumentChunksResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
SearchDocumentChunksResponse
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parser()

public static Parser<SearchDocumentChunksResponse> parser()
Returns
Type Description
com.google.protobuf.Parser<SearchDocumentChunksResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides
com.google.protobuf.AbstractMessage.equals(java.lang.Object)

getDefaultInstanceForType()

public SearchDocumentChunksResponse getDefaultInstanceForType()
Returns
Type Description
SearchDocumentChunksResponse

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

The bytes for nextPageToken.

getParserForType()

public Parser<SearchDocumentChunksResponse> getParserForType()
Returns
Type Description
com.google.protobuf.Parser<SearchDocumentChunksResponse>
Overrides
com.google.protobuf.GeneratedMessage.getParserForType()

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

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides
com.google.protobuf.GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides
com.google.protobuf.AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
com.google.protobuf.GeneratedMessage.FieldAccessorTable
Overrides
com.google.protobuf.GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
com.google.protobuf.GeneratedMessage.isInitialized()

newBuilderForType()

public SearchDocumentChunksResponse.Builder newBuilderForType()
Returns
Type Description
SearchDocumentChunksResponse.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchDocumentChunksResponse.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent com.google.protobuf.AbstractMessage.BuilderParent
Returns
Type Description
SearchDocumentChunksResponse.Builder
Overrides
com.google.protobuf.AbstractMessage.newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent)

toBuilder()

public SearchDocumentChunksResponse.Builder toBuilder()
Returns
Type Description
SearchDocumentChunksResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output com.google.protobuf.CodedOutputStream
Overrides
com.google.protobuf.GeneratedMessage.writeTo(com.google.protobuf.CodedOutputStream)
Exceptions
Type Description
IOException