Knowledge Catalog 리소스 이름 지정 가이드라인

resource는 에서 만들거나 사용하는 모든 구성요소입니다. Google Cloud Google Cloud이러한 리소스는 플랫폼에서 실행되는 애플리케이션 및 시스템의 빌딩 블록을 형성합니다.

Knowledge Catalog의 리소스에는 다음이 포함됩니다.

  • 항목 그룹

  • 항목

  • 항목 유형

  • 관점 유형

  • 항목 링크

  • 메타데이터 작업

  • 메타데이터 피드

  • 용어집

  • 용어집 카테고리

  • 용어집 용어

  • 데이터 제품

  • 데이터 도메인

  • 계보 프로세스

  • 계보 실행

  • 계보 이벤트

일반적인 Google Cloud 리소스 이름 지정에 대한 자세한 내용은 리소스 이름을 참고하세요.

리소스 이름 지정 형식

다음은 다양한 리소스의 형식입니다.

  • 항목 그룹: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}

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

  • 항목 유형: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryTypes/{ENTRY_TYPE_ID}

  • 관점 유형: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/aspectTypes/{ASPECT_TYPE_ID}

  • 항목 링크: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/{ENTRY_GROUP_ID}/entryLinks/{ENTRY_LINK_ID}

  • 메타데이터 작업: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataJobs/{METADATA_JOB_ID}

  • 메타데이터 피드: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/metadataFeeds/{METADATA_FEED_ID}

  • 용어집: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}

  • 용어집 카테고리: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/categories/{GLOSSARY_CATEGORY_ID}

  • 용어집 용어: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/glossaries/{GLOSSARY_ID}/terms/{GLOSSARY_TERM_ID}

  • 데이터 제품: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataProducts/{DATA_PRODUCT_ID}

  • 데이터 도메인: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/dataDomains/{DATA_DOMAIN_ID}

  • 프로세스: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}

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

  • 계보 이벤트: projects/{PROJECT_ID}/locations/{LOCATION_NAME}/processes/{PROCESS_ID}/runs/{RUN_ID}/lineageEvents/{LINEAGE_EVENT_ID}

다음 섹션에서는 각 구성요소를 분석합니다.

프로젝트 ID

값은 console Google Cloud 에서 사용할 수 있는 프로젝트 ID 또는 프로젝트 번호여야 합니다. 예를 들어 my-cool-project는 프로젝트 ID이고 123456789123은 프로젝트 번호입니다.

위치

값은 지원되는 Knowledge Catalog 위치 중 하나여야 합니다. 사용 가능한 위치 목록은 Knowledge Catalog 위치를 참고하세요.

ID

ID는 리소스 경로의 마지막 세그먼트입니다.

대부분의 리소스 (항목 그룹, 항목 유형, 관점 유형, 항목 링크, 메타데이터 작업, 메타데이터 피드, 용어집, 용어집 카테고리, 용어집 용어, 데이터 제품, 데이터 도메인)의 경우 {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}, {DATA_DOMAIN_ID}와 같은 변수는 다음 가이드라인을 준수해야 합니다.

  • 소문자로 시작해야 합니다.

  • 1~63자의 문자를 포함합니다.

  • 소문자, 숫자, 하이픈, 밑줄만 포함합니다.

  • 숫자 또는 소문자로 끝납니다.

{ENTRY_ID}의 이름 지정 가이드라인은 다음과 같이 다릅니다.

  • 최대 4,000자의 문자를 포함합니다.

  • 전체 리소스 이름을 기반으로 항목 ID 형식을 사용합니다. Google Cloud 형식은 API 서비스 이름 부분에 이중 슬래시 접두사가 없는 리소스의 전체 리소스 이름입니다. 이렇게 하면 연결된 리소스 이름을 사용하여 항목을 검색할 수 있습니다.

    예를 들면 다음과 같습니다.

    • Looker 인스턴스의 전체 리소스 이름이 //looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance, 인 경우 권장되는 {ENTRY_ID}looker.googleapis.com/projects/my-project/locations/us-central1/instances/my-instance입니다.

프로세스, 실행, 계보 이벤트와 같은 데이터 계보 리소스의 경우 변수 {PROCESS_ID}, {RUN_ID}, {LINEAGE_EVENT_ID}는 다음 가이드라인을 준수해야 합니다.

  • 최대 200자의 문자를 포함합니다.

  • 문자 (대소문자 구분), 숫자, 하이픈, 밑줄, 콜론, 마침표만 포함합니다.

BigQuery 항목 이름

Knowledge Catalog API를 통해 BigQuery 리소스와 상호작용할 때는 항목 그룹 ID 및 항목 ID에 특정 형식을 사용해야 합니다.

  • 항목 그룹 ID: @bigquery
  • 항목 ID: bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

BigQuery 테이블이 projects/test-project/datasets/test_dataset/tables/test_table인 경우 정규화된 Knowledge Catalog 항목 이름은 다음과 같습니다.

projects/{PROJECT_ID}/locations/{LOCATION_NAME}/entryGroups/@bigquery/entries/bigquery.googleapis.com/projects/test-project/datasets/test_dataset/tables/test_table