Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::UpdateIndexRequest (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::UpdateIndexRequest.

Message for updating an Index.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#index

def index() -> ::Google::Cloud::VectorSearch::V1::Index

Returns

• (::Google::Cloud::VectorSearch::V1::Index) — Required. The resource being updated.

#index=

def index=(value) -> ::Google::Cloud::VectorSearch::V1::Index

Parameter

• value (::Google::Cloud::VectorSearch::V1::Index) — Required. The resource being updated.

Returns

• (::Google::Cloud::VectorSearch::V1::Index) — Required. The resource being updated.

#request_id

def request_id() -> ::String

Returns

• (::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).

#request_id=

def request_id=(value) -> ::String

Parameter

• value (::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).

Returns

• (::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).

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask

Returns

• (::Google::Protobuf::FieldMask) — 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.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

• value (::Google::Protobuf::FieldMask) — 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.

Returns

• (::Google::Protobuf::FieldMask) — 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.