2022-11-16
▼ ▲ dataplex.projects.locations.dataTaxonomies.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Parameters:
resource
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Location: path
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.
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Format: int32
Type: integer
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:getIamPolicy
▼ ▲ dataplex.projects.locations.dataTaxonomies.setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$
Required: Yes
Type: string
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.
Location: path
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameter Order: resource
▼ ▲ dataplex.projects.locations.dataTaxonomies.testIamPermissions
Parameters:
resource
Type: string
Location: path
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/[^/]+/dataTaxonomies/[^/]+$
Required: Yes
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:testIamPermissions
HTTP Method: POST
Parameter Order: resource
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.setIamPolicy
Parameter Order: resource
Path: v1/{+resource}:setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
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.
Required: Yes
Type: string
Location: path
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:setIamPolicy
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Path: v1/{+resource}:getIamPolicy
Parameters:
options.requestedPolicyVersion
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Format: int32
resource
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
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.
Location: path
Required: Yes
Type: string
HTTP Method: GET
▼ ▲ dataplex.projects.locations.dataTaxonomies.attributes.testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:testIamPermissions
Path: v1/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$
Location: path
Type: string
▼ ▲ dataplex.projects.locations.dataAttributeBindings.testIamPermissions
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:testIamPermissions
Parameters:
resource
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Required: Yes
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ dataplex.projects.locations.dataAttributeBindings.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Parameters:
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Type: integer
Location: query
resource
Required: Yes
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.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Location: path
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
HTTP Method: GET
Path: v1/{+resource}:getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:getIamPolicy
▼ ▲ dataplex.projects.locations.dataAttributeBindings.setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Parameter Order: resource
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$
Required: Yes
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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
▼ ▲ dataplex.projects.locations.dataScans.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameters:
resource
Type: string
Required: Yes
Location: path
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/[^/]+/dataScans/[^/]+$
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:testIamPermissions
HTTP Method: POST
▼ ▲ dataplex.projects.locations.dataScans.getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
options.requestedPolicyVersion
Location: query
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
HTTP Method: GET
▼ ▲ dataplex.projects.locations.dataScans.create
HTTP Method: POST
Path: v1/{+parent}/dataScans
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource name of the parent location: projects/{project}/locations/{location_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.
Type: string
dataScanId
Type: string
Description: Required. DataScan identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a dataScan resource.
▼ ▲ dataplex.projects.locations.dataScans.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:setIamPolicy
Parameter Order: resource
Parameters:
resource
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
Location: path
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.
Path: v1/{+resource}:setIamPolicy
HTTP Method: POST
▼ ▲ dataplex.projects.locations.dataScans.get
Path: v1/{+name}
Description: Get dataScan resource.
Parameters:
name
Description: Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
Type: string
Location: path
Required: Yes
view
Type: string
Enum Descriptions:
Enum:
Description: Optional. Used to select the subset of DataScan information to return. Defaults to BASIC.
Location: query
HTTP Method: GET
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}
▼ ▲ dataplex.projects.locations.dataScans.run
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:run
Description: Run an on demand execution of a DataScan.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
Required: Yes
Description: Required. The resource name of the DataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region. Only on-demand DataScans are allowed.
Path: v1/{+name}:run
▼ ▲ dataplex.projects.locations.dataScans.patch
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}
Parameters:
name
Type: string
Description: Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}. where {project} refers to a project_id or project_number and location_id refers to a GCP region.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
updateMask
Location: query
Type: string
Format: google-fieldmask
Description: Required. Mask of fields to update.
Description: Update the dataScan resource.
▼ ▲ dataplex.projects.locations.dataScans.list
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. projects/{project}/locations/{location_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.
Required: Yes
Location: path
Type: string
pageToken
Type: string
Location: query
Description: Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token.
pageSize
Location: query
Format: int32
Type: integer
Description: Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 10 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
orderBy
Type: string
Location: query
Description: Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
filter
Type: string
Location: query
Description: Optional. Filter request.
Path: v1/{+parent}/dataScans
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Lists dataScans.
▼ ▲ dataplex.projects.locations.dataScans.delete
Parameters:
name
Required: Yes
Description: Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
Location: path
Path: v1/{+name}
HTTP Method: DELETE
Description: Delete the dataScan resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}
▼ ▲ dataplex.projects.locations.dataScans.jobs.list
Path: v1/{+parent}/jobs
HTTP Method: GET
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Description: Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token.
Location: query
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$
Required: Yes
Description: Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.
Location: path
Type: string
pageSize
Location: query
Type: integer
Description: Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format: int32
Description: Lists DataScanJobs under the given dataScan.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs
▼ ▲ dataplex.projects.locations.dataScans.jobs.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}
Description: Get DataScanJob resource.
Path: v1/{+name}
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Type: string
Description: Required. The resource name of the DataScanJob: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id} where {project} refers to a project_id or project_number and location_id refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$
view
Type: string
Enum Descriptions:
Enum:
Location: query
Description: Optional. Used to select the subset of DataScan information to return. Defaults to BASIC.
Parameter Order: name