Google Cloud Vision Ai V1 Client - Class UpdateIndexRequest (0.3.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class UpdateIndexRequest.

Request message for UpdateIndex.

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

Namespace

Google \ Cloud \ VisionAI \ 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` Required. Field mask is used to specify 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 of the resource will be overwritten if it is in the mask. Empty field mask is not allowed. If the mask is "*", it triggers a full update of the index, and also a whole rebuild of index data.

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

Required. Field mask is used to specify 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 of the resource will be overwritten if it is in the mask. Empty field mask is not allowed.

If the mask is "*", it triggers a full update of the index, and also a whole rebuild of index data.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask