2026 年 4 月 10 日より、Dataplex Universal Catalog は Knowledge Catalog と呼ばれるようになりました。API、クライアントライブラリ、CLI、IAM の名前は変更されません。詳細については、Google Cloud Knowledge Catalog の概要をご覧ください。

Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

アスペクトを管理してメタデータを拡充する

メタデータは、データアセットとそれらの間の関係を整理して理解するうえで不可欠です。たとえば、規制対象の業界では、名前、住所、政府機関発行の身分証明書などの個人情報（PII）を保護する必要があります。このデータは、分散データシステム全体で多数のインスタンスで発生する可能性があります。Knowledge Catalog（旧称: Dataplex Universal Catalog）を使用すると、分散データアセットをすばやく検出してカタログに登録できます。その後、データを PII として分類できます。

データエントリとエントリリンクに有意義なコンテキストを追加することで、データの検出可能性と有用性を高めることが可能です。Knowledge Catalog では、アスペクトタイプとアスペクトを使用してコンテキストを有効にします。

アスペクトタイプ: 関連データを定義する JSON テンプレート。たとえば、コンプライアンス情報には、PII の分類と GDPR 準拠が含まれる場合があります。
アスペクト: アスペクトタイプのインスタンス。たとえば、{"pii_classification": "confidential", "gdpr_compliant": true}。アスペクトは、テーブル全体、個々のテーブル列、またはエントリリンクに適用できます。

データを分類したら、データ品質ポリシーまたはアクセスポリシーをデータに適用できます。

詳細については、Knowledge Catalog のメタデータについてをご覧ください。

アスペクトタイプとは

アスペクトタイプは、アスペクトのテンプレートを提供する再利用可能なリソースです。カスタムアスペクトタイプを作成する場合は、Knowledge Catalog リソースの命名ガイドラインに準拠した ID を指定する必要があります。

アスペクトタイプのカテゴリ

アスペクトタイプは、カスタムアスペクトタイプとシステムアスペクトタイプに分類されます。

カスタムのアスペクトタイプ

Knowledge Catalog で作成するアスペクトタイプは、カスタムアスペクトタイプと呼ばれます。

