Google Cloud Vector Search V1 Client - Class UpdateIndexRequest (0.4.0)

Reference documentation and code samples for the Google Cloud Vector Search V1 Client class UpdateIndexRequest.

Message for updating an Index.

Generated from protobuf message google.cloud.vectorsearch.v1.UpdateIndexRequest

Namespace

Google \ Cloud \ VectorSearch \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ index Index

Required. The resource being updated.
↳ update_mask 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.
↳ 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).

getIndex

Required. The resource being updated.

Returns
Type Description
Index|null

hasIndex

clearIndex

setIndex

Required. The resource being updated.

Parameter
Name Description
var Index
Returns
Type Description
$this

getUpdateMask

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
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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.
Parameter
Name Description
var Google\Protobuf\FieldMask
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
index Index

Required. The resource being updated.
updateMask 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
Type Description
UpdateIndexRequest