Reference documentation and code samples for the Google Cloud Vector Search V1 Client class QueryDataObjectsRequest.
Request message for DataObjectSearchService.QueryDataObjects.
Generated from protobuf message google.cloud.vectorsearch.v1.QueryDataObjectsRequest
Namespace
Google \ Cloud \ VectorSearch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the Collection for which to query. Format: |
↳ filter |
Google\Protobuf\Struct
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct. |
↳ output_fields |
OutputFields
Optional. Mask specifying which fields to return. |
↳ page_size |
int
Optional. The standard list page size. Default is 100. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call. |
getParent
Required. The resource name of the Collection for which to query.
Format: projects/{project}/locations/{location}/collections/{collection}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the Collection for which to query.
Format: projects/{project}/locations/{location}/collections/{collection}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasFilter
clearFilter
setFilter
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputFields
Optional. Mask specifying which fields to return.
| Returns | |
|---|---|
| Type | Description |
OutputFields|null |
|
hasOutputFields
clearOutputFields
setOutputFields
Optional. Mask specifying which fields to return.
| Parameter | |
|---|---|
| Name | Description |
var |
OutputFields
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The standard list page size. Default is 100.
The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The standard list page size. Default is 100.
The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. The standard list page token.
Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. The standard list page token.
Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|