2023-11-21
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.create
Path: v1/{+parent}/dataPolicies
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies
HTTP Method: POST
Parameters:
parent
Description: Required. Resource name of the project that the data policy will belong to. The format is `projects/{project_number}/locations/{location_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new data policy under a project with the given `dataPolicyId` (used as the display name), policy tag, and data policy type.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: 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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes:
Description: Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.rename
Path: v1/{+name}:rename
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:rename
HTTP Method: POST
Parameters:
name
Description: Required. Resource name of the data policy to rename. The format is `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Renames the id (display name) of the specified data policy.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Resource name of the data policy to delete. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Deletes the data policy specified by its resource name.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}
HTTP Method: GET
Parameters:
name
Description: Required. Resource name of the requested data policy. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets the data policy specified by its resource name.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.list
Path: v1/{+parent}/dataPolicies
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies
HTTP Method: GET
Parameters:
parent
Description: Required. Resource name of the project for which to list data policies. Format is `projects/{project_number}/locations/{location_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.
Location: query
Type: integer
Format: int32
pageToken
Description: The `nextPageToken` value returned from a previous list request, if any. If not set, defaults to an empty string.
Location: query
Type: string
filter
Description: Filters the data policies by policy tags that they are associated with. Currently filter only supports "policy_tag" based filtering and OR based predicates. Sample filter can be "policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3". You may also use wildcard such as "policy_tag: projects/1/locations/us/taxonomies/2*". Please note that OR predicates cannot be used with wildcard filters.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: List all of the data policies in the specified parent project.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:getIamPolicy
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes:
Description: Gets the IAM policy for the specified data policy.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:setIamPolicy
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes:
Description: Sets the IAM policy for the specified data policy.
▼ ▲ bigquerydatapolicy.projects.locations.dataPolicies.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:testIamPermissions
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/dataPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes:
Description: Returns the caller's permission on the specified data policy resource.