public final class SearchDocumentsRequest extends GeneratedMessageV3 implements SearchDocumentsRequestOrBuilder
Request message for DocumentService.SearchDocuments.
Protobuf type google.cloud.contentwarehouse.v1.SearchDocumentsRequest
Static Fields
DOCUMENT_QUERY_FIELD_NUMBER
public static final int DOCUMENT_QUERY_FIELD_NUMBER
Field Value
HISTOGRAM_QUERIES_FIELD_NUMBER
public static final int HISTOGRAM_QUERIES_FIELD_NUMBER
Field Value
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
QA_SIZE_LIMIT_FIELD_NUMBER
public static final int QA_SIZE_LIMIT_FIELD_NUMBER
Field Value
REQUEST_METADATA_FIELD_NUMBER
public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
REQUIRE_TOTAL_SIZE_FIELD_NUMBER
public static final int REQUIRE_TOTAL_SIZE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchDocumentsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchDocumentsRequest.Builder newBuilder()
Returns
newBuilder(SearchDocumentsRequest prototype)
public static SearchDocumentsRequest.Builder newBuilder(SearchDocumentsRequest prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static SearchDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchDocumentsRequest parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchDocumentsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static SearchDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static SearchDocumentsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchDocumentsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SearchDocumentsRequest getDefaultInstanceForType()
Returns
getDocumentQuery()
public DocumentQuery getDocumentQuery()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
getDocumentQueryOrBuilder()
public DocumentQueryOrBuilder getDocumentQueryOrBuilder()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
getHistogramQueries(int index)
public HistogramQuery getHistogramQueries(int index)
An expression specifying a histogram request against matching
documents. Expression syntax is an aggregation function call with
histogram facets and other options.
The following aggregation functions are supported:
count(string_histogram_facet): Count the number of matching entities
for each distinct attribute value.
Data types:- Histogram facet (aka filterable properties): Facet names with format
<schema id>.<facet>. Facets will have the
format of: a-zA-Z. If the facet is a child
facet, then the parent hierarchy needs to be specified separated by
dots in the prefix after the schema id. Thus, the format for a multi-
level facet is: <schema id>.<parent facet name>.
<child facet name>. Example:
schema123.root_parent_facet.middle_facet.child_facet
- DocumentSchemaId: (with no schema id prefix) to get
histograms for each document type (returns the schema id path, e.g.
projects/12345/locations/us-west/documentSchemas/abc123).
Example expression:
- Document type counts:
count('DocumentSchemaId')
- For schema id, abc123, get the counts for MORTGAGE_TYPE:
count('abc123.MORTGAGE_TYPE')
repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
| Name |
Description |
| index |
int
|
Returns
getHistogramQueriesCount()
public int getHistogramQueriesCount()
An expression specifying a histogram request against matching
documents. Expression syntax is an aggregation function call with
histogram facets and other options.
The following aggregation functions are supported:
count(string_histogram_facet): Count the number of matching entities
for each distinct attribute value.
Data types:- Histogram facet (aka filterable properties): Facet names with format
<schema id>.<facet>. Facets will have the
format of: a-zA-Z. If the facet is a child
facet, then the parent hierarchy needs to be specified separated by
dots in the prefix after the schema id. Thus, the format for a multi-
level facet is: <schema id>.<parent facet name>.
<child facet name>. Example:
schema123.root_parent_facet.middle_facet.child_facet
- DocumentSchemaId: (with no schema id prefix) to get
histograms for each document type (returns the schema id path, e.g.
projects/12345/locations/us-west/documentSchemas/abc123).
Example expression:
- Document type counts:
count('DocumentSchemaId')
- For schema id, abc123, get the counts for MORTGAGE_TYPE:
count('abc123.MORTGAGE_TYPE')
repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
getHistogramQueriesList()
public List<HistogramQuery> getHistogramQueriesList()
An expression specifying a histogram request against matching
documents. Expression syntax is an aggregation function call with
histogram facets and other options.
The following aggregation functions are supported:
count(string_histogram_facet): Count the number of matching entities
for each distinct attribute value.
Data types:- Histogram facet (aka filterable properties): Facet names with format
<schema id>.<facet>. Facets will have the
format of: a-zA-Z. If the facet is a child
facet, then the parent hierarchy needs to be specified separated by
dots in the prefix after the schema id. Thus, the format for a multi-
level facet is: <schema id>.<parent facet name>.
<child facet name>. Example:
schema123.root_parent_facet.middle_facet.child_facet
- DocumentSchemaId: (with no schema id prefix) to get
histograms for each document type (returns the schema id path, e.g.
projects/12345/locations/us-west/documentSchemas/abc123).
Example expression:
- Document type counts:
count('DocumentSchemaId')
- For schema id, abc123, get the counts for MORTGAGE_TYPE:
count('abc123.MORTGAGE_TYPE')
repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
getHistogramQueriesOrBuilder(int index)
public HistogramQueryOrBuilder getHistogramQueriesOrBuilder(int index)
An expression specifying a histogram request against matching
documents. Expression syntax is an aggregation function call with
histogram facets and other options.
The following aggregation functions are supported:
count(string_histogram_facet): Count the number of matching entities
for each distinct attribute value.
Data types:- Histogram facet (aka filterable properties): Facet names with format
<schema id>.<facet>. Facets will have the
format of: a-zA-Z. If the facet is a child
facet, then the parent hierarchy needs to be specified separated by
dots in the prefix after the schema id. Thus, the format for a multi-
level facet is: <schema id>.<parent facet name>.
<child facet name>. Example:
schema123.root_parent_facet.middle_facet.child_facet
- DocumentSchemaId: (with no schema id prefix) to get
histograms for each document type (returns the schema id path, e.g.
projects/12345/locations/us-west/documentSchemas/abc123).
Example expression:
- Document type counts:
count('DocumentSchemaId')
- For schema id, abc123, get the counts for MORTGAGE_TYPE:
count('abc123.MORTGAGE_TYPE')
repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
| Name |
Description |
| index |
int
|
Returns
getHistogramQueriesOrBuilderList()
public List<? extends HistogramQueryOrBuilder> getHistogramQueriesOrBuilderList()
An expression specifying a histogram request against matching
documents. Expression syntax is an aggregation function call with
histogram facets and other options.
The following aggregation functions are supported:
count(string_histogram_facet): Count the number of matching entities
for each distinct attribute value.
Data types:- Histogram facet (aka filterable properties): Facet names with format
<schema id>.<facet>. Facets will have the
format of: a-zA-Z. If the facet is a child
facet, then the parent hierarchy needs to be specified separated by
dots in the prefix after the schema id. Thus, the format for a multi-
level facet is: <schema id>.<parent facet name>.
<child facet name>. Example:
schema123.root_parent_facet.middle_facet.child_facet
- DocumentSchemaId: (with no schema id prefix) to get
histograms for each document type (returns the schema id path, e.g.
projects/12345/locations/us-west/documentSchemas/abc123).
Example expression:
- Document type counts:
count('DocumentSchemaId')
- For schema id, abc123, get the counts for MORTGAGE_TYPE:
count('abc123.MORTGAGE_TYPE')
repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;
| Type |
Description |
| List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder> |
|
getOffset()
An integer that specifies the current offset (that is, starting result
location, amongst the documents deemed by the API as relevant) in search
results. This field is only considered if page_token is unset.
The maximum allowed value is 5000. Otherwise an error is thrown.
For example, 0 means to return results starting from the first matching
document, and 10 means to return from the 11th document. This can be used
for pagination, (for example, pageSize = 10 and offset = 10 means to return
from the second page).
int32 offset = 5;
| Type |
Description |
| int |
The offset.
|
getOrderBy()
public String getOrderBy()
The criteria determining how search results are sorted. For non-empty
query, default is "relevance desc". For empty query, default is
"upload_date desc".
Supported options are:
"relevance desc": By relevance descending, as determined by the API
algorithms."upload_date desc": By upload date descending."upload_date": By upload date ascending."update_date desc": By last updated date descending."update_date": By last updated date ascending.
string order_by = 8;
| Type |
Description |
| String |
The orderBy.
|
getOrderByBytes()
public ByteString getOrderByBytes()
The criteria determining how search results are sorted. For non-empty
query, default is "relevance desc". For empty query, default is
"upload_date desc".
Supported options are:
"relevance desc": By relevance descending, as determined by the API
algorithms."upload_date desc": By upload date descending."upload_date": By upload date ascending."update_date desc": By last updated date descending."update_date": By last updated date ascending.
string order_by = 8;
| Type |
Description |
| ByteString |
The bytes for orderBy.
|
getPageSize()
A limit on the number of documents returned in the search results.
Increasing this value above the default value of 10 can increase search
response time. The value can be between 1 and 100.
int32 page_size = 6;
| Type |
Description |
| int |
The pageSize.
|
getPageToken()
public String getPageToken()
The token specifying the current offset within search results.
See SearchDocumentsResponse.next_page_token for an explanation of how
to obtain the next set of query results.
string page_token = 7;
| Type |
Description |
| String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
The token specifying the current offset within search results.
See SearchDocumentsResponse.next_page_token for an explanation of how
to obtain the next set of query results.
string page_token = 7;
| Type |
Description |
| ByteString |
The bytes for pageToken.
|
getParent()
public String getParent()
Required. The parent, which owns this collection of documents.
Format: projects/{project_number}/locations/{location}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type |
Description |
| String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The parent, which owns this collection of documents.
Format: projects/{project_number}/locations/{location}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<SearchDocumentsRequest> getParserForType()
Returns
Overrides
getQaSizeLimit()
public int getQaSizeLimit()
Experimental, do not use.
The limit on the number of documents returned for the question-answering
feature. To enable the question-answering feature, set
[DocumentQuery].[is_nl_query][] to true.
int32 qa_size_limit = 11;
| Type |
Description |
| int |
The qaSizeLimit.
|
getRequestMetadata()
public RequestMetadata getRequestMetadata()
The meta information collected about the end user, used to enforce access
control and improve the search quality of the service.
.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
getRequestMetadataOrBuilder()
public RequestMetadataOrBuilder getRequestMetadataOrBuilder()
The meta information collected about the end user, used to enforce access
control and improve the search quality of the service.
.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
getRequireTotalSize()
public boolean getRequireTotalSize()
Optional. Controls if the search document request requires the return of a total size
of matched documents. See SearchDocumentsResponse.total_size.
Enabling this flag may adversely impact performance. Hint: If this is
used with pagination, set this flag on the initial query but set this
to false on subsequent page calls (keep the total count locally).
Defaults to false.
bool require_total_size = 10;
| Type |
Description |
| boolean |
The requireTotalSize.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDocumentQuery()
public boolean hasDocumentQuery()
Query used to search against documents (keyword, filters, etc.).
.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;
| Type |
Description |
| boolean |
Whether the documentQuery field is set.
|
hasRequestMetadata()
public boolean hasRequestMetadata()
The meta information collected about the end user, used to enforce access
control and improve the search quality of the service.
.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;
| Type |
Description |
| boolean |
Whether the requestMetadata field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchDocumentsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchDocumentsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
