Vector Search v1 API - Class UpdateIndexRequest (1.0.0-beta05) 

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

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

Message for updating an Index.

Inheritance

object > UpdateIndexRequest

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

UpdateIndexRequest()

public UpdateIndexRequest()

UpdateIndexRequest(UpdateIndexRequest)

public UpdateIndexRequest(UpdateIndexRequest other)
Parameter
Name Description
other UpdateIndexRequest

Properties

Index

public Index Index { get; set; }

Required. The resource being updated.

Property Value
Type Description
Index

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. Specifies the fields to be overwritten in the Index 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 with non-empty values will be overwritten.

The following fields support update:

  • display_name
  • description
  • labels
  • dedicated_infrastructure.autoscaling_spec.min_replica_count
  • dedicated_infrastructure.autoscaling_spec.max_replica_count

If * is provided in the update_mask, full replacement of mutable fields will be performed.

Property Value
Type Description
FieldMask