MCP Tools Reference: dataform.googleapis.com

Alat: get_compilation_result

Mengambil satu hasil kompilasi Dataform.

Nilai parameter name harus dalam format projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP get_compilation_result.

Permintaan 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": "get_compilation_result",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Skema Input

Pesan permintaan GetCompilationResult.

GetCompilationResultRequest

Representasi JSON 
{
  "name": string
}
Kolom
name

string

Wajib. Nama hasil kompilasi.

Skema Output

Menampilkan hasil kompilasi project Dataform.

CompilationResult

Representasi JSON 
{
  "name": string,
  "codeCompilationConfig": {
    object (CodeCompilationConfig)
  },
  "resolvedGitCommitSha": string,
  "dataformCoreVersion": string,
  "compilationErrors": [
    {
      object (CompilationError)
    }
  ],
  "dataEncryptionState": {
    object (DataEncryptionState)
  },
  "createTime": string,
  "privateResourceMetadata": {
    object (PrivateResourceMetadata)
  },
  "gcsRepositorySnapshotMetadata": {
    object (GcsRepositorySnapshotMetadata)
  },

  // Union field source can be only one of the following:
  "gitCommitish": string,
  "workspace": string,
  "releaseConfig": string
  // End of list of possible types for union field source.

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

string

Hanya output. Nama hasil kompilasi.
codeCompilationConfig

object (CodeCompilationConfig)

Tidak dapat diubah. Jika disetel, kolom code_compilation_config akan menggantikan setelan kompilasi default yang ditentukan dalam dataform.json.
resolvedGitCommitSha

string

Hanya output. SHA commit Git yang sepenuhnya diselesaikan dari kode yang dikompilasi. Tidak ditetapkan untuk hasil kompilasi yang sumbernya adalah ruang kerja.
dataformCoreVersion

string

Hanya output. Versi @dataform/core yang digunakan untuk kompilasi.
compilationErrors[]

object (CompilationError)

Hanya output. Terjadi error selama kompilasi project.
dataEncryptionState

object (DataEncryptionState)

Hanya output. Hanya disetel jika repositori memiliki Kunci KMS.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat hasil kompilasi dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
privateResourceMetadata

object (PrivateResourceMetadata)

Hanya output. Metadata yang menunjukkan apakah resource ini tercakup dalam cakupan pengguna. Resource CompilationResult adalah user_scoped hanya jika bersumber dari ruang kerja.
gcsRepositorySnapshotMetadata

object (GcsRepositorySnapshotMetadata)

Hanya output. Metadata tentang snapshot repositori yang digunakan oleh notebook terjadwal.
Kolom union source. Sumber hasil kompilasi. source hanya ada berupa salah satu diantara berikut:
gitCommitish

string

Tidak dapat diubah. Nama commit/tag/cabang Git tempat repositori harus dikompilasi. Harus ada di repositori jarak jauh. Contoh: - SHA commit: 12ade345 - tag: tag1 - nama cabang: branch1
workspace

string

Tidak dapat diubah. Nama ruang kerja yang akan dikompilasi. Harus dalam format projects/*/locations/*/repositories/*/workspaces/*.
releaseConfig

string

Tidak dapat diubah. Nama konfigurasi rilis yang akan dikompilasi. Harus dalam format projects/*/locations/*/repositories/*/releaseConfigs/*.

Kolom union _internal_metadata.

_internal_metadata hanya dapat berupa salah satu dari hal berikut:
internalMetadata

string

Hanya output. Semua informasi metadata yang digunakan secara internal untuk menayangkan resource. Misalnya: stempel waktu, tanda, kolom status, dll. Format kolom ini adalah string JSON.

CodeCompilationConfig

Representasi 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)
  }
}
Kolom
defaultDatabase

string

Opsional. Database default (ID project Google Cloud).
defaultSchema

string

Opsional. Skema default (ID set data BigQuery).
defaultLocation

string

Opsional. Lokasi BigQuery default yang akan digunakan. Defaultnya adalah "US". Lihat dokumentasi BigQuery untuk mengetahui daftar lengkap lokasi: https://cloud.google.com/bigquery/docs/locations.
assertionSchema

string

Opsional. Skema default (ID set data BigQuery) untuk pernyataan.
vars

map (key: string, value: string)

Opsional. Variabel buatan pengguna yang tersedia untuk kode project selama kompilasi.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
databaseSuffix

string

Opsional. Sufiks yang harus ditambahkan ke semua nama database (ID project Google Cloud).
schemaSuffix

string

Opsional. Sufiks yang harus ditambahkan ke semua nama skema (ID set data BigQuery).
tablePrefix

string

Opsional. Awalan yang harus ditambahkan ke semua nama tabel.
builtinAssertionNamePrefix

string

Opsional. Awalan yang akan ditambahkan ke nama pernyataan bawaan.
defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

Opsional. Opsi runtime notebook default.
pipelineConfig

object (PipelineConfig)

Opsional. Opsi pipeline yang menentukan jenis dan jalur pipeline dalam repositori Git.

VarsEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

NotebookRuntimeOptions

Representasi 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.
}
Kolom
aiPlatformNotebookRuntimeTemplate

string

Opsional. Nama resource template runtime Colab, yang digunakan untuk membuat runtime bagi eksekusi notebook. Jika tidak ditentukan, runtime akan dibuat dengan spesifikasi default Colab.
Kolom union execution_sink. Lokasi untuk menyimpan hasil eksekusi notebook. execution_sink hanya ada berupa salah satu diantara berikut:
gcsOutputBucket

string

Opsional. Lokasi Google Cloud Storage untuk mengupload hasil. Format: gs://bucket-name.
Kolom union repository_snapshot_storage. Tujuan snapshot file repositori agar tersedia untuk akses hanya baca di dalam runtime notebook repository_snapshot_storage hanya dapat berupa salah satu dari berikut ini:
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

Opsional. Tujuan Google Cloud Storage untuk mengupload snapshot. Untuk URI kosong, nilai defaultnya adalah gcs_output_bucket yang disediakan. Format: gs://bucket-name/path/.

GcsRepositorySnapshotDestination

Representasi JSON 
{
  "repositorySnapshotUri": string
}
Kolom
repositorySnapshotUri

string

Opsional. Tujuan Google Cloud Storage untuk mengupload snapshot repositori. Format: gs://bucket-name/path/.

PipelineConfig

Representasi JSON 
{
  "pipelineType": enum (PipelineType),
  "path": string
}
Kolom
pipelineType

enum (PipelineType)

Wajib. Jenis pipeline.
path

string

Wajib. Jalur relatif dalam repositori Git tempat pipeline ditentukan. Misalnya, untuk pipeline Dataform, ini adalah jalur ke folder tempat workflow_settings.yaml atau dataform.json berada.

CompilationError

Representasi JSON 
{
  "message": string,
  "stack": string,
  "path": string,
  "actionTarget": {
    object (Target)
  }
}
Kolom
message

string

Hanya output. Pesan tingkat teratas error.
stack

string

Hanya output. Stack trace lengkap error.
path

string

Hanya output. Jalur file tempat error ini terjadi, jika tersedia, relatif terhadap root project.
actionTarget

object (Target)

Hanya output. ID tindakan tempat error ini terjadi, jika tersedia.

Target

Representasi JSON 
{
  "database": string,
  "schema": string,
  "name": string
}
Kolom
database

string

Opsional. Database tindakan (ID project Google Cloud) .
schema

string

Opsional. Skema tindakan (ID set data BigQuery), dalam database.
name

string

Opsional. Nama tindakan, dalam database dan schema.

DataEncryptionState

Representasi JSON 
{
  "kmsKeyVersionName": string
}
Kolom
kmsKeyVersionName

string

Wajib. Nama versi kunci KMS yang digunakan untuk mengenkripsi data resource.

Stempel waktu

Representasi JSON 
{
  "seconds": string,
  "nanos": integer
}
Kolom
seconds

string (int64 format)

Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z).
nanos

integer

Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif.

PrivateResourceMetadata

Representasi JSON 
{
  "userScoped": boolean
}
Kolom
userScoped

boolean

Hanya output. Jika benar (true), resource ini memiliki cakupan pengguna, yang berarti resource ini berasal dari ruang kerja atau merupakan ruang kerja.

GcsRepositorySnapshotMetadata

Representasi JSON 
{
  "repositorySnapshotUri": string,
  "crc32cChecksum": string,
  "generation": string
}
Kolom
repositorySnapshotUri

string

Hanya output. URI Google Cloud Storage snapshot repositori.
crc32cChecksum

string

Hanya output. Checksum crc32c snapshot repositori, dienkode base64 big-endian.
generation

string (int64 format)

Hanya output. Nomor generasi objek Cloud Storage. Lihat https://cloud.google.com/storage/docs/metadata#generation-number.

PipelineType

Jenis pipeline. Periode ini dapat diperpanjang pada masa mendatang. Jika UNSPECIFIED, error akan ditampilkan.

Enum
PIPELINE_TYPE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
DATAFORM Pipeline Dataform reguler.
SQL Aset file tunggal SQL.
NOTEBOOK Aset file tunggal notebook.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk ini dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim ke pengguna.

Selain string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar, alat dapat melakukan tindakan destruktif. Jika salah (false), alat hanya dapat melakukan tindakan tambahan. Default: true.
  • idempotentHint: Jika benar (true), memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'dunia terbuka' entitas eksternal. Jika salah (false), alat hanya dapat berinteraksi dengan entitas internal. Misalnya, alat penelusuran web akan menjadi open world, sedangkan alat memori tidak akan menjadi open world.

Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ✅ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