注: Gemini コンテキスト取得の境界: Gemini in BigQuery は、標準のスキーマ定義、テーブル制約、テーブル/列の説明フィールドに基づいて SQL の生成とデータ推論を行います。Knowledge Catalog のユーザー定義のカスタムアスペクトタイプは、ガバナンス、検索、API 取得のためにカタログプレーンに保存されますが、Gemini のコンテキストプロンプト取得パイプラインに動的に挿入されることはありません。推奨されるベストプラクティス: ビジネスロジック、セマンティックコンテキスト、デベロッパーノートを BigQuery の Gemini に表示するには、[標準の overview アスペクト](#その他の再利用可能なアスペクトタイプ) 内の [テーブル](/bigquery/docs/managing-tables#updating_a_tables_description) と [列の説明](/bigquery/docs/managing-table-schemas#change-column-description) のフィールドに直接記述するか、[ビジネス用語集の用語](/knowledge-catalog/docs/manage-glossaries)を使用します。詳細については、[BigQuery で Knowledge Catalog を使用する](/bigquery/docs/use-knowledge-catalog) をご覧ください。

カスタムアスペクトタイプは、グローバルまたはリージョンにできます。

グローバルアスペクトタイプ: 任意のリージョンのエントリのアスペクトを作成するために使用できます。複数のリージョンにわたってエントリに同じ構造を適用する必要がある場合は、global アスペクトタイプを選択します。このタイプは 1 回定義するだけで済みます。グローバルアスペクトタイプの定義はすべてのリージョンに複製されるため、アスペクトタイプのスキーマ自体に機密情報が含まれている場合や、すべてのメタデータコンポーネントに厳格なデータ所在地が必要な場合は、このオプションが適していない可能性があります。
リージョンのアスペクトタイプ: アスペクトタイプと同じリージョンに存在するエントリのアスペクトを作成する場合にのみ使用できます。たとえば、us-central1 で作成されたアスペクトタイプは、us-central1 のエントリでのみ使用できます。アスペクトタイプが特定のリージョンのエントリにのみ関連する場合、またはアスペクトタイプ定義が選択したリージョン内に存在するようにする場合は、リージョンのロケーションを選択します。これにより、データ主権とコンプライアンスの要件を満たすことができます。リージョンのアスペクトタイプを使用しているが、複数のリージョンで同じ構造が必要な場合は、各リージョンで個別の側面タイプ定義を作成して管理する必要があります。

カスタムアスペクトタイプは、特定のリージョンロケーション（us-central1 など）で、または global リソースとして作成できます。アスペクトタイプのロケーションは、適用範囲に影響し、使用できるエントリを決定します。

詳細については、プロジェクトとロケーションの制約をご覧ください。

システムのアスペクトタイプ

Knowledge Catalog が提供、使用、管理するアスペクトタイプは、システムのアスペクトタイプと呼ばれます。システムのアスペクトタイプは常にグローバルであるため、どのリージョンでも使用できます。システムのアスペクトタイプは、プロジェクト ID 655216118709 の Google マネージドプロジェクトに保存されます。例: projects/655216118709/locations/global/aspectTypes/schema

システム定義のアスペクトタイプ、エントリタイプ、エントリリンクタイプにはそれぞれ独自の IAM 権限があります。詳細については、システムアスペクトタイプ、エントリタイプ、エントリリンクタイプの IAM 権限をご覧ください。

システムアスペクトタイプは、再利用可能と制限付きにさらに分類されます。次の表に、システムアスペクトタイプのカテゴリと、各カテゴリに Knowledge Catalog が提供するアスペクトタイプのリストを示します。

システムアスペクトタイプのカテゴリ	説明	Knowledge Catalog が提供するアスペクトタイプ
再利用可能なシステムアスペクトタイプ	これらのアスペクトタイプを使用して、アスペクトを作成または変更できます。	`contacts` `data-profile` `data-quality-scorecard` `generic` `graph-profile` `guidelines` `overview` `schema-join` `schema` `storage` `usage`
制限付きシステムアスペクトタイプ	これらのアスペクトタイプは Knowledge Catalog によって管理されます。これらのアスペクトタイプではアスペクトを読み取ることができますが、アスペクトの作成や編集はできません。	以下を含みます（ただしこれらに限定されません）。 `analytics-hub` `aspecttype-aspect` `bigquery-dataset` `bigquery-table` `cloudsql-database` `cloudsql-instance` `cloudsql-table` `entrygroup-aspect` `entrytype-aspect` `sensitive-data-protection-profile` `storage-bucket` `storage-folder`

アスペクトとは

アスペクトを使用すると、エントリまたはエントリリンク内のメタデータをキャプチャして、有意義なコンテキストを提供できます。アスペクトを使用して、次のタイプのメタデータを保存できます。

ビジネスメタデータ: データ分類など、ビジネスコンテキストを提供する情報。
テクニカルメタデータ: エントリまたはエントリリンクの技術的な詳細。次のものがあります。
- エントリの場合: データアセット自体の詳細（スキーマなど）。
- エントリリンクの場合: データアセット間の関係の詳細（結合の詳細など）。
データから派生したメタデータ: BigQuery テーブルの統計情報など、データ自体から生成された情報。

アスペクトは、個別のスタンドアロンリソースではなく、親エントリリソースの構成要素です。アスペクトを変更すると、そのアスペクトを含むエントリが更新されます。これらの変更を追跡するには、メタデータ変更フィードを購読します。

アスペクトの配置とターゲットレベル

各アスペクトは、アスペクトタイプのテンプレートのインスタンスです。このテンプレートは、入力する必要があるフィールドを定義します。アスペクトを適用できる場所と、アスペクトを適用できる回数は、ターゲットリソースタイプによって異なります。

ターゲットリソース	サポートされているレベル	基数の上限
エントリ	エントリレベルまたは列レベル	エントリレベルでは、アスペクトタイプごとに 1 つのアスペクトのみが許可されます。アスペクトタイプごとに複数のアスペクトを異なる列に含めることができます。
エントリリンク	リンクレベルのみ	リンクごとにアスペクトタイプごとに 1 つのアスペクト。

アスペクトのカテゴリ

アスペクトは、必須アスペクトとオプションのアスペクトに分類されます。

必須アスペクト

必須アスペクトは、エントリまたはエントリリンクの作成時に必須のアスペクトです。このようなアスペクトは、エントリタイプまたはエントリリンクタイプによって定義されます。特定のタイプに属するすべてのリソースには、そのタイプで定義されているすべての必須アスペクトが常に存在する必要があります。

Knowledge Catalog は、システムエントリに必要なアスペクト（スキーマなど）を管理します。

次の点にご注意ください。

必須アスペクトはエントリにのみ関連付けることができ、その列には関連付けられません。
エントリまたはエントリリンクから必須アスペクトを削除することはできません。
システムエントリの必須アスペクトは読み取れますが、変更はできません。
データアスペクトは必須アスペクトにできません。

オプションのアスペクト

オプションのアスペクトは、エントリまたはエントリ列に関連付けることができます。オプションのアスペクトは、エントリの作成時に入力するか、後でエントリを更新して入力できます。

次の点にご注意ください。

オプションのアスペクトは、入力した後に削除できます。
エントリリンクは必須アスペクトのみをサポートします。

データアスペクト

一部のアスペクトには、エントリのメタデータではなく、エントリの基盤となるデータから派生した情報が含まれています。これらはデータアスペクトと呼ばれます。たとえば、データプロファイルスキャンやデータ品質スキャンの結果には、データ自体から導出された統計情報が含まれているため、データアスペクトとして分類されます。

データアスペクトであるシステムアスペクトタイプには、次のものがあります。

data-profile: データプロファイルスキャンの結果が含まれます。詳細については、データのプロファイリングについてをご覧ください。
data-quality-scorecard: データ品質スコアの概要が含まれます。
data-rules: エントリにデータ品質ルールを適用します。
data-quality-rule-template: 再利用可能なデータ品質ルールテンプレートを定義します。

始める前に

アスペクトタイプとアスペクトを作成し、管理する前に、このセクションで説明するタスクを完了してください。

必要なロール

アスペクトタイプとアスペクトを作成して管理するために必要な権限を取得するには、リソースに対する次の IAM ロールの付与を管理者に依頼してください。

アスペクトタイプやデータアスペクトなど、Knowledge Catalog のメタデータリソースに対する完全な権限セット: Dataplex Catalog 管理者（roles/dataplex.catalogAdmin）
アスペクトタイプやデータアスペクトなど、Knowledge Catalog でメタデータリソースを作成、管理する: Dataplex Catalog 編集者（roles/dataplex.catalogEditor）
カスタムアスペクトタイプに対するすべての権限（アスペクトタイプを使用してエントリを作成または編集する権限を除く）: Dataplex アスペクトタイプオーナー（roles/dataplex.aspectTypeOwner）
アスペクトタイプとそれに関連付けられた IAM ポリシーを表示する: Dataplex Catalog 閲覧者（roles/dataplex.catalogViewer）
アスペクトタイプを使用して、対応するアスペクトを持つエントリを作成および変更する: Dataplex アスペクトタイプユーザー（roles/dataplex.aspectTypeUser）
schema、schema-join、overview、contacts などのシステムアスペクトタイプのアスペクトを追加する: Dataplex エントリと EntryLink オーナー（roles/dataplex.entryOwner）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

詳細については、Knowledge Catalog IAM ロールをご覧ください。

API を有効にする

Knowledge Catalog プロジェクトで Dataplex API を有効にします。新しい Google Cloud プロジェクトまたは BigQuery API が有効になっているプロジェクトを使用している場合、Dataplex API はデフォルトで有効になっています。

API を有効にする

カスタムのアスペクトタイプを作成する

コンソール

Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。

[メタデータのタイプ] に移動
[アスペクトタイプとタグテンプレート] > [カスタム] タブをクリックします。
[アスペクトタイプを作成する] をクリックします。
[アスペクトタイプを作成する] ウィンドウで、次のように入力します。
1. 省略可: [表示名] フィールドに、アスペクトタイプの名前を入力します。
2. [アスペクトタイプ ID] フィールドに、アスペクトタイプの一意の ID を入力します。
3. 省略可: [説明] フィールドに、アスペクトタイプの説明を入力します。
4. [ロケーション] フィールドで、アスペクトタイプのロケーションを選択します。作成後にアスペクトタイプのロケーションを変更することはできません。グローバルロケーションとリージョンロケーションの選択による影響については、カスタムのアスペクトタイプのセクションをご覧ください。
省略可: アスペクトタイプのテンプレートを定義します。

[テンプレート] セクションで、[フィールドを追加] をクリックします。[新規フィールド] セクションに、次の情報を入力します。
1. [名前] フィールドに名前を入力します。
2. 省略可: [表示名] フィールドに表示名を入力します。
3. 省略可: [説明] フィールドに説明を入力します。
4. [型] フィールドで、フィールドのデータ型を選択します。選択内容に応じて、次のフィールドとオプションが表示されます。
  - データ型として [テキスト] を選択した場合は、次の手順を行います。
    1. [テキスト型] フィールドで、テキストの型を選択します。
    2. [テキスト値] フィールドに、テキストフィールドのヒントを指定します。これを行うには、[値を追加] をクリックしてヒントを入力します。テキストフィールドには複数のヒントを追加できます。
    3. [完了] をクリックします。
  - データ型として [列挙型] を選択した場合は、列挙値を追加します。
    1. [列挙値を追加] をクリックします。
    2. [値] フィールドに列挙値を入力します。複数の列挙値を追加できます。
    3. [完了] をクリックします。
  - データ型として [配列] を選択した場合は、[配列項目] セクションで、配列に存在する項目の型を定義します。
    1. [配列項目を追加] をクリックします。
    2. [名前] フィールドに、配列項目の名前を入力します。
    3. 省略可: [表示名] フィールドに、配列項目の表示名を入力します。
    4. 省略可: [説明] フィールドに、配列項目の説明を入力します。
    5. [型] フィールドで、配列項目のデータ型を選択します。
      
      選択内容に応じて、次の一連のフィールドとオプションが表示されます。これらのオプションは、このセクションの他の箇所で説明されているデータ型であるテキスト、列挙型、マップ、配列、レコードのオプションと類似しています。
    6. [完了] をクリックします。
  - データ型として [マップ] を選択した場合は、[マップ値] セクションで、マップに存在する値の型を定義します。
    1. [マップ値を追加] をクリックします。
    2. [名前] フィールドに、マップの名前を入力します。
    3. 省略可: [表示名] フィールドに、マップの表示名を入力します。
    4. 省略可: [説明] フィールドに、マップの説明を入力します。
    5. [型] フィールドで、マップのデータ型を選択します。
      
      選択内容に応じて、次の一連のフィールドとオプションが表示されます。これらのオプションは、このセクションの他の箇所で説明されているデータ型であるテキスト、列挙型、マップ、配列、レコードのオプションと類似しています。
    6. [完了] をクリックします。
  - データ型として [記録] を選択した場合は、次のように入力します。
    1. [レコード ID] フィールドに、他のレコードフィールドがこのレコードを参照するために使用できる一意の ID を入力します。このドキュメントのレコード ID フィールドとレコード参照フィールドの使用例をご覧ください。
    2. 省略可: このテンプレートの別のレコードへの参照を追加する場合は、[レコード参照] フィールドを使用します。アスペクトタイプを作成した後にこの値を変更することはできません。このドキュメントのレコード ID フィールドとレコード参照フィールドの使用例をご覧ください。
    3. [レコードフィールド] セクションでは、複数のネストされたフィールドを持つ複雑なオブジェクトを定義できます。これを行うには、[レコードフィールド項目の追加] をクリックして、次の値を指定します。
    4. [名前] フィールドに、レコードフィールドの名前を入力します。
    5. 省略可: [表示名] フィールドに、レコードフィールドの表示名を入力します。
    6. 省略可: [説明] フィールドにレコードフィールドの説明を入力します。
    7. [型] フィールドでデータ型を選択します。
      
      選択内容に応じて、次の一連のフィールドとオプションが表示されます。これらのオプションは、このセクションで前述したデータ型であるテキスト、列挙型、マップ、配列、レコードのオプションに類似しています。
    8. [完了] をクリックします。
5. このタイプのアスペクトでフィールドを必須にするには、[必須] を選択します。必須アスペクトとオプションのアスペクトの詳細については、このドキュメントのアスペクトのカテゴリセクションをご覧ください。
6. [完了] をクリックします。
7. 複数のフィールドを追加するには、[フィールドを追加] をクリックして、前の手順を繰り返します。
省略可: [ラベル] セクションで、任意のラベルを Key-Value ペアとしてリソースに追加します。
1. [ラベルを追加] をクリックします。
2. [キー] フィールドにキーを入力します。
3. [値] フィールドにキーの値を入力します。
4. ラベルをさらに追加するには、[ラベルを追加] をクリックしてこの手順を繰り返します。
[保存] をクリックします。

gcloud

カスタムのアスペクトタイプを作成するには、gcloud dataplex aspect-types create コマンドを使用します。

C#

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある C# の設定手順を行ってください。詳細については、Knowledge Catalog C# API のリファレンスドキュメントをご覧ください。

Knowledge Catalog への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using Google.LongRunning;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for CreateAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CreateAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        CreateAspectTypeRequest request = new CreateAspectTypeRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            AspectTypeId = "",
            AspectType = new AspectType(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<AspectType, OperationMetadata> response = catalogServiceClient.CreateAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<AspectType, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        AspectType result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<AspectType, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceCreateAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            AspectType retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Go の設定手順を行ってください。詳細については、Knowledge Catalog Go API のリファレンスドキュメントをご覧ください。


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.CreateAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateAspectTypeRequest.
	}
	op, err := c.CreateAspectType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Java の設定手順を行ってください。詳細については、Knowledge Catalog Java API のリファレンスドキュメントをご覧ください。

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.CreateAspectTypeRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateAspectType {

  public static void main(String[] args) throws Exception {
    syncCreateAspectType();
  }

  public static void syncCreateAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      CreateAspectTypeRequest request =
          CreateAspectTypeRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setAspectTypeId("aspectTypeId-423030675")
              .setAspectType(AspectType.newBuilder().build())
              .setValidateOnly(true)
              .build();
      AspectType response = catalogServiceClient.createAspectTypeAsync(request).get();
    }
  }
}

Node.js

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Node.js の設定手順を行ってください。詳細については、Knowledge Catalog Node.js API のリファレンスドキュメントをご覧ください。

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType, of the form:
 *  projects/{project_number}/locations/{location_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Required. AspectType identifier.
 */
// const aspectTypeId = 'abc123'
/**
 *  Required. AspectType Resource.
 */
// const aspectType = {}
/**
 *  Optional. The service validates the request without performing any
 *  mutations. The default is false.
 */
// const validateOnly = true

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callCreateAspectType() {
  // Construct request
  const request = {
    parent,
    aspectTypeId,
    aspectType,
  };

  // Run request
  const [operation] = await dataplexClient.createAspectType(request);
  const [response] = await operation.promise();
  console.log(response);
}

callCreateAspectType();

Python

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Python の設定手順を行ってください。詳細については、Knowledge Catalog Python API のリファレンスドキュメントをご覧ください。

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_create_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    aspect_type = dataplex_v1.AspectType()
    aspect_type.metadata_template.name = "name_value"
    aspect_type.metadata_template.type_ = "type__value"

    request = dataplex_v1.CreateAspectTypeRequest(
        parent="parent_value",
        aspect_type_id="aspect_type_id_value",
        aspect_type=aspect_type,
    )

    # Make the request
    operation = client.create_aspect_type(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

このサンプルを試す前に、クライアントライブラリを使用した Knowledge Catalog のクイックスタートにある Ruby の設定手順を行ってください。詳細については、Knowledge Catalog Ruby API のリファレンスドキュメントをご覧ください。

require "google/cloud/dataplex/v1"

##
# Snippet for the create_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#create_aspect_type.
#
def create_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::CreateAspectTypeRequest.new

  # Call the create_aspect_type method.
  result = client.create_aspect_type request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

カスタムのアスペクトタイプを作成するには、aspectType.create メソッドを使用します。

カスタムのアスペクトタイプを作成したら、エントリにアスペクトを追加できます。

レコード ID フィールドとレコード参照フィールドの使用例

再帰参照には、[レコード ID] フィールドと [レコード参照] フィールドを使用できます。次の例では、これらのフィールドの使用方法を示します。

次のフィールドを持つ Employee というアスペクトタイプについて考えてみましょう。

名前（タイプ: Text）
開始日（タイプ: Date & time）
申告（タイプ: Text）
現在のアドレス（タイプ: Record）
永続的なアドレス（タイプ: Record）

2 つのアドレスフィールド（[現在のアドレス] と [永続的なアドレス]）は同じデータタイプ Record です。重複を回避するには、これらのフィールドを定義するときに [レコード ID] と [レコード参照] の値を設定します。

[現在のアドレス] フィールドを定義するときに、レコード ID を address-field として指定できます。[永続的なアドレス] には、[レコード参照] と同じ値（address-field）を指定できます。次に例を示します。

名前（タイプ: Text）
開始日（タイプ: Date & time）
申告（タイプ: Text）
現在のアドレス（タイプ: Record、レコード ID: address-field）
永続的なアドレス（タイプ: Record、レコード参照: address-field）

これにより、別の住所のフィールドを複製する必要がなくなります。

エントリにアスペクトを追加する

カスタムアスペクトタイプを作成したら、そのタイプのアスペクトを作成できます。アスペクトはエントリ内に保存されるため、エントリにアスペクトを追加するには、エントリを更新する必要があります。

次の点にご注意ください。

アスペクトはエントリまたはエントリの列に追加できます。
必須アスペクトを編集できるのは、カスタムエントリの場合のみです。必須アスペクトは削除できません。
カスタムエントリとシステムエントリの両方で、オプションのアスペクトを編集および削除できます。

コンソール

Google Cloud コンソールで、Knowledge Catalog の [検索] ページに移動します。

[検索] に移動
検索プラットフォームが [Data Catalog] に設定されている場合は、[検索プラットフォームの選択] メニューで [Dataplex Universal Catalog] を選択します。
アスペクトを追加するエントリを検索し、そのエントリをクリックします。[エントリの詳細] ページが開きます。
エントリにアスペクトを追加する手順は次のとおりです。
1. [詳細] タブをクリックします。
2. エントリに必須アスペクトまたはオプションのアスペクトを追加するには、[タグとアスペクト] セクションで、該当するカテゴリの [追加] をクリックします。
  選択したエントリのエントリタイプに必須アスペクトが定義されていない場合、必須アスペクトを追加することはできません。
3. 追加するアスペクトを検索して選択します。
4. [アスペクトを追加] ウィンドウで、フィールドの値を入力します。
5. [保存] をクリックします。
6. エントリの列にアスペクトを追加する手順は次のとおりです。
7. [エントリの詳細] ページで [スキーマ] タブをクリックします。
8. アスペクトを追加する列を選択します。
9. [アスペクトを追加] をクリックします。
10. 追加するアスペクトを検索して選択します。
11. [アスペクトを追加] ウィンドウで、フィールドの値を入力します。
12. [保存] をクリックします。

gcloud

エントリまたはエントリの列にアスペクトを追加するには、gcloud dataplex entries update コマンドを使用します。

C#

using Google.Cloud.Dataplex.V1;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

エントリオブジェクトにアスペクトを追加するには、アスペクトをご覧ください。

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateEntryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryRequest.
	}
	resp, err := c.UpdateEntry(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

エントリオブジェクトにアスペクトを追加するには、エントリをご覧ください。

Java

import com.google.cloud.dataplex.v1.Aspect;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.EntryName;
import com.google.cloud.dataplex.v1.EntrySource;
import com.google.protobuf.FieldMask;
import com.google.protobuf.Struct;
import com.google.protobuf.Value;
import java.util.Map;

public class UpdateEntry {

  public static void main(String[] args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    // Available locations: https://cloud.google.com/dataplex/docs/locations
    String location = "MY_LOCATION";
    String entryGroupId = "MY_ENTRY_GROUP_ID";
    String entryId = "MY_ENTRY_ID";

    Entry createdEntry = updateEntry(projectId, location, entryGroupId, entryId);
    System.out.println("Successfully updated entry: " + createdEntry.getName());
  }

  // Method to update Entry located in projectId, location, entryGroupId and with entryId
  public static Entry updateEntry(
      String projectId, String location, String entryGroupId, String entryId) throws Exception {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests.
    try (CatalogServiceClient client = CatalogServiceClient.create()) {
      Entry entry =
          Entry.newBuilder()
              .setName(EntryName.of(projectId, location, entryGroupId, entryId).toString())
              .setEntrySource(
                  EntrySource.newBuilder()
                      .setDescription("updated description of the entry")
                      .build())
              .putAllAspects(
                  Map.of(
                      "dataplex-types.global.generic",
                      Aspect.newBuilder()
                          .setAspectType(
                              "projects/dataplex-types/locations/global/aspectTypes/generic")
                          .setData(
                              Struct.newBuilder()
                                  // "Generic" Aspect Type have fields called "type" and "system.
                                  // The values below are a sample of possible options.
                                  .putFields(
                                      "type",
                                      Value.newBuilder()
                                          .setStringValue("updated example value")
                                          .build())
                                  .putFields(
                                      "system",
                                      Value.newBuilder()
                                          .setStringValue("updated example system")
                                          .build())
                                  .build())
                          .build()))
              .build();

      // Update mask specifies which fields will be updated.
      // For more information on update masks, see: https://google.aip.dev/161
      FieldMask updateMask =
          FieldMask.newBuilder().addPaths("aspects").addPaths("entry_source.description").build();
      return client.updateEntry(entry, updateMask);
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry resource.
 */
// const entry = {}
/**
 *  Optional. Mask of fields to update. To update Aspects, the update_mask must
 *  contain the value "aspects".
 *  If the update_mask is empty, the service will update all modifiable fields
 *  present in the request.
 */
// const updateMask = {}
/**
 *  Optional. If set to true and the entry doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. If set to true and the aspect_keys specify aspect ranges, the
 *  service deletes any existing aspects from that range that weren't provided
 *  in the request.
 */
// const deleteMissingAspects = true
/**
 *  Optional. The map keys of the Aspects which the service should modify. It
 *  supports the following syntaxes:
 *  * `<aspect_type_reference>` - matches an aspect of the given type and empty
 *  path.
 *  * `<aspect_type_reference>@path` - matches an aspect of the given type and
 *  specified path. For example, to attach an aspect to a field that is
 *  specified by the `schema` aspect, the path should have the format
 *  `Schema.<field_name>`.
 *  * `<aspect_type_reference>@*` - matches aspects of the given type for all
 *  paths.
 *  * `*@path` - matches aspects of all types on the given path.
 *  The service will not remove existing aspects matching the syntax unless
 *  `delete_missing_aspects` is set to true.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callUpdateEntry() {
  // Construct request
  const request = {
    entry,
  };

  // Run request
  const response = await dataplexClient.updateEntry(request);
  console.log(response);
}

callUpdateEntry();

Python

from google.cloud import dataplex_v1
from google.protobuf import struct_pb2


def update_entry(
    project_id: str, location: str, entry_group_id: str, entry_id: str
) -> dataplex_v1.Entry:
    """Method to update Entry located in project_id, location, entry_group_id and with entry_id"""

    # Initialize client that will be used to send requests across threads. This
    # client only needs to be created once, and can be reused for multiple requests.
    # After completing all of your requests, call the "__exit__()" method to safely
    # clean up any remaining background resources. Alternatively, use the client as
    # a context manager.
    with dataplex_v1.CatalogServiceClient() as client:
        # The resource name of the Entry
        name = f"projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}"
        entry = dataplex_v1.Entry(
            name=name,
            entry_source=dataplex_v1.EntrySource(
                description="updated description of the entry"
            ),
            aspects={
                "dataplex-types.global.generic": dataplex_v1.Aspect(
                    aspect_type="projects/dataplex-types/locations/global/aspectTypes/generic",
                    data=struct_pb2.Struct(
                        fields={
                            # "Generic" Aspect Type have fields called "type" and "system.
                            # The values below are a sample of possible options.
                            "type": struct_pb2.Value(
                                string_value="updated example value"
                            ),
                            "system": struct_pb2.Value(
                                string_value="updated example system"
                            ),
                        }
                    ),
                )
            },
        )

        # Update mask specifies which fields will be updated.
        # For more information on update masks, see: https://google.aip.dev/161
        update_mask = {"paths": ["aspects", "entry_source.description"]}
        return client.update_entry(entry=entry, update_mask=update_mask)


if __name__ == "__main__":
    # TODO(developer): Replace these variables before running the sample.
    project_id = "MY_PROJECT_ID"
    # Available locations: https://cloud.google.com/dataplex/docs/locations
    location = "MY_LOCATION"
    entry_group_id = "MY_ENTRY_GROUP_ID"
    entry_id = "MY_ENTRY_ID"

    updated_entry = update_entry(project_id, location, entry_group_id, entry_id)
    print(f"Successfully updated entry: {updated_entry.name}")

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_entry call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateEntryRequest.new

  # Call the update_entry method.
  result = client.update_entry request

  # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
  p result
end

エントリオブジェクトにアスペクトを追加するには、#required_aspects= をご覧ください。

REST

エントリまたはエントリの列にアスペクトを追加するには、entry.patch メソッドを使用します。

それぞれのアスペクトタイプとエントリが異なる Google Cloud 組織にあるエントリでアスペクトを作成して使用することはできません。

再利用可能なシステムアスペクトタイプのアスペクトを関連付ける

再利用可能なシステムアスペクトタイプのアスペクトをエントリに添付できます。

再利用可能なアスペクトタイプの側面は、その構造に応じて Google Cloud コンソールで編集できます。ネストされたフィールドを含むアスペクトタイプは、 Google Cloud コンソールでの編集がサポートされていません。このタイプの側面を関連付けるか更新するには、gcloud コマンドラインツールまたは REST API を使用する必要があります。

データ品質スコアカード

データ品質スコアカードは、データ品質の概要を提供する側面です。多くの場合、データ品質スキャンやその他のプロセスに基づいています。データ品質スコアカードをエントリに添付して、カスタムのデータ品質情報を提供できます。これを行うには、システム定義タイプ data-quality-scorecard のアスペクトを関連付けます。

data-quality-scorecard アスペクト内の data フィールドには、次のフィールドを含めることができます。

job: 省略可。スコアカードを生成したジョブの詳細を含むレコード。
- name: データ品質ジョブのリソース名。
- runTime: データ品質ジョブの実行時間。
score: 省略可。データ品質の総合スコア。スコアの範囲は [0, 100] です。
status: 必須。データ品質スコアカードのステータス。品質のしきい値（PASS または FAIL）に合格したか失敗したかを示します。
dimensions: 省略可。ディメンション結果の配列。各結果には次のものが含まれます。
- name: ディメンションの名前。ACCURACY、COMPLETENESS、CONSISTENCY、FRESHNESS、UNIQUENESS、VALIDITY、VOLUME のいずれか、またはカスタムディメンション名にできます。カスタムディメンション名には大文字を使用し、30 文字以下にする必要があります。
- score: ディメンションレベルの総合スコア。範囲は [0, 100] です。
- status: ディメンションのステータス。品質しきい値（PASS または FAIL）を満たしているかどうかを示します。
columns: 省略可。列の結果の配列。各結果には次のものが含まれます。
- name: 列の名前。
- score: 列レベルの総合スコア（0 ～ 100）。
- status: 列のステータス。品質しきい値（PASS または FAIL）に合格したか不合格になったかを示します。
- dimensions: 列のディメンションスコアの配列。各ディメンションスコアには次のものが含まれます。
  - name: ディメンションの名前。
  - score: ディメンションのスコア。範囲は [0, 100] です。
  - status: 列のディメンションのステータス。品質しきい値（PASS または FAIL）に合格したか不合格になったかを示します。

アスペクトを関連付けるコマンドを実行すると、その特定のアスペクトの既存のデータが置き換えられます。たとえば、スコアが 80 のスコアカードを、スコアが 90 の新しいファイルで更新すると、80 は上書きされます。データは統合されません。

データ品質スコアカードを添付する手順は次のとおりです。

gcloud

エントリのアスペクトを更新するには、gcloud dataplex entries update-aspects コマンドを使用します。

次の内容を含む JSON ファイル（dq-aspect.json）を作成します。

  {
    "dataplex-types.global.data-quality-scorecard": {
      "data": {
        "score": 0.8,
        "status": "PASS",
        "dimensions": [
          {
            "name": "completeness",
            "score": 0.9,
            "status": "PASS"
          },
          {
            "name": "uniqueness",
            "score": 0.7,
            "status": "FAIL"
          }
        ],
        "columns": [
          {
            "name": "col1",
            "score": 0.85,
            "status": "PASS"
          }
        ]
      }
    }
  }
}

次のコマンドを実行します。
```
  gcloud dataplex entries update-aspects ENTRY_ID
  --location=LOCATION
  --entry-group=ENTRY_GROUP_ID
  --project=PROJECT_ID
  --aspects=dq-aspect.json
```
次の変数を置き換えます。
- ENTRY_ID: エントリの ID（例: example-entry）
- LOCATION: エントリのロケーション（例: us-central1）
- ENTRY_GROUP_ID: エントリグループの ID（例: example-entry-group）
- PROJECT_ID: プロジェクトの ID（例: example-project）

REST

エントリのアスペクトを更新するには、entry.patch メソッドを使用します。

payload.json という名前のファイルを作成し、リクエストの JSON コンテンツを貼り付けます。


  {
    "aspects": {
      "dataplex-types.global.data-quality-scorecard": {
        "data": {
          "score": 80,
          "status": "PASS",
          "dimensions": [
            {
              "name": "completeness",
              "score": 90,
              "status": "PASS"
            },
            {
              "name": "uniqueness",
              "score": 70,
              "status": "FAIL"
            }
          ],
          "columns": [
            {
              "name": "col1",
              "score": 85,
              "status": "PASS"
            }
          ]
        }
      }
    }
  }

ターミナルで次のコマンドを実行します。

 curl -X PATCH \
 -H "Authorization: Bearer $(gcloud auth print-access-token)" \
 -H "Content-Type: application/json" \
 -d @payload.json \
 "https://dataplex.googleapis.com/v1/projects/<var>PROJECT_ID</var>/locations/<var>LOCATION</var>/entryGroups/<var>ENTRY_GROUP_ID</var>/entries/<var>ENTRY_ID</var>?updateMask=aspects"

次のように置き換えます。

PROJECT_ID: プロジェクトの ID（例: example-project）
LOCATION: エントリのロケーション（例: us-central1）
ENTRY_GROUP_ID: エントリグループの ID（例: example-entry-group）
ENTRY_ID: エントリの ID（例: example-entry）

その他の再利用可能なアスペクトタイプ

次のシステムアスペクトタイプも使用できます。データ品質スコアカードで示されているのと同じ gcloud または REST API メソッドを使用して、これらを関連付けることができます。ネストされたフィールドのないアスペクトタイプ（generic など）の場合は、コンソールを使用できます。

Contacts. contacts アスペクトタイプを使用して、所有権またはスチュワードシップを割り当てます。フィールドには次のものがあります。
- identities（配列）: 連絡先のリスト。各連絡先には次の情報が含まれます。
  - role（文字列）: 連絡先の役割（owner、steward、producer、admin など）。
  - name（文字列）: 連絡先の名前。
  - id（文字列）: 連絡先のメールアドレスまたは ID。
次のように payload.json ファイルを作成します。
```
 {
   "aspects": {
     "dataplex-types.global.contacts": {
       "data": {
         "identities": [
           {
             "role": "steward",
             "name": "Jane Doe",
             "id": "jane.doe@example.com"
           }
         ]
       }
     }
   }
 }
```
データプロファイル。data-profile アスペクトタイプを使用して、データプロファイリングの結果を取得します。詳細については、データのプロファイリングについてをご覧ください。

フィールドには次のものがあります。
- sourceDataInfo（レコード）: プロファイルの生成に使用されたスキャン対象のソースデータに関する情報。
  - scope（列挙型）: プロファイルのスコープ（PREVIEW、SAMPLED、ALL）。PREVIEW 値は、軽量プロファイリングスキャンの結果に対応します。
  - scannedRows（int）: スキャンされた行数。
  - samplingPercentage（double）: 使用されたサンプリングの割合。
- fields（マップ）: 列名とそのデータプロファイルのマップ。uniqueness、nullness、topN の値などの指標と、numeric、string、datetime、array 列の型固有の統計情報が含まれます。
次のように payload.json ファイルを作成します。
```
 {
   "aspects": {
     "dataplex-types.global.data-profile": {
       "data": {
         "sourceDataInfo": {
         "scope": "ALL",
         "scannedRows": 100
       },
       "fields": {
         "col1": {
           "nullness": 0.0,
           "uniqueness": 0.1,
      "string": {
        "length": {
          "min": 1,
          "max": 20,
          "avg": 12.54
        }
      }
         }
       }
     }
   }
 }}
```
グラフプロファイル。graph-profile アスペクトタイプ（dataplex-types.global.graph-profile）は、非構造化データ分析情報から推論されたセマンティック構造（ノード、エッジ、フィールド）をキャプチャする AI 生成のシステムアスペクトです。Knowledge Catalog では、スキャン実行時にこのアスペクトが自動的に関連付けられますが、REST API を使用して、推論された分析情報を手動で更新または絞り込むことができます。詳細な手順とペイロードの例については、推論された分析情報を更新するをご覧ください。
汎用。一般的なエントリ情報には generic アスペクトタイプを使用します。フィールドには次のものがあります。
- type（文字列）: ユーザー指定のタイプを保存するフリーフォームフィールド。
- system（文字列）: カスタムエントリのシステム。
次のように payload.json ファイルを作成します。
```
{
  "aspects": {
    "dataplex-types.global.generic": {
      "data": {
        "type": "custom-type",
        "system": "custom-system"
      }
    }
  }
}
```
全ウィンドウ表示。overview アスペクトタイプを使用して、リッチテキストの説明を指定します。フィールドには次のものがあります。
- content（文字列）: エントリの概要。HTML 形式をサポートしています。
- links（配列）: ソースシステムリンクのリスト。各リンクには次のものが含まれます。
  - url（文字列）: リンクの URL。
  - title（文字列）: リンクのタイトル。
次のように payload.json ファイルを作成します。
```
{
  "aspects": {
    "dataplex-types.global.overview": {
      "data": {
        "content": "This is a <b>rich text</b> description.",
      "links": [
        {
          "url": "https://example.com",
          "title": "Example Link"
        }
      ]
    }
  }
}}
```
Schema. schema アスペクトタイプを使用して、データの構造を記述します。
- fields（配列）: スキーマフィールドのリスト。フィールドには次のものが含まれます。
  - name（文字列）: フィールドの名前。
  - dataType（文字列）: フィールドのデータ型。
  - metadataType（列挙型）: メタデータのタイプ（STRING、BOOLEAN など）。
  - mode（列挙型）: フィールドのモード（NULLABLE、REQUIRED、REPEATED）。
  - description（文字列）: フィールドの説明。
次のように payload.json ファイルを作成します。
```
{
  "aspects": {
    "dataplex-types.global.schema": {
      "data": {
        "fields": [
        {
          "name": "id",
          "dataType": "string",
          "metadataType": "STRING",
          "mode": "REQUIRED"
        }
      ]
    }
  }
}}
```
使用状況。使用状況指標を追跡するには、usage アスペクトタイプを使用します。フィールドには次のものがあります。
- metrics（配列）: 使用状況指標のリスト。各指標には次のものが含まれます。
  - name（文字列）: 指標の名前（views、reads など）。
  - timeSeries（配列）: 時系列データのリスト。各アイテムには次の情報が含まれます。
    - interval（文字列）: 集計間隔（30d など）。
    - value（整数）: 集計値。
- refreshTime（datetime）: 指標が最後に更新された時刻。
次のように payload.json ファイルを作成します。
```
{
  "aspects": {
    "dataplex-types.global.usage": {
      "data": {
        "metrics": [
        {
          "name": "views",
          "timeSeries": [
            {
              "interval": "30d",
              "value": 100
            }
          ]
        }
      ],
      "refreshTime": "2025-01-01T12:00:00Z"
    }
  }
}}
```

エントリリンクを作成する

エントリリンクを作成することで、2 つのエントリ間の関係を確立できます。

エントリリンクは、synonym などの対称リンク、または definition などの非対称リンクにできます。

C#

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for CreateEntryLink</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CreateEntryLinkRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        CreateEntryLinkRequest request = new CreateEntryLinkRequest
        {
            ParentAsEntryGroupName = EntryGroupName.FromProjectLocationEntryGroup("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]"),
            EntryLinkId = "",
            EntryLink = new EntryLink(),
        };
        // Make the request
        EntryLink response = catalogServiceClient.CreateEntryLink(request);
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.CreateEntryLinkRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateEntryLinkRequest.
	}
	resp, err := c.CreateEntryLink(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.CreateEntryLinkRequest;
import com.google.cloud.dataplex.v1.EntryGroupName;
import com.google.cloud.dataplex.v1.EntryLink;

public class SyncCreateEntryLink {

  public static void main(String[] args) throws Exception {
    syncCreateEntryLink();
  }

  public static void syncCreateEntryLink() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      CreateEntryLinkRequest request =
          CreateEntryLinkRequest.newBuilder()
              .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
              .setEntryLinkId("entryLinkId-1349584441")
              .setEntryLink(EntryLink.newBuilder().build())
              .build();
      EntryLink response = catalogServiceClient.createEntryLink(request);
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the parent Entry Group:
 *  `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
 */
// const parent = 'abc123'
/**
 *  Required. Entry Link identifier
 *  * Must contain only lowercase letters, numbers and hyphens.
 *  * Must start with a letter.
 *  * Must be between 1-63 characters.
 *  * Must end with a number or a letter.
 *  * Must be unique within the EntryGroup.
 */
// const entryLinkId = 'abc123'
/**
 *  Required. Entry Link resource.
 */
// const entryLink = {}

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callCreateEntryLink() {
  // Construct request
  const request = {
    parent,
    entryLinkId,
    entryLink,
  };

  // Run request
  const response = await dataplexClient.createEntryLink(request);
  console.log(response);
}

callCreateEntryLink();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_create_entry_link():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    entry_link = dataplex_v1.EntryLink()
    entry_link.entry_link_type = "entry_link_type_value"
    entry_link.entry_references.name = "name_value"
    entry_link.entry_references.type_ = "TARGET"

    request = dataplex_v1.CreateEntryLinkRequest(
        parent="parent_value",
        entry_link_id="entry_link_id_value",
        entry_link=entry_link,
    )

    # Make the request
    response = client.create_entry_link(request=request)

    # Handle the response
    print(response)

REST

必要なアスペクトを含むエントリリンクを作成するには、リクエスト本文にアスペクトデータを含めて entryLinks.create メソッドを使用します。

エントリリンクにアスペクトを追加する

エントリ間のリレーションに関する情報でメタデータを拡充するには、エントリリンクにアスペクトを追加します。

特定のアスペクトを必須にするようにエントリリンクタイプを構成できます。このようなタイプのエントリリンクを作成する場合は、必須のアスペクトを指定する必要があります。

これらのアスペクトは、次のようにエントリリンクの作成時または既存のエントリリンクの更新時に追加できます。

C#

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntryLink</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateEntryLinkRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryLinkRequest request = new UpdateEntryLinkRequest
        {
            EntryLink = new EntryLink(),
            AllowMissing = false,
            AspectKeys = { "", },
        };
        // Make the request
        EntryLink response = catalogServiceClient.UpdateEntryLink(request);
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateEntryLinkRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryLinkRequest.
	}
	resp, err := c.UpdateEntryLink(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.EntryLink;
import com.google.cloud.dataplex.v1.UpdateEntryLinkRequest;
import java.util.ArrayList;

public class SyncUpdateEntryLink {

  public static void main(String[] args) throws Exception {
    syncUpdateEntryLink();
  }

  public static void syncUpdateEntryLink() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateEntryLinkRequest request =
          UpdateEntryLinkRequest.newBuilder()
              .setEntryLink(EntryLink.newBuilder().build())
              .setAllowMissing(true)
              .addAllAspectKeys(new ArrayList<String>())
              .build();
      EntryLink response = catalogServiceClient.updateEntryLink(request);
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry Link resource.
 */
// const entryLink = {}
/**
 *  Optional. If set to true and the entry link doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. The map keys of the Aspects which the service should modify.
 *  It should be the aspect type reference in the format
 *  `{project_id_or_number}.{location_id}.{aspect_type_id}`.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callUpdateEntryLink() {
  // Construct request
  const request = {
    entryLink,
  };

  // Run request
  const response = await dataplexClient.updateEntryLink(request);
  console.log(response);
}

callUpdateEntryLink();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_entry_link():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    entry_link = dataplex_v1.EntryLink()
    entry_link.entry_link_type = "entry_link_type_value"
    entry_link.entry_references.name = "name_value"
    entry_link.entry_references.type_ = "TARGET"

    request = dataplex_v1.UpdateEntryLinkRequest(
        entry_link=entry_link,
    )

    # Make the request
    response = client.update_entry_link(request=request)

    # Handle the response
    print(response)

REST

エントリリンクを更新するには、entryLink 本文にアスペクトデータを含めて、entryLinks.patch メソッドを使用します。

エントリリンクでアスペクトを使用する場合、次の制限事項に注意してください。

オプションのアスペクトはサポートされていません。
データアスペクトはサポートされていません。
カスタム型の側面はサポートされていません。
管理できるのは、システムアスペクトタイプ（schema-join など）で定義された必須アスペクトのみです。
アスペクトのコンテンツに基づいてエントリリンクを検索することはできません。
エントリリンクアスペクトのインポートとエクスポートはサポートされていません。

エントリの既存のアスペクトを管理する

このセクションでは、エントリの既存のアスペクトを更新および削除する方法について説明します。

アスペクトを更新する

オプションのアスペクトは、カスタムエントリとシステムエントリの両方で編集できます。必須アスペクトを編集できるのは、カスタムエントリの場合のみです。

BigQuery テーブルなどのファーストパーティ（1P）システムエントリの場合、modifyEntry API を使用してアスペクトを更新できます。これにより、ソースシステムのメタデータ更新権限（BigQuery データ編集者など）を使用できます。

コンソール

Google Cloud コンソールで、Knowledge Catalog の [検索] ページに移動します。

[検索] に移動
検索プラットフォームが [Data Catalog] に設定されている場合は、[検索プラットフォームの選択] メニューで [Dataplex Universal Catalog] を選択します。
アスペクトを更新するエントリを検索して、そのエントリをクリックします。

[エントリの詳細] ページが開きます。

[詳細] タブをクリックします。
[タグとアスペクト] セクションで、更新するアスペクトまたはタグを展開し、[ 編集] をクリックします。
[アスペクトの編集] ウィンドウで、必須フィールドを更新します。
[保存] をクリックします。

gcloud

エントリまたはエントリの列のアスペクトを更新するには、gcloud dataplex entries update コマンドを使用します。

C#

using Google.Cloud.Dataplex.V1;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateEntryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryRequest.
	}
	resp, err := c.UpdateEntry(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.UpdateEntryRequest;
import com.google.protobuf.FieldMask;
import java.util.ArrayList;

public class SyncUpdateEntry {

  public static void main(String[] args) throws Exception {
    syncUpdateEntry();
  }

  public static void syncUpdateEntry() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateEntryRequest request =
          UpdateEntryRequest.newBuilder()
              .setEntry(Entry.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setAllowMissing(true)
              .setDeleteMissingAspects(true)
              .addAllAspectKeys(new ArrayList<String>())
              .build();
      Entry response = catalogServiceClient.updateEntry(request);
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry resource.
 */
// const entry = {}
/**
 *  Optional. Mask of fields to update. To update Aspects, the update_mask must
 *  contain the value "aspects".
 *  If the update_mask is empty, the service will update all modifiable fields
 *  present in the request.
 */
// const updateMask = {}
/**
 *  Optional. If set to true and the entry doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. If set to true and the aspect_keys specify aspect ranges, the
 *  service deletes any existing aspects from that range that weren't provided
 *  in the request.
 */
// const deleteMissingAspects = true
/**
 *  Optional. The map keys of the Aspects which the service should modify. It
 *  supports the following syntaxes:
 *  * `<aspect_type_reference>` - matches an aspect of the given type and empty
 *  path.
 *  * `<aspect_type_reference>@path` - matches an aspect of the given type and
 *  specified path. For example, to attach an aspect to a field that is
 *  specified by the `schema` aspect, the path should have the format
 *  `Schema.<field_name>`.
 *  * `<aspect_type_reference>@*` - matches aspects of the given type for all
 *  paths.
 *  * `*@path` - matches aspects of all types on the given path.
 *  The service will not remove existing aspects matching the syntax unless
 *  `delete_missing_aspects` is set to true.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callUpdateEntry() {
  // Construct request
  const request = {
    entry,
  };

  // Run request
  const response = await dataplexClient.updateEntry(request);
  console.log(response);
}

callUpdateEntry();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_entry():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    entry = dataplex_v1.Entry()
    entry.entry_type = "entry_type_value"

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

    # Make the request
    response = client.update_entry(request=request)

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_entry call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateEntryRequest.new

  # Call the update_entry method.
  result = client.update_entry request

  # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
  p result
end

REST

エントリまたはエントリの列のアスペクトを更新するには、entry.patch メソッドを使用します。

アスペクトを削除する

コンソール

Google Cloud コンソールで、Knowledge Catalog の [検索] ページに移動します。

[検索] に移動
検索プラットフォームが [Data Catalog] に設定されている場合は、[検索プラットフォームの選択] メニューで [Dataplex Universal Catalog] を選択します。
削除するアスペクトを含むエントリを検索して、そのエントリをクリックします。

[エントリの詳細] ページが開きます。

[詳細] タブをクリックします。
[タグとアスペクト] セクションで、削除するアスペクトまたはタグを展開し、 [削除] をクリックします。
[確認] をクリックします。

gcloud

エントリのアスペクトを削除するには、gcloud dataplex entries update コマンドを使用します。

C#

using Google.Cloud.Dataplex.V1;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateEntry</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateEntryRequest request = new UpdateEntryRequest
        {
            Entry = new Entry(),
            UpdateMask = new FieldMask(),
            AllowMissing = false,
            DeleteMissingAspects = false,
            AspectKeys = { "", },
        };
        // Make the request
        Entry response = catalogServiceClient.UpdateEntry(request);
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateEntryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryRequest.
	}
	resp, err := c.UpdateEntry(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.UpdateEntryRequest;
import com.google.protobuf.FieldMask;
import java.util.ArrayList;

public class SyncUpdateEntry {

  public static void main(String[] args) throws Exception {
    syncUpdateEntry();
  }

  public static void syncUpdateEntry() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateEntryRequest request =
          UpdateEntryRequest.newBuilder()
              .setEntry(Entry.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setAllowMissing(true)
              .setDeleteMissingAspects(true)
              .addAllAspectKeys(new ArrayList<String>())
              .build();
      Entry response = catalogServiceClient.updateEntry(request);
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Entry resource.
 */
// const entry = {}
/**
 *  Optional. Mask of fields to update. To update Aspects, the update_mask must
 *  contain the value "aspects".
 *  If the update_mask is empty, the service will update all modifiable fields
 *  present in the request.
 */
// const updateMask = {}
/**
 *  Optional. If set to true and the entry doesn't exist, the service will
 *  create it.
 */
// const allowMissing = true
/**
 *  Optional. If set to true and the aspect_keys specify aspect ranges, the
 *  service deletes any existing aspects from that range that weren't provided
 *  in the request.
 */
// const deleteMissingAspects = true
/**
 *  Optional. The map keys of the Aspects which the service should modify. It
 *  supports the following syntaxes:
 *  * `<aspect_type_reference>` - matches an aspect of the given type and empty
 *  path.
 *  * `<aspect_type_reference>@path` - matches an aspect of the given type and
 *  specified path. For example, to attach an aspect to a field that is
 *  specified by the `schema` aspect, the path should have the format
 *  `Schema.<field_name>`.
 *  * `<aspect_type_reference>@*` - matches aspects of the given type for all
 *  paths.
 *  * `*@path` - matches aspects of all types on the given path.
 *  The service will not remove existing aspects matching the syntax unless
 *  `delete_missing_aspects` is set to true.
 *  If this field is left empty, the service treats it as specifying
 *  exactly those Aspects present in the request.
 */
// const aspectKeys = ['abc','def']

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callUpdateEntry() {
  // Construct request
  const request = {
    entry,
  };

  // Run request
  const response = await dataplexClient.updateEntry(request);
  console.log(response);
}

callUpdateEntry();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_entry():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    entry = dataplex_v1.Entry()
    entry.entry_type = "entry_type_value"

    request = dataplex_v1.UpdateEntryRequest(
        entry=entry,
    )

    # Make the request
    response = client.update_entry(request=request)

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_entry call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_entry.
#
def update_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateEntryRequest.new

  # Call the update_entry method.
  result = client.update_entry request

  # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
  p result
end

REST

エントリのアスペクトを削除するには、entry.patch メソッドを使用します。

エントリリンクの既存のアスペクトを管理する

このセクションでは、エントリリンクの既存のアスペクトを更新する方法について説明します。

アスペクトを更新する

エントリリンクの場合、再利用可能なシステムアスペクトタイプを使用する必須アスペクトのみを更新できます。

詳細については、エントリリンクオペレーションの IAM 権限をご覧ください。

REST

必要なアスペクトを使用してエントリリンクを更新するには、リクエスト本文にアスペクトデータを含めて entryLinks.patch メソッドを使用します。

アスペクトを削除する

エントリリンクの必須アスペクトは削除できません。

アスペクトタイプを管理する

このセクションでは、アスペクトタイプを表示する方法と、カスタムアスペクトタイプを更新および削除する方法について説明します。

使用可能なアスペクトタイプとタグテンプレートのリストを表示する

コンソール

Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。

[メタデータのタイプ] に移動
[アスペクトタイプとタグテンプレート] タブをクリックします。

このページには、使用可能な Knowledge Catalog アスペクトタイプと Data Catalog タグテンプレートがすべて一覧表示されます。

カスタムアスペクトタイプとタグテンプレートを表示するには、[カスタム] タブをクリックします。[カスタム] タブの [カタログソース] 列に、リソースが存在する場所（Knowledge Catalog または Data Catalog）が表示されます。

システムアスペクトタイプを表示するには、[システム] タブをクリックします。

カスタムアスペクトタイプとシステムアスペクトタイプの詳細については、このドキュメントのアスペクトタイプのカテゴリをご覧ください。

省略可: 選択したプロジェクトのアスペクトタイプとタグテンプレートのリストを表示するには、[カスタム] タブをクリックし、[すべてのプロジェクトから表示] をクリックしてオフに切り替えます。

[すべてのプロジェクトから表示] 切り替えボタンはデフォルトでオンになっています。リストには、選択した組織の Knowledge Catalog リソースと、アクセスできるすべての組織の Data Catalog リソースが含まれます。

gcloud

使用可能なすべてのアスペクトタイプを一覧表示するには、gcloud dataplex aspect-types list コマンドを使用します。

C#

using Google.Api.Gax;
using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using System;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for ListAspectTypes</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void ListAspectTypesRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        ListAspectTypesRequest request = new ListAspectTypesRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            Filter = "",
            OrderBy = "",
        };
        // Make the request
        PagedEnumerable<ListAspectTypesResponse, AspectType> response = catalogServiceClient.ListAspectTypes(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (AspectType item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (ListAspectTypesResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (AspectType item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<AspectType> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (AspectType item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.ListAspectTypesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListAspectTypesRequest.
	}
	it := c.ListAspectTypes(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataplexpb.ListAspectTypesResponse)
	}
}

Java

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.ListAspectTypesRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncListAspectTypes {

  public static void main(String[] args) throws Exception {
    syncListAspectTypes();
  }

  public static void syncListAspectTypes() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      ListAspectTypesRequest request =
          ListAspectTypesRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setFilter("filter-1274492040")
              .setOrderBy("orderBy-1207110587")
              .build();
      for (AspectType element : catalogServiceClient.listAspectTypes(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType location, of the form:
 *  `projects/{project_number}/locations/{location_id}`
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Optional. Maximum number of AspectTypes to return. The service may return
 *  fewer than this value. If unspecified, the service returns at most 10
 *  AspectTypes. The maximum value is 1000; values above 1000 will be coerced
 *  to 1000.
 */
// const pageSize = 1234
/**
 *  Optional. Page token received from a previous `ListAspectTypes` call.
 *  Provide this to retrieve the subsequent page. When paginating, all other
 *  parameters you provide to `ListAspectTypes` must match the call that
 *  provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Filter request. Filters are case-sensitive.
 *  The service supports the following formats:
 *  * labels.key1 = "value1"
 *  * labels:key1
 *  * name = "value"
 *  These restrictions can be conjoined with AND, OR, and NOT conjunctions.
 */
// const filter = 'abc123'
/**
 *  Optional. Orders the result by `name` or `create_time` fields.
 *  If not specified, the ordering is undefined.
 */
// const orderBy = 'abc123'

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callListAspectTypes() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = dataplexClient.listAspectTypesAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callListAspectTypes();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_list_aspect_types():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.ListAspectTypesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_aspect_types(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the list_aspect_types call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#list_aspect_types.
#
def list_aspect_types
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::ListAspectTypesRequest.new

  # Call the list_aspect_types method.
  result = client.list_aspect_types request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::Dataplex::V1::AspectType.
    p item
  end
end

REST

使用可能なアスペクトタイプをすべて一覧表示するには、aspectTypes.list メソッドを使用します。

アスペクトタイプまたはタグテンプレートの詳細を表示する

コンソール

Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。

[メタデータのタイプ] に移動
[アスペクトタイプとタグテンプレート] タブをクリックします。
Knowledge Catalog のアスペクトタイプの詳細を表示するには、アスペクトタイプをクリックします。アスペクトタイプの詳細ページが開きます。ここでは、表示名、アスペクトタイプ ID、説明、プロジェクト ID、ロケーション、ラベル、作成日、最終更新日などの詳細にアクセスできます。
- 選択したアスペクトタイプの構造を表示するには、[テンプレート] タブをクリックします。
- 最近作成された関連エントリのリスト（10 件）を表示するには、[サンプルエントリ] タブをクリックします。
- 関連するすべてのエントリを検索するには、[検索結果の関連エントリをすべて表示] をクリックします。このボタンは、関連するエントリが 1 つ以上ある場合にのみ表示されます。
Data Catalog タグテンプレートの詳細を表示するには、タグテンプレートをクリックします。Data Catalog でタグテンプレートの詳細ページが開きます。ここで、表示名、テンプレート ID、プロジェクト ID、ロケーション、公開設定、ラベルなどの詳細にアクセスできます。

gcloud

アスペクトタイプの詳細を取得するには、gcloud dataplex aspect-types describe コマンドを使用します。

C#

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for GetAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void GetAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        GetAspectTypeRequest request = new GetAspectTypeRequest
        {
            AspectTypeName = AspectTypeName.FromProjectLocationAspectType("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]"),
        };
        // Make the request
        AspectType response = catalogServiceClient.GetAspectType(request);
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.GetAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetAspectTypeRequest.
	}
	resp, err := c.GetAspectType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.GetAspectTypeRequest;

public class SyncGetAspectType {

  public static void main(String[] args) throws Exception {
    syncGetAspectType();
  }

  public static void syncGetAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      GetAspectTypeRequest request =
          GetAspectTypeRequest.newBuilder()
              .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
              .build();
      AspectType response = catalogServiceClient.getAspectType(request);
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType:
 *  `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
 */
// const name = 'abc123'

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callGetAspectType() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const response = await dataplexClient.getAspectType(request);
  console.log(response);
}

callGetAspectType();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_get_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.GetAspectTypeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_aspect_type(request=request)

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the get_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#get_aspect_type.
#
def get_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::GetAspectTypeRequest.new

  # Call the get_aspect_type method.
  result = client.get_aspect_type request

  # The returned object is of type Google::Cloud::Dataplex::V1::AspectType.
  p result
end

REST

アスペクトタイプの詳細を取得するには、aspectTypes.get メソッドを使用します。

カスタムのアスペクトタイプを更新する

カスタムアスペクトタイプの表示名、説明、テンプレートフィールド、ラベルを更新できます。テンプレートの既存のフィールドは削除できません。

アスペクトタイプの作成後に、アスペクトタイプの ID とロケーションを更新することはできません。

コンソール

Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。

[メタデータのタイプ] に移動
[アスペクトタイプとタグテンプレート] タブをクリックします。
更新するアスペクトタイプをクリックします。
[アスペクトタイプの詳細] ページで、[編集] をクリックします。
必要に応じて、表示名、説明、テンプレートフィールド、ラベルを編集します。
省略可: アスペクトタイプのフィールドを非推奨としてマークするには、次の操作を行います。
1. [テンプレート] セクションで、フィールドを開きます。
2. [非推奨] を選択します。
3. [非推奨の理由] フィールドに、選択したフィールドを非推奨にする理由を入力します。
4. [完了] をクリックします。
5. [保存] をクリックします。

gcloud

カスタムのアスペクトタイプを更新するには、gcloud dataplex aspect-types update コマンドを使用します。

C#

using Google.Cloud.Dataplex.V1;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for UpdateAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void UpdateAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        UpdateAspectTypeRequest request = new UpdateAspectTypeRequest
        {
            AspectType = new AspectType(),
            UpdateMask = new FieldMask(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<AspectType, OperationMetadata> response = catalogServiceClient.UpdateAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<AspectType, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        AspectType result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<AspectType, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceUpdateAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            AspectType retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.UpdateAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateAspectTypeRequest.
	}
	op, err := c.UpdateAspectType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

import com.google.cloud.dataplex.v1.AspectType;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.UpdateAspectTypeRequest;
import com.google.protobuf.FieldMask;

public class SyncUpdateAspectType {

  public static void main(String[] args) throws Exception {
    syncUpdateAspectType();
  }

  public static void syncUpdateAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      UpdateAspectTypeRequest request =
          UpdateAspectTypeRequest.newBuilder()
              .setAspectType(AspectType.newBuilder().build())
              .setUpdateMask(FieldMask.newBuilder().build())
              .setValidateOnly(true)
              .build();
      AspectType response = catalogServiceClient.updateAspectTypeAsync(request).get();
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. AspectType Resource
 */
// const aspectType = {}
/**
 *  Required. Mask of fields to update.
 */
// const updateMask = {}
/**
 *  Optional. Only validate the request, but do not perform mutations.
 *  The default is false.
 */
// const validateOnly = true

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callUpdateAspectType() {
  // Construct request
  const request = {
    aspectType,
    updateMask,
  };

  // Run request
  const [operation] = await dataplexClient.updateAspectType(request);
  const [response] = await operation.promise();
  console.log(response);
}

callUpdateAspectType();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_update_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    aspect_type = dataplex_v1.AspectType()
    aspect_type.metadata_template.name = "name_value"
    aspect_type.metadata_template.type_ = "type__value"

    request = dataplex_v1.UpdateAspectTypeRequest(
        aspect_type=aspect_type,
    )

    # Make the request
    operation = client.update_aspect_type(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the update_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#update_aspect_type.
#
def update_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::UpdateAspectTypeRequest.new

  # Call the update_aspect_type method.
  result = client.update_aspect_type request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

カスタムのアスペクトタイプを更新するには、aspectTypes.patch メソッドを使用します。

カスタムのアスペクトタイプを削除する

コンソール

Google Cloud コンソールで、Knowledge Catalog の [メタデータのタイプ] ページに移動します。

[メタデータのタイプ] に移動
[アスペクトタイプとタグテンプレート] タブをクリックします。
削除するアスペクトタイプをクリックします。
[アスペクトタイプの詳細] ページで、[削除] をクリックします。表示されるメッセージを確認します。

gcloud

カスタムのアスペクトタイプを削除するには、gcloud dataplex aspect-types delete コマンドを使用します。

C#

using Google.Cloud.Dataplex.V1;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for DeleteAspectType</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void DeleteAspectTypeRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        DeleteAspectTypeRequest request = new DeleteAspectTypeRequest
        {
            AspectTypeName = AspectTypeName.FromProjectLocationAspectType("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]"),
            Etag = "",
        };
        // Make the request
        Operation<Empty, OperationMetadata> response = catalogServiceClient.DeleteAspectType(request);

        // Poll until the returned long-running operation is complete
        Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        Empty result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<Empty, OperationMetadata> retrievedResponse = catalogServiceClient.PollOnceDeleteAspectType(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Empty retrievedResult = retrievedResponse.Result;
        }
    }
}

Go


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.DeleteAspectTypeRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteAspectTypeRequest.
	}
	op, err := c.DeleteAspectType(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

Java

import com.google.cloud.dataplex.v1.AspectTypeName;
import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.DeleteAspectTypeRequest;
import com.google.protobuf.Empty;

public class SyncDeleteAspectType {

  public static void main(String[] args) throws Exception {
    syncDeleteAspectType();
  }

  public static void syncDeleteAspectType() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      DeleteAspectTypeRequest request =
          DeleteAspectTypeRequest.newBuilder()
              .setName(AspectTypeName.of("[PROJECT]", "[LOCATION]", "[ASPECT_TYPE]").toString())
              .setEtag("etag3123477")
              .build();
      catalogServiceClient.deleteAspectTypeAsync(request).get();
    }
  }
}

Node.js

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AspectType:
 *  `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
 */
// const name = 'abc123'
/**
 *  Optional. If the client provided etag value does not match the current etag
 *  value, the DeleteAspectTypeRequest method returns an ABORTED error
 *  response.
 */
// const etag = 'abc123'

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callDeleteAspectType() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const [operation] = await dataplexClient.deleteAspectType(request);
  const [response] = await operation.promise();
  console.log(response);
}

callDeleteAspectType();

Python

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_delete_aspect_type():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.DeleteAspectTypeRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_aspect_type(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

require "google/cloud/dataplex/v1"

##
# Snippet for the delete_aspect_type call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#delete_aspect_type.
#
def delete_aspect_type
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::DeleteAspectTypeRequest.new

  # Call the delete_aspect_type method.
  result = client.delete_aspect_type request

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

REST

既存のアスペクトタイプを削除するには、aspectTypes.delete メソッドを使用します。

次のステップ

Knowledge Catalog でリソースを検索する方法を確認する。
エントリの管理方法とカスタムソースを取り込む方法を学習する。
メタデータを Knowledge Catalog にインポートする方法を確認する。
Knowledge Catalog のメタデータの詳細を確認する。
Data Catalog から Knowledge Catalog への移行の詳細を確認する。
基盤となるデータコンテキストを確立する方法を学習する。
Knowledge Catalog のユースケースを試す。

アスペクトを管理してメタデータを拡充する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

アスペクト タイプとは

アスペクト タイプのカテゴリ

カスタムのアスペクト タイプ

システムのアスペクト タイプ

アスペクトとは

アスペクトの配置とターゲット レベル

アスペクトのカテゴリ

必須アスペクト

オプションのアスペクト

データ アスペクト

始める前に

必要なロール

API を有効にする

カスタムのアスペクト タイプを作成する

コンソール

gcloud

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

Ruby

Ruby

REST

レコード ID フィールドとレコード参照フィールドの使用例

エントリにアスペクトを追加する

コンソール

gcloud

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

Ruby

Ruby

REST

再利用可能なシステム アスペクト タイプのアスペクトを関連付ける

データ品質スコアカード

gcloud

REST

その他の再利用可能なアスペクト タイプ

エントリリンクを作成する

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

REST

エントリリンクにアスペクトを追加する

C#

C#

Go

Go

Java

Java

Node.js

Node.js

Python

Python

REST

エントリの既存のアスペクトを管理する

アスペクトを更新する

コンソール

gcloud

アスペクトを管理してメタデータを拡充する

アスペクトタイプとは

アスペクトタイプのカテゴリ

カスタムのアスペクトタイプ

システムのアスペクトタイプ

アスペクトの配置とターゲットレベル

データアスペクト

カスタムのアスペクトタイプを作成する

再利用可能なシステムアスペクトタイプのアスペクトを関連付ける

その他の再利用可能なアスペクトタイプ

アスペクトタイプを管理する

使用可能なアスペクトタイプとタグテンプレートのリストを表示する

アスペクトタイプまたはタグテンプレートの詳細を表示する

カスタムのアスペクトタイプを更新する