Class SearchDocumentChunksRequest (0.3.0) 

public final class SearchDocumentChunksRequest extends GeneratedMessage implements SearchDocumentChunksRequestOrBuilder

Request message for DeveloperKnowledge.SearchDocumentChunks.

Protobuf type google.developers.knowledge.v1.SearchDocumentChunksRequest

Inheritance

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

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchDocumentChunksRequest getDefaultInstance()
Returns
Type Description
SearchDocumentChunksRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SearchDocumentChunksRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 SearchDocumentChunksRequest getDefaultInstanceForType()
Returns
Type Description
SearchDocumentChunksRequest

getFilter()

public String getFilter()

Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160.

While SearchDocumentChunks returns DocumentChunks, the filter is applied to DocumentChunk.document fields.

Supported fields for filtering:

  • data_source (STRING): The source of the document, e.g. docs.cloud.google.com. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus.
  • update_time (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata.

  • uri (STRING): The document URI, e.g. https://docs.cloud.google.com/bigquery/docs/tables.

    STRING fields support = (equals) and != (not equals) operators for exact match on the whole string. Partial match, prefix match, and regexp match are not supported.

    TIMESTAMP fields support =, <, <=, >, and >= operators. Timestamps must be in RFC-3339 format, e.g., "2025-01-01T00:00:00Z".

    Note: Field names must be in snake_case (e.g., data_source). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., "docs.cloud.google.com").

    You can combine expressions using AND, OR, and NOT (or -) logical operators. OR has higher precedence than AND. Use parentheses for explicit precedence grouping.

    Examples:

  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"

  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")

  • uri = "https://docs.cloud.google.com/release-notes"

    The filter string must not exceed 500 characters; values longer than 500 characters will result in an INVALID_ARGUMENT error.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160.

While SearchDocumentChunks returns DocumentChunks, the filter is applied to DocumentChunk.document fields.

Supported fields for filtering:

  • data_source (STRING): The source of the document, e.g. docs.cloud.google.com. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus.
  • update_time (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata.

  • uri (STRING): The document URI, e.g. https://docs.cloud.google.com/bigquery/docs/tables.

    STRING fields support = (equals) and != (not equals) operators for exact match on the whole string. Partial match, prefix match, and regexp match are not supported.

    TIMESTAMP fields support =, <, <=, >, and >= operators. Timestamps must be in RFC-3339 format, e.g., "2025-01-01T00:00:00Z".

    Note: Field names must be in snake_case (e.g., data_source). Values on the right-hand side of filtering expressions must be string literals enclosed in double quotes (e.g., "docs.cloud.google.com").

    You can combine expressions using AND, OR, and NOT (or -) logical operators. OR has higher precedence than AND. Use parentheses for explicit precedence grouping.

    Examples:

  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"

  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")

  • uri = "https://docs.cloud.google.com/release-notes"

    The filter string must not exceed 500 characters; values longer than 500 characters will result in an INVALID_ARGUMENT error.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.protobuf.ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. Specifies the maximum number of results to return. The service may return fewer than this value.

If unspecified, at most 5 results will be returned.

The maximum value is 100; values above 100 will be coerced to 100.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Contains a page token, received from a previous SearchDocumentChunks call. Provide this to retrieve the subsequent page.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Contains a page token, received from a previous SearchDocumentChunks call. Provide this to retrieve the subsequent page.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.protobuf.ByteString

The bytes for pageToken.

getParserForType()

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

getQuery()

public String getQuery()

Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.protobuf.ByteString

The bytes for query.

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 SearchDocumentChunksRequest.Builder newBuilderForType()
Returns
Type Description
SearchDocumentChunksRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

public SearchDocumentChunksRequest.Builder toBuilder()
Returns
Type Description
SearchDocumentChunksRequest.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