Method: calculatedFieldDefinitions.patch

Full name: projects.locations.instances.calculatedFieldDefinitions.patch

Update a CalculatedFieldDefinition.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{calculatedFieldDefinition.name}

Path parameters

Parameters
calculatedFieldDefinition.name

string

Identifier. The resource name of the CalculatedFieldDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/calculatedFieldDefinitions/{calculatedFieldDefinition}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Update mask.

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 CalculatedFieldDefinition.

Response body

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

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.calculatedFieldDefinitions.update

For more information, see the IAM documentation.