REST Resource: projects.locations.dataDomains

Resource: DataDomain

A DataDomain is a logical grouping of data resources for governance, discovery, and management at scale.

JSON representation
{
  "name": string,
  "uid": string,
  "displayName": string,
  "description": string,
  "parentDataDomain": string,
  "labels": {
    string: string,
    ...
  },
  "contacts": {
    object (Contacts)
  },
  "policyMember": {
    object (ResourcePolicyMember)
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{locationId}/dataDomains/{dataDomainId}

uid

string

Output only. System-generated globally unique ID for the DataDomain.

displayName

string

Required. User-friendly display name.

description

string

Optional. User-provided description of 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.

labels

map (key: string, value: string)

Optional. User-defined labels for the DataDomain.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

contacts

object (Contacts)

Required. Contact info for the Data Domains.

policyMember

object (ResourcePolicyMember)

Output only. Output-only policy member strings of this resource.

createTime

string (Timestamp format)

Output only. The time at which the DataDomain was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time at which the DataDomain was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Contacts

Business contacts part of business context of a Data Domain. Corresponds to the Contacts Aspect in Dataplex Universal Catalog.

JSON representation
{
  "identities": [
    {
      object (ContactIdentity)
    }
  ]
}
Fields
identities[]

object (ContactIdentity)

Required. Identities of the business contacts.

ContactIdentity

Identity of a business contact.

JSON representation
{
  "contactName": string,
  "contactRole": string,
  "contactId": string
}
Fields
contactName

string

Required. Name of the contact person for the Data Domain; unvalidated freeform text.

contactRole

string

Required. Designation of the person i.e. Data Steward or Data Analyst. Example values: owner, steward, producer, admin.

contactId

string

Optional. Email ID or freeform ID of the Contact person.

ResourcePolicyMember

Output-only policy member strings of a Google Cloud resource's built-in identity.

JSON representation
{
  "iamPolicyNamePrincipal": string,
  "iamPolicyUidPrincipal": string
}
Fields
iamPolicyNamePrincipal

string

Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource.

Example: principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter

iamPolicyUidPrincipal

string

Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource

Example: principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5

Methods

create

Creates a DataDomain resource.

delete

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

get

Retrieves a DataDomain resource.

list

Lists DataDomain resources in a project and location.

patch

Updates a DataDomain resource.