Method: visualFamilies.patch

Full name: projects.locations.instances.ontologyRecords.visualFamilies.patch

Updates a VisualFamily.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1beta/{visualFamily.name}

Path parameters

Parameters
visualFamily.name

string

Output only. Identifier. The resource name of the VisualFamily. Format: projects/{project}/locations/{location}/instances/{instance}/ontologyRecords/{ontologyRecord}/visualFamilies/{visualFamily}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update. If not included, all fields with a non-empty value will be overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of VisualFamily.

Response body

If successful, the response body contains an instance of VisualFamily.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.visualFamilies.update

For more information, see the IAM documentation.