Reference documentation and code samples for the Google Cloud Vector Search V1 Client class DataObject.
A dataObject resource in Vector Search.
Generated from protobuf message google.cloud.vectorsearch.v1.DataObject
Namespace
Google \ Cloud \ VectorSearch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The fully qualified resource name of the dataObject. Format: |
↳ data_object_id |
string
Output only. The id of the dataObject. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp the dataObject was created at. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp the dataObject was last updated. |
↳ data |
Google\Protobuf\Struct
Optional. The data of the dataObject. |
↳ vectors |
array|Google\Protobuf\Internal\MapField
Optional. The vectors of the dataObject. |
↳ etag |
string
Optional. The etag of the dataObject. |
getName
Identifier. The fully qualified resource name of the dataObject.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id}
The data_object_id must be 1-63 characters
long, and comply with RFC1035.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The fully qualified resource name of the dataObject.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataObjects/{data_object_id}
The data_object_id must be 1-63 characters
long, and comply with RFC1035.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataObjectId
Output only. The id of the dataObject.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDataObjectId
Output only. The id of the dataObject.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp the dataObject was created at.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp the dataObject was created at.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp the dataObject was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp the dataObject was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getData
Optional. The data of the dataObject.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasData
clearData
setData
Optional. The data of the dataObject.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVectors
Optional. The vectors of the dataObject.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setVectors
Optional. The vectors of the dataObject.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. The etag of the dataObject.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. The etag of the dataObject.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|