bindings

Creates, updates, deletes, gets or lists a bindings resource.

Overview

Name	bindings
Type	Resource
Id	google.dataplex.bindings

Fields

The following fields are returned by SELECT queries:

projects_locations_data_domains_bindings_get

Name	Datatype	Description
name	string	Identifier. The relative resource name of the DataDomainBinding. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{data_domain_id}/bindings/{binding_id}
createTime	string (google-datetime)	Output only. The time at which the DataDomainBinding was created.
resource	string	Required. Immutable. The full resource name of the Google Cloud resource to be bound (i.e. included together with its contents) to the DataDomain.Format: IAM Full resource name (https://docs.cloud.google.com/iam/docs/full-resource-names) Examples: - GCP Project: //cloudresourcemanager.googleapis.com/projects/{project-id} - BigQuery Dataset: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - BigQuery Table: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id}/tables/{table-id} - Dataplex Data Product: //dataplex.googleapis.com/projects/{project-number}/locations/{location}/dataProducts/{data-product-id}Authorization: the resource to be bound must first grant an IAM role with the resource-specific setIamPolicy permission to the DataDomain. Example: - resource: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - IAM role: with bigquery.datasets.setIamPolicy permission (e.g. roles/owner) - IAM member: principal://dataplex.googleapis.com/projects/{project-number}/name/locations/{location}/dataDomains/{data-domain-id}
uid	string	Output only. System-generated unique ID.

projects_locations_data_domains_bindings_list

Name	Datatype	Description
name	string	Identifier. The relative resource name of the DataDomainBinding. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{data_domain_id}/bindings/{binding_id}
createTime	string (google-datetime)	Output only. The time at which the DataDomainBinding was created.
resource	string	Required. Immutable. The full resource name of the Google Cloud resource to be bound (i.e. included together with its contents) to the DataDomain.Format: IAM Full resource name (https://docs.cloud.google.com/iam/docs/full-resource-names) Examples: - GCP Project: //cloudresourcemanager.googleapis.com/projects/{project-id} - BigQuery Dataset: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - BigQuery Table: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id}/tables/{table-id} - Dataplex Data Product: //dataplex.googleapis.com/projects/{project-number}/locations/{location}/dataProducts/{data-product-id}Authorization: the resource to be bound must first grant an IAM role with the resource-specific setIamPolicy permission to the DataDomain. Example: - resource: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - IAM role: with bigquery.datasets.setIamPolicy permission (e.g. roles/owner) - IAM member: principal://dataplex.googleapis.com/projects/{project-number}/name/locations/{location}/dataDomains/{data-domain-id}
uid	string	Output only. System-generated unique ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_data_domains_bindings_get	select	projectsId, locationsId, dataDomainsId, bindingsId		Retrieves a DataDomainBinding resource.
projects_locations_data_domains_bindings_list	select	projectsId, locationsId, dataDomainsId	filter, pageSize, orderBy, pageToken	Lists DataDomainBinding resources under a DataDomain.
projects_locations_data_domains_bindings_create	insert	projectsId, locationsId, dataDomainsId	dataDomainBindingId, validateOnly	Creates a DataDomainBinding resource.
projects_locations_data_domains_bindings_delete	delete	projectsId, locationsId, dataDomainsId, bindingsId		Deletes a DataDomainBinding resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bindingsId	string
dataDomainsId	string
locationsId	string
projectsId	string
dataDomainBindingId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
validateOnly	boolean

SELECT examples

projects_locations_data_domains_bindings_get

Retrieves a DataDomainBinding resource.

SELECT
name,
createTime,
resource,
uid
FROM google.dataplex.bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataDomainsId = '{{ dataDomainsId }}' -- required
AND bindingsId = '{{ bindingsId }}' -- required
;

projects_locations_data_domains_bindings_list

Lists DataDomainBinding resources under a DataDomain.

SELECT
name,
createTime,
resource,
uid
FROM google.dataplex.bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataDomainsId = '{{ dataDomainsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_data_domains_bindings_create

Creates a DataDomainBinding resource.

INSERT INTO google.dataplex.bindings (
data__resource,
data__name,
projectsId,
locationsId,
dataDomainsId,
dataDomainBindingId,
validateOnly
)
SELECT 
'{{ resource }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataDomainsId }}',
'{{ dataDomainBindingId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: bindings
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the bindings resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the bindings resource.
  - name: dataDomainsId
    value: "{{ dataDomainsId }}"
    description: Required parameter for the bindings resource.
  - name: resource
    value: "{{ resource }}"
    description: |
      Required. Immutable. The full resource name of the Google Cloud resource to be bound (i.e. included together with its contents) to the DataDomain.Format: IAM Full resource name (https://docs.cloud.google.com/iam/docs/full-resource-names) Examples: - GCP Project: //cloudresourcemanager.googleapis.com/projects/{project-id} - BigQuery Dataset: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - BigQuery Table: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id}/tables/{table-id} - Dataplex Data Product: //dataplex.googleapis.com/projects/{project-number}/locations/{location}/dataProducts/{data-product-id}Authorization: the resource to be bound must first grant an IAM role with the resource-specific setIamPolicy permission to the DataDomain. Example: - resource: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id} - IAM role: with bigquery.datasets.setIamPolicy permission (e.g. roles/owner) - IAM member: principal://dataplex.googleapis.com/projects/{project-number}/name/locations/{location}/dataDomains/{data-domain-id}
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The relative resource name of the DataDomainBinding. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{data_domain_id}/bindings/{binding_id}
  - name: dataDomainBindingId
    value: "{{ dataDomainBindingId }}"
  - name: validateOnly
    value: {{ validateOnly }}

DELETE examples

projects_locations_data_domains_bindings_delete

Deletes a DataDomainBinding resource.

DELETE FROM google.dataplex.bindings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataDomainsId = '{{ dataDomainsId }}' --required
AND bindingsId = '{{ bindingsId }}' --required
;