Guidelines to name a Knowledge Catalog resource

A Google Cloud resource is any component that you create or use within Google Cloud. These resources form the building blocks of your applications and systems running on the platform.

Resources in Knowledge Catalog include the following:

  • Entry group

  • Entry

  • Entry type

  • Aspect type

  • Entry link

  • Metadata job

  • Metadata feed

  • Glossary

  • Glossary category

  • Glossary term

  • Data product

  • Data domain

  • Lineage process

  • Lineage run

  • Lineage event

For more information on general Google Cloud resource naming, see Resource names.

Resource naming format

Here are the formats for the different resources:

  • Entry group: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}

  • Entry: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}

  • Entry type: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryTypes/{ENTRY_TYPE_ID}

  • Aspect type: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/aspectTypes/{ASPECT_TYPE_ID}

  • Entry link: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}

  • Metadata job: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataJobs/{METADATA_JOB_ID}

  • Metadata feed: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataFeeds/{METADATA_FEED_ID}

  • Glossary: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}

  • Glossary category: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}

  • Glossary term: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}

  • Data product: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataProducts/{DATA_PRODUCT_ID}

  • Data domain: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataDomains/{DATA_DOMAIN_ID}

  • Process: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}

  • Run: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}

  • Lineage event: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

The following sections provide a breakdown of each component.

Project ID

The value must be the project ID or project number, available from the Google Cloud console. For example, my-cool-project is a project ID, while 123456789123 is a project number.

Location

The value must be one of the supported Knowledge Catalog locations. For a list of available locations, see Knowledge Catalog locations.

ID

ID is the final segment in the resource path.

For most resources (entry groups, entry types, aspect types, entry links, metadata jobs, metadata feeds, glossaries, glossary categories, glossary terms, data products, and data domains), variables such as {ENTRY_GROUP_ID}, {ENTRY_TYPE_ID}, {ASPECT_TYPE_ID}, {ENTRY_LINK_ID}, {METADATA_JOB_ID}, {METADATA_FEED_ID}, {GLOSSARY_ID}, {GLOSSARY_CATEGORY_ID}, {GLOSSARY_TERM_ID}, {DATA_PRODUCT_ID}, and {DATA_DOMAIN_ID} must conform to the following guidelines:

  • Start with a lowercase letter.

  • Contain between 1 and 63 characters.

  • Contain only lowercase letters, numbers, hyphens, and underscores.

  • End with a number or a lowercase letter.

The naming guidelines for an {ENTRY_ID} are different:

  • Contain up to 4000 characters.

  • Use an entry ID format based on the Google Cloud full resource name. The format is the full resource name of the resource without the prefix double slashes in the API service name part. This allows retrieval of entries using their associated resource name.

    For example:

    • If the full resource name of a BigQuery table is //bigquery.googleapis.com/projects/my-project/datasets/my_dataset/tables/my_table, then the suggested {ENTRY_ID} is bigquery.googleapis.com/projects/my-project/datasets/my_dataset/tables/my_table.
    • If the full resource name of a Looker instance is //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, then the suggested {ENTRY_ID} is looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance.

For data lineage resources, such as processes, runs, and lineage events, the variables {PROCESS_ID}, {RUN_ID}, and {LINEAGE_EVENT_ID} must conform to the following guidelines:

  • Contain up to 200 characters.

  • Contain only letters (case-sensitive), numbers, hyphens, underscores, colons, and dots.