v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13101838.5 KB
projects

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

patch/v2/{+name}

Path parameters

namestring required

Identifier. Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

Query parameters

allowMissingboolean

Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored.

updateMaskstring

Optional. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. Updates to the name and dataPolicyId fields are not allowed.

Request body

granteesstring[]

Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy. Uses the IAM V2 principal syntax Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.

version'VERSION_UNSPECIFIED' | 'V1' | 'V2'

Output only. The version of the Data Policy resource.

policyTagstring

Output only. Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}. policy_tag is supported only for V1 data policies.

etagstring

The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.

dataPolicyType'DATA_POLICY_TYPE_UNSPECIFIED' | 'DATA_MASKING_POLICY' | 'RAW_DATA_ACCESS_POLICY' | 'COLUMN_LEVEL_SECURITY_POLICY'

Required. Type of data policy.

namestring

Identifier. Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

dataPolicyIdstring

Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.

Response

Successful response