data_domains

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

Overview

Name	data_domains
Type	Resource
Id	google.dataplex.data_domains

Fields

The following fields are returned by SELECT queries:

projects_locations_data_domains_get

Name	Datatype	Description
name	string	Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id}
contacts	object	Required. Contact info for the Data Domains. (id: GoogleCloudDataplexV1Contacts)
createTime	string (google-datetime)	Output only. The time at which the DataDomain was created.
description	string	Optional. User-provided description of the DataDomain.
displayName	string	Required. User-friendly display name.
labels	object	Optional. User-defined labels for the DataDomain.
parentDataDomain	string	Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation.
policyMember	object	Output only. Output-only policy member strings of this resource. (id: GoogleIamV1ResourcePolicyMember)
uid	string	Output only. System-generated globally unique ID for the DataDomain.
updateTime	string (google-datetime)	Output only. The time at which the DataDomain was last updated.

projects_locations_data_domains_list

Name	Datatype	Description
name	string	Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id}
contacts	object	Required. Contact info for the Data Domains. (id: GoogleCloudDataplexV1Contacts)
createTime	string (google-datetime)	Output only. The time at which the DataDomain was created.
description	string	Optional. User-provided description of the DataDomain.
displayName	string	Required. User-friendly display name.
labels	object	Optional. User-defined labels for the DataDomain.
parentDataDomain	string	Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation.
policyMember	object	Output only. Output-only policy member strings of this resource. (id: GoogleIamV1ResourcePolicyMember)
uid	string	Output only. System-generated globally unique ID for the DataDomain.
updateTime	string (google-datetime)	Output only. The time at which the DataDomain was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_data_domains_get	select	projectsId, locationsId, dataDomainsId		Retrieves a DataDomain resource.
projects_locations_data_domains_list	select	projectsId, locationsId	pageToken, pageSize, orderBy, filter	Lists DataDomain resources in a project and location.
projects_locations_data_domains_create	insert	projectsId, locationsId	dataDomainId, validateOnly	Creates a DataDomain resource.
projects_locations_data_domains_patch	update	projectsId, locationsId, dataDomainsId	updateMask, validateOnly	Updates a DataDomain resource.
projects_locations_data_domains_delete	delete	projectsId, locationsId, dataDomainsId		Deletes a DataDomain resource (allowed only when there are no bindings).

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
dataDomainsId	string
locationsId	string
projectsId	string
dataDomainId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_data_domains_get

Retrieves a DataDomain resource.

SELECT
name,
contacts,
createTime,
description,
displayName,
labels,
parentDataDomain,
policyMember,
uid,
updateTime
FROM google.dataplex.data_domains
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataDomainsId = '{{ dataDomainsId }}' -- required
;

projects_locations_data_domains_list

Lists DataDomain resources in a project and location.

SELECT
name,
contacts,
createTime,
description,
displayName,
labels,
parentDataDomain,
policyMember,
uid,
updateTime
FROM google.dataplex.data_domains
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
;

INSERT examples

projects_locations_data_domains_create

Creates a DataDomain resource.

INSERT INTO google.dataplex.data_domains (
data__labels,
data__contacts,
data__displayName,
data__parentDataDomain,
data__name,
data__description,
projectsId,
locationsId,
dataDomainId,
validateOnly
)
SELECT 
'{{ labels }}',
'{{ contacts }}',
'{{ displayName }}',
'{{ parentDataDomain }}',
'{{ name }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataDomainId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: data_domains
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the data_domains resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the data_domains resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels for the DataDomain.
  - name: contacts
    description: |
      Required. Contact info for the Data Domains.
    value:
      identities:
        - contactRole: "{{ contactRole }}"
          contactName: "{{ contactName }}"
          contactId: "{{ contactId }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. User-friendly display name.
  - name: parentDataDomain
    value: "{{ parentDataDomain }}"
    description: |
      Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id}
  - name: description
    value: "{{ description }}"
    description: |
      Optional. User-provided description of the DataDomain.
  - name: dataDomainId
    value: "{{ dataDomainId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

projects_locations_data_domains_patch

Updates a DataDomain resource.

UPDATE google.dataplex.data_domains
SET 
data__labels = '{{ labels }}',
data__contacts = '{{ contacts }}',
data__displayName = '{{ displayName }}',
data__parentDataDomain = '{{ parentDataDomain }}',
data__name = '{{ name }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataDomainsId = '{{ dataDomainsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_data_domains_delete

Deletes a DataDomain resource (allowed only when there are no bindings).

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