Vector Search v1 API - Class UpdateCollectionRequest (1.0.0-beta01) 

public sealed class UpdateCollectionRequest : IMessage<UpdateCollectionRequest>, IEquatable<UpdateCollectionRequest>, IDeepCloneable<UpdateCollectionRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Vector Search v1 API class UpdateCollectionRequest.

Message for updating a Collection

Inheritance

object > UpdateCollectionRequest

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

UpdateCollectionRequest()

public UpdateCollectionRequest()

UpdateCollectionRequest(UpdateCollectionRequest)

public UpdateCollectionRequest(UpdateCollectionRequest other)
Parameter
Name Description
other UpdateCollectionRequest

Properties

Collection

public Collection Collection { get; set; }

Required. The resource being updated

Property Value
Type Description
Collection

RequestId

public string RequestId { get; set; }

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).

Property Value
Type Description
string

UpdateMask

public FieldMask UpdateMask { get; set; }

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.

Property Value
Type Description
FieldMask