Reference documentation and code samples for the Google Cloud Vector Search V1 Client class Collection.
Message describing Collection object
Generated from protobuf message google.cloud.vectorsearch.v1.Collection
Namespace
Google \ Cloud \ VectorSearch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. name of resource |
↳ display_name |
string
Optional. User-specified display name of the collection |
↳ description |
string
Optional. User-specified description of the collection |
↳ create_time |
Google\Protobuf\Timestamp
Output only. [Output only] Create time stamp |
↳ update_time |
Google\Protobuf\Timestamp
Output only. [Output only] Update time stamp |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels as key value pairs. |
↳ vector_schema |
array|Google\Protobuf\Internal\MapField
Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens. |
↳ data_schema |
Google\Protobuf\Struct
Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens. |
getName
Identifier. name of resource
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. name of resource
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. User-specified display name of the collection
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. User-specified display name of the collection
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. User-specified description of the collection
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. User-specified description of the collection
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. [Output only] Create time stamp
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. [Output only] Create time stamp
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. [Output only] Update time stamp
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. [Output only] Update time stamp
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels as key value pairs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels as key value pairs.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVectorSchema
Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setVectorSchema
Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataSchema
Optional. JSON Schema for data.
Field names must contain only alphanumeric characters, underscores, and hyphens.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasDataSchema
clearDataSchema
setDataSchema
Optional. JSON Schema for data.
Field names must contain only alphanumeric characters, underscores, and hyphens.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|