Reference documentation and code samples for the Google Cloud Vector Search V1 Client class UpdateCollectionRequest.
Message for updating a Collection
Generated from protobuf message google.cloud.vectorsearch.v1.UpdateCollectionRequest
Namespace
Google \ Cloud \ VectorSearch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ update_mask |
Google\Protobuf\FieldMask
Optional. Field mask is used to specify the fields to be overwritten in the Collection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The following fields support update: |
↳ collection |
Collection
Required. The resource being updated |
↳ request_id |
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
getUpdateMask
Optional. Field mask is used to specify the fields to be overwritten in the Collection resource by the update.
The fields specified in the update_mask are relative to the resource, not
the full request. A field will be overwritten if it is in the mask. If the
user does not provide a mask then all fields present in the request will be
overwritten.
The following fields support update: display_name, description,
labels, data_schema, vector_schema.
For data_schema and vector_schema, fields can only be added, not
deleted, but vertex_embedding_config in vector_schema can be added or
removed.
Partial updates for data_schema and vector_schema are also supported
by using sub-field paths in update_mask, e.g.
data_schema.properties.foo or vector_schema.my_vector_field.
If * is provided in the update_mask, full replacement will be performed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasUpdateMask
clearUpdateMask
setUpdateMask
Optional. Field mask is used to specify the fields to be overwritten in the Collection resource by the update.
The fields specified in the update_mask are relative to the resource, not
the full request. A field will be overwritten if it is in the mask. If the
user does not provide a mask then all fields present in the request will be
overwritten.
The following fields support update: display_name, description,
labels, data_schema, vector_schema.
For data_schema and vector_schema, fields can only be added, not
deleted, but vertex_embedding_config in vector_schema can be added or
removed.
Partial updates for data_schema and vector_schema are also supported
by using sub-field paths in update_mask, e.g.
data_schema.properties.foo or vector_schema.my_vector_field.
If * is provided in the update_mask, full replacement will be performed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCollection
Required. The resource being updated
| Returns | |
|---|---|
| Type | Description |
Collection|null |
|
hasCollection
clearCollection
setCollection
Required. The resource being updated
| Parameter | |
|---|---|
| Name | Description |
var |
Collection
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Returns | |
|---|---|
| Type | Description |
string |
|
setRequestId
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
collection |
Collection
Required. The resource being updated |
updateMask |
Google\Protobuf\FieldMask
Optional. Field mask is used to specify the fields to be overwritten in the Collection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The following fields support update: If |
| Returns | |
|---|---|
| Type | Description |
UpdateCollectionRequest |
|