MCP Tools Reference: dataform.googleapis.com

ツール: create_release_config

指定された Dataform リポジトリに新しいリリース構成を作成します。

parent パラメータの値は projects/{project_id}/locations/{location}/repositories/{repository} 形式にする必要があります。

release_config_id は、リリース構成のユーザー定義 ID です。ユーザーが ID を指定しない場合は、リクエストに基づいて小文字、数字、ハイフンを使用して、短く説明的な ID を生成します。

次のサンプルは、curl を使用して create_release_config MCP ツールを呼び出す方法を示しています。

Curl リクエスト 
                  
curl --location 'https://dataform.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "create_release_config",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

入力スキーマ

CreateReleaseConfig リクエスト メッセージ。

CreateReleaseConfigRequest

JSON 表現 
{
  "parent": string,
  "releaseConfig": {
    object (ReleaseConfig)
  },
  "releaseConfigId": string
}
フィールド
parent

string

必須。リリース構成を作成するリポジトリ。projects/*/locations/*/repositories/* の形式で指定してください。
releaseConfig

object (ReleaseConfig)

必須。作成するリリース構成。
releaseConfigId

string

必須。リリース構成に使用する ID。リリース構成のリソース名の最終的なコンポーネントになります。

ReleaseConfig

JSON 表現 
{
  "name": string,
  "gitCommitish": string,
  "codeCompilationConfig": {
    object (CodeCompilationConfig)
  },
  "cronSchedule": string,
  "timeZone": string,
  "recentScheduledReleaseRecords": [
    {
      object (ScheduledReleaseRecord)
    }
  ],
  "releaseCompilationResult": string,
  "disabled": boolean,

  // Union field _internal_metadata can be only one of the following:
  "internalMetadata": string
  // End of list of possible types for union field _internal_metadata.
}
フィールド
name

string

ID。リリース構成の名前。
gitCommitish

string

必須。リポジトリをコンパイルする Git コミット/タグ/ブランチ名。リモート リポジトリに存在する必要があります。例: - commit SHA: 12ade345 - タグ: tag1 - ブランチ名: branch1
codeCompilationConfig

object (CodeCompilationConfig)

省略可。設定すると、code_compilation_config のフィールドは dataform.json で指定されたデフォルトのコンパイル設定をオーバーライドします。
cronSchedule

string

省略可。コンパイル結果の自動作成のオプションのスケジュール（cron 形式）。
timeZone

string

省略可。cron_schedule の解釈に使用するタイムゾーンを指定します。タイムゾーン データベースのタイムゾーン名である必要があります。指定しない場合は、デフォルトで UTC が使用されます。
recentScheduledReleaseRecords[]

object (ScheduledReleaseRecord)

出力専用。直近 10 件のスケジュール設定されたリリース試行のレコード。release_time の降順で並べ替えられます。cron_schedule によってコンパイル結果の自動作成がトリガーされるたびに更新されます。
releaseCompilationResult

string

省略可。このリリース構成用に現在リリースされているコンパイル結果の名前。この値は、このリリース構成からコンパイル結果が自動的に作成されたとき（cron_schedule を使用）、またはこのリソースが API 呼び出しによって更新されたとき（以前のリリースにロールバックするためなど）に更新されます。コンパイル結果は、このリリース設定を使用して作成されている必要があります。projects/*/locations/*/repositories/*/compilationResults/* の形式で指定してください。
disabled

boolean

省略可。コンパイル結果の自動作成を無効にします。

共用体フィールド _internal_metadata。

_internal_metadata は次のいずれかになります。
internalMetadata

string

出力専用。リソースの提供に内部で使用されるすべてのメタデータ情報。たとえば、タイムスタンプ、フラグ、ステータス フィールドなどです。このフィールドの形式は JSON 文字列です。

CodeCompilationConfig

JSON 表現 
{
  "defaultDatabase": string,
  "defaultSchema": string,
  "defaultLocation": string,
  "assertionSchema": string,
  "vars": {
    string: string,
    ...
  },
  "databaseSuffix": string,
  "schemaSuffix": string,
  "tablePrefix": string,
  "builtinAssertionNamePrefix": string,
  "defaultNotebookRuntimeOptions": {
    object (NotebookRuntimeOptions)
  },
  "pipelineConfig": {
    object (PipelineConfig)
  }
}
フィールド
defaultDatabase

string

省略可。デフォルト データベース（Google Cloud プロジェクト ID）。
defaultSchema

string

省略可。デフォルトのスキーマ（BigQuery データセット ID）。
defaultLocation

string

省略可。使用するデフォルトの BigQuery のロケーション。デフォルトは「US」です。ロケーションの完全なリストについては、BigQuery のドキュメント（https://cloud.google.com/bigquery/docs/locations）をご覧ください。
assertionSchema

string

省略可。アサーションのデフォルトのスキーマ（BigQuery データセット ID）
vars

map (key: string, value: string)

省略可。コンパイル中にプロジェクト コードで使用できるユーザー定義変数。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
databaseSuffix

string

省略可。すべてのデータベース（Google Cloud プロジェクト ID）名に追加する接尾辞。
schemaSuffix

string

省略可。すべてのスキーマ（BigQuery データセット ID）名に追加する接尾辞。
tablePrefix

string

省略可。すべてのテーブル名の先頭に追加する接頭辞。
builtinAssertionNamePrefix

string

省略可。組み込みアサーション名の先頭に付加する接頭辞。
defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

省略可。デフォルトのノートブック ランタイム オプション。
pipelineConfig

object (PipelineConfig)

省略可。パイプラインのタイプと Git リポジトリ内のパスを定義するパイプライン オプション。

VarsEntry

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string
value

string

NotebookRuntimeOptions

JSON 表現 
{
  "aiPlatformNotebookRuntimeTemplate": string,

  // Union field execution_sink can be only one of the following:
  "gcsOutputBucket": string
  // End of list of possible types for union field execution_sink.

  // Union field repository_snapshot_storage can be only one of the following:
  "gcsRepositorySnapshotDestination": {
    object (GcsRepositorySnapshotDestination)
  }
  // End of list of possible types for union field repository_snapshot_storage.
}
フィールド
aiPlatformNotebookRuntimeTemplate

string

省略可。ノートブック実行用のランタイムが作成される Colab ランタイム テンプレートのリソース名。指定しない場合、ランタイムは Colab のデフォルトの仕様で作成されます。
共用体フィールド execution_sink。ノートブックの実行結果を保存する場所。execution_sink は次のいずれかになります。
gcsOutputBucket

string

省略可。結果をアップロードする Google Cloud Storage のロケーション。形式: gs://bucket-name。
共用体フィールド repository_snapshot_storage。ノートブック ランタイム repository_snapshot_storage 内で読み取り専用アクセスに使用できるレポジトリ ファイルのスナップショットの宛先は、次のいずれか 1 つのみです。
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

省略可。スナップショットのアップロード先となる Google Cloud Storage。URI が空の場合、デフォルトで指定された gcs_output_bucket になります。形式: gs://bucket-name/path/。

GcsRepositorySnapshotDestination

JSON 表現 
{
  "repositorySnapshotUri": string
}
フィールド
repositorySnapshotUri

string

省略可。リポジトリ スナップショットのアップロード先となる Google Cloud Storage。形式: gs://bucket-name/path/。

PipelineConfig

JSON 表現 
{
  "pipelineType": enum (PipelineType),
  "path": string
}
フィールド
pipelineType

enum (PipelineType)

必須。パイプラインのタイプ。
path

string

必須。パイプラインが定義されている Git リポジトリ内の相対パス。たとえば、Dataform パイプラインの場合、workflow_settings.yaml または dataform.json があるフォルダへのパスです。

ScheduledReleaseRecord

JSON 表現 
{
  "releaseTime": string,

  // Union field result can be only one of the following:
  "compilationResult": string,
  "errorStatus": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
フィールド
releaseTime

string (Timestamp format)

出力専用。このリリース試行のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
共用体フィールド result。このリリース試行の結果。result は次のいずれかになります。
compilationResult

string

コンパイル結果が正常に作成された場合は、作成されたコンパイル結果の名前。projects/*/locations/*/repositories/*/compilationResults/* の形式で指定してください。
errorStatus

object (Status)

コンパイル結果の作成を試みたときに発生したエラー ステータス（試みが失敗した場合）。

ステータス

JSON 表現 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。
message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。
details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクトであり、型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

すべて

JSON 表現 
{
  "typeUrl": string,
  "value": string
}
フィールド
typeUrl

string

シリアル化された Protobuf メッセージの型を識別します。URI 参照は、スラッシュで終わる接頭辞と完全修飾型名で構成されます。

例: type.googleapis.com/google.protobuf.StringValue

この文字列には / 文字を 1 つ以上含める必要があり、最後の / の後のコンテンツは、先頭のドットのない正規形式の型の完全修飾名である必要があります。クライアントが連絡を試みないように、これらの URI 参照にスキームを記述しないでください。

接頭辞は任意であり、Protobuf 実装では、最後の / までを削除して型を識別することが想定されています。type.googleapis.com/ は、一部のレガシー実装で必要な一般的なデフォルトの接頭辞です。この接頭辞は型のオリジンを示すものではなく、これを含む URI はリクエストに応答しないことが想定されています。

すべての型 URL 文字列は、有効な URI 参照である必要があります。また、テキスト形式の場合、参照の内容は英数字、パーセント エンコードされたエスケープ、および次のセットの文字（外側のバッククォートを除く）のみで構成されている必要があります。/-.~_!$&()*+,;=。パーセント エンコーディングは許可されていますが、既存のパーサーとの混同を避けるため、実装ではエスケープ解除しないでください。たとえば、type.googleapis.com%2FFoo は拒否される必要があります。

Any の元の設計では、これらの型 URL で型解決サービスを起動する可能性が検討されていましたが、Protobuf は実装していません。また、これらの URL へのアクセスは問題があり、セキュリティ上の問題を引き起こす可能性があると考えています。連絡先タイプの URL にアクセスしないでください。
value

string (bytes format)

type_url で記述された型の Protobuf シリアル化を保持します。

Base64 でエンコードされた文字列。

タイムスタンプ

JSON 表現 
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800～253402300799 の範囲（両端を含む）にする必要があります（これは 0001-01-01T00:00:00Z～9999-12-31T23:59:59Z に対応します）。
nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0～999,999,999 にする必要があります（両端を含む）。

PipelineType

パイプラインのタイプ。この期間は今後延長される可能性があります。UNSPECIFIED の場合は、エラーがスローされます。

列挙型
PIPELINE_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
DATAFORM 通常の Dataform パイプライン。
SQL SQL 単一ファイル アセット。
NOTEBOOK ノートブックの単一ファイル アセット。

出力スキーマ

Dataform リリース構成を表します。

ReleaseConfig

JSON 表現 
{
  "name": string,
  "gitCommitish": string,
  "codeCompilationConfig": {
    object (CodeCompilationConfig)
  },
  "cronSchedule": string,
  "timeZone": string,
  "recentScheduledReleaseRecords": [
    {
      object (ScheduledReleaseRecord)
    }
  ],
  "releaseCompilationResult": string,
  "disabled": boolean,

  // Union field _internal_metadata can be only one of the following:
  "internalMetadata": string
  // End of list of possible types for union field _internal_metadata.
}
フィールド
name

string

ID。リリース構成の名前。
gitCommitish

string

必須。リポジトリをコンパイルする Git コミット/タグ/ブランチ名。リモート リポジトリに存在する必要があります。例: - commit SHA: 12ade345 - タグ: tag1 - ブランチ名: branch1
codeCompilationConfig

object (CodeCompilationConfig)

省略可。設定すると、code_compilation_config のフィールドは dataform.json で指定されたデフォルトのコンパイル設定をオーバーライドします。
cronSchedule

string

省略可。コンパイル結果の自動作成のオプションのスケジュール（cron 形式）。
timeZone

string

省略可。cron_schedule の解釈に使用するタイムゾーンを指定します。タイムゾーン データベースのタイムゾーン名である必要があります。指定しない場合は、デフォルトで UTC が使用されます。
recentScheduledReleaseRecords[]

object (ScheduledReleaseRecord)

出力専用。直近 10 件のスケジュール設定されたリリース試行のレコード。release_time の降順で並べ替えられます。cron_schedule によってコンパイル結果の自動作成がトリガーされるたびに更新されます。
releaseCompilationResult

string

省略可。このリリース構成用に現在リリースされているコンパイル結果の名前。この値は、このリリース構成からコンパイル結果が自動的に作成されたとき（cron_schedule を使用）、またはこのリソースが API 呼び出しによって更新されたとき（以前のリリースにロールバックするためなど）に更新されます。コンパイル結果は、このリリース設定を使用して作成されている必要があります。projects/*/locations/*/repositories/*/compilationResults/* の形式で指定してください。
disabled

boolean

省略可。コンパイル結果の自動作成を無効にします。

共用体フィールド _internal_metadata。

_internal_metadata は次のいずれかになります。
internalMetadata

string

出力専用。リソースの提供に内部で使用されるすべてのメタデータ情報。たとえば、タイムスタンプ、フラグ、ステータス フィールドなどです。このフィールドの形式は JSON 文字列です。

CodeCompilationConfig

JSON 表現 
{
  "defaultDatabase": string,
  "defaultSchema": string,
  "defaultLocation": string,
  "assertionSchema": string,
  "vars": {
    string: string,
    ...
  },
  "databaseSuffix": string,
  "schemaSuffix": string,
  "tablePrefix": string,
  "builtinAssertionNamePrefix": string,
  "defaultNotebookRuntimeOptions": {
    object (NotebookRuntimeOptions)
  },
  "pipelineConfig": {
    object (PipelineConfig)
  }
}
フィールド
defaultDatabase

string

省略可。デフォルト データベース（Google Cloud プロジェクト ID）。
defaultSchema

string

省略可。デフォルトのスキーマ（BigQuery データセット ID）。
defaultLocation

string

省略可。使用するデフォルトの BigQuery のロケーション。デフォルトは「US」です。ロケーションの完全なリストについては、BigQuery のドキュメント（https://cloud.google.com/bigquery/docs/locations）をご覧ください。
assertionSchema

string

省略可。アサーションのデフォルトのスキーマ（BigQuery データセット ID）
vars

map (key: string, value: string)

省略可。コンパイル中にプロジェクト コードで使用できるユーザー定義変数。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
databaseSuffix

string

省略可。すべてのデータベース（Google Cloud プロジェクト ID）名に追加する接尾辞。
schemaSuffix

string

省略可。すべてのスキーマ（BigQuery データセット ID）名に追加する接尾辞。
tablePrefix

string

省略可。すべてのテーブル名の先頭に追加する接頭辞。
builtinAssertionNamePrefix

string

省略可。組み込みアサーション名の先頭に付加する接頭辞。
defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

省略可。デフォルトのノートブック ランタイム オプション。
pipelineConfig

object (PipelineConfig)

省略可。パイプラインのタイプと Git リポジトリ内のパスを定義するパイプライン オプション。

VarsEntry

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string
value

string

NotebookRuntimeOptions

JSON 表現 
{
  "aiPlatformNotebookRuntimeTemplate": string,

  // Union field execution_sink can be only one of the following:
  "gcsOutputBucket": string
  // End of list of possible types for union field execution_sink.

  // Union field repository_snapshot_storage can be only one of the following:
  "gcsRepositorySnapshotDestination": {
    object (GcsRepositorySnapshotDestination)
  }
  // End of list of possible types for union field repository_snapshot_storage.
}
フィールド
aiPlatformNotebookRuntimeTemplate

string

省略可。ノートブック実行用のランタイムが作成される Colab ランタイム テンプレートのリソース名。指定しない場合、ランタイムは Colab のデフォルトの仕様で作成されます。
共用体フィールド execution_sink。ノートブックの実行結果を保存する場所。execution_sink は次のいずれかになります。
gcsOutputBucket

string

省略可。結果をアップロードする Google Cloud Storage のロケーション。形式: gs://bucket-name。
共用体フィールド repository_snapshot_storage。ノートブック ランタイム repository_snapshot_storage 内で読み取り専用アクセスに使用できるレポジトリ ファイルのスナップショットの宛先は、次のいずれか 1 つのみです。
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

省略可。スナップショットのアップロード先となる Google Cloud Storage。URI が空の場合、デフォルトで指定された gcs_output_bucket になります。形式: gs://bucket-name/path/。

GcsRepositorySnapshotDestination

JSON 表現 
{
  "repositorySnapshotUri": string
}
フィールド
repositorySnapshotUri

string

省略可。リポジトリ スナップショットのアップロード先となる Google Cloud Storage。形式: gs://bucket-name/path/。

PipelineConfig

JSON 表現 
{
  "pipelineType": enum (PipelineType),
  "path": string
}
フィールド
pipelineType

enum (PipelineType)

必須。パイプラインのタイプ。
path

string

必須。パイプラインが定義されている Git リポジトリ内の相対パス。たとえば、Dataform パイプラインの場合、workflow_settings.yaml または dataform.json があるフォルダへのパスです。

ScheduledReleaseRecord

JSON 表現 
{
  "releaseTime": string,

  // Union field result can be only one of the following:
  "compilationResult": string,
  "errorStatus": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
フィールド
releaseTime

string (Timestamp format)

出力専用。このリリース試行のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
共用体フィールド result。このリリース試行の結果。result は次のいずれかになります。
compilationResult

string

コンパイル結果が正常に作成された場合は、作成されたコンパイル結果の名前。projects/*/locations/*/repositories/*/compilationResults/* の形式で指定してください。
errorStatus

object (Status)

コンパイル結果の作成を試みたときに発生したエラー ステータス（試みが失敗した場合）。

ステータス

JSON 表現 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。
message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。
details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクトであり、型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

すべて

JSON 表現 
{
  "typeUrl": string,
  "value": string
}
フィールド
typeUrl

string

シリアル化された Protobuf メッセージの型を識別します。URI 参照は、スラッシュで終わる接頭辞と完全修飾型名で構成されます。

例: type.googleapis.com/google.protobuf.StringValue

この文字列には / 文字を 1 つ以上含める必要があり、最後の / の後のコンテンツは、先頭のドットのない正規形式の型の完全修飾名である必要があります。クライアントが連絡を試みないように、これらの URI 参照にスキームを記述しないでください。

接頭辞は任意であり、Protobuf 実装では、最後の / までを削除して型を識別することが想定されています。type.googleapis.com/ は、一部のレガシー実装で必要な一般的なデフォルトの接頭辞です。この接頭辞は型のオリジンを示すものではなく、これを含む URI はリクエストに応答しないことが想定されています。

すべての型 URL 文字列は、有効な URI 参照である必要があります。また、テキスト形式の場合、参照の内容は英数字、パーセント エンコードされたエスケープ、および次のセットの文字（外側のバッククォートを除く）のみで構成されている必要があります。/-.~_!$&()*+,;=。パーセント エンコーディングは許可されていますが、既存のパーサーとの混同を避けるため、実装ではエスケープ解除しないでください。たとえば、type.googleapis.com%2FFoo は拒否される必要があります。

Any の元の設計では、これらの型 URL で型解決サービスを起動する可能性が検討されていましたが、Protobuf は実装していません。また、これらの URL へのアクセスは問題があり、セキュリティ上の問題を引き起こす可能性があると考えています。連絡先タイプの URL にアクセスしないでください。
value

string (bytes format)

type_url で記述された型の Protobuf シリアル化を保持します。

Base64 でエンコードされた文字列。

タイムスタンプ

JSON 表現 
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800～253402300799 の範囲（両端を含む）にする必要があります（これは 0001-01-01T00:00:00Z～9999-12-31T23:59:59Z に対応します）。
nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0～999,999,999 にする必要があります（両端を含む）。

PipelineType

パイプラインのタイプ。この期間は今後延長される可能性があります。UNSPECIFIED の場合は、エラーがスローされます。

列挙型
PIPELINE_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
DATAFORM 通常の Dataform パイプライン。
SQL SQL 単一ファイル アセット。
NOTEBOOK ノートブックの単一ファイル アセット。

ツールのアノテーション

破壊的ヒント: ❌ | べき等ヒント: ❌ | 読み取り専用ヒント: ❌ | オープン ワールド ヒント: ❌