Google Cloud Vision Ai V1 Client - Class UpdateCollectionRequest (0.1.0)

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

Request message for UpdateCollectionRequest.

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

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ collection Collection

Required. The collection to update. The collection's name field is used to identify the collection to be updated. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}
↳ update_mask Google\Protobuf\FieldMask

The list of fields to be updated. - Unset update_mask or set update_mask to be a single "*" only will update all updatable fields with the value provided in collection. - To update display_name value to empty string, set it in the collection to empty string, and set update_mask with "display_name". Same applies to other updatable string fields in the collection.

getCollection

Required. The collection to update.

The collection's name field is used to identify the collection to be updated. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

Returns
Type Description
Collection|null

hasCollection

clearCollection

setCollection

Required. The collection to update.

The collection's name field is used to identify the collection to be updated. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

Parameter
Name Description
var Collection
Returns
Type Description
$this

getUpdateMask

The list of fields to be updated.

  • Unset update_mask or set update_mask to be a single "*" only will update all updatable fields with the value provided in collection.
  • To update display_name value to empty string, set it in the collection to empty string, and set update_mask with "display_name". Same applies to other updatable string fields in the collection.
Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

The list of fields to be updated.

  • Unset update_mask or set update_mask to be a single "*" only will update all updatable fields with the value provided in collection.
  • To update display_name value to empty string, set it in the collection to empty string, and set update_mask with "display_name". Same applies to other updatable string fields in the collection.
Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this