Outil : create_release_config
Crée une configuration de version dans un dépôt Dataform donné.
La valeur du paramètre parent doit être au format projects/{project_id}/locations/{location}/repositories/{repository}.
release_config_id est l'ID défini par l'utilisateur pour la configuration de version. Si l'utilisateur ne spécifie pas d'ID, générez-en un court et descriptif en utilisant des lettres minuscules, des chiffres et des traits d'union en fonction de sa demande.
L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP create_release_config.
| Requête 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 }' |
Schéma d'entrée
Message de requête CreateReleaseConfig.
CreateReleaseConfigRequest
| Représentation JSON |
|---|
{
"parent": string,
"releaseConfig": {
object ( |
| Champs | |
|---|---|
parent |
Obligatoire. Dépôt dans lequel créer la configuration de version. Il doit respecter le format |
releaseConfig |
Obligatoire. Configuration de version à créer. |
releaseConfigId |
Obligatoire. ID à utiliser pour la configuration de la version, qui constituera le composant final du nom de ressource de la configuration de la version. |
ReleaseConfig
| Représentation JSON |
|---|
{ "name": string, "gitCommitish": string, "codeCompilationConfig": { object ( |
| Champs | |
|---|---|
name |
Identifiant. Nom de la configuration de version. |
gitCommitish |
Obligatoire. Nom de la branche, du tag ou du commit Git à partir duquel le dépôt doit être compilé. Doit exister dans le dépôt distant. Exemples : - un SHA de commit : |
codeCompilationConfig |
Facultatif. Si cette option est définie, les champs de |
cronSchedule |
Facultatif. Planification facultative (au format cron) pour la création automatique des résultats de compilation. |
timeZone |
Facultatif. Spécifie le fuseau horaire à utiliser pour interpréter cron_schedule. Doit correspondre à un nom de fuseau horaire de la base de données des fuseaux horaires. Si aucune opération n'est spécifiée, la valeur par défaut est |
recentScheduledReleaseRecords[] |
Uniquement en sortie. Enregistrements des 10 dernières tentatives de programmation de la publication, classés par ordre décroissant de |
releaseCompilationResult |
Facultatif. Nom du résultat de compilation actuellement publié pour cette configuration de version. Cette valeur est mise à jour lorsqu'un résultat de compilation est créé automatiquement à partir de cette configuration de version (à l'aide de cron_schedule) ou lorsque cette ressource est mise à jour par un appel d'API (par exemple, pour effectuer un rollback vers une version antérieure). Le résultat de la compilation doit avoir été créé à l'aide de cette configuration de version. Il doit respecter le format |
disabled |
Facultatif. Désactive la création automatique de résultats de compilation. |
Champ d'union
|
|
internalMetadata |
Uniquement en sortie. Toutes les informations de métadonnées utilisées en interne pour diffuser la ressource. Par exemple : codes temporels, indicateurs, champs d'état, etc. Le format de ce champ est une chaîne JSON. |
CodeCompilationConfig
| Représentation JSON |
|---|
{ "defaultDatabase": string, "defaultSchema": string, "defaultLocation": string, "assertionSchema": string, "vars": { string: string, ... }, "databaseSuffix": string, "schemaSuffix": string, "tablePrefix": string, "builtinAssertionNamePrefix": string, "defaultNotebookRuntimeOptions": { object ( |
| Champs | |
|---|---|
defaultDatabase |
Facultatif. Base de données par défaut (ID du projet Google Cloud). |
defaultSchema |
Facultatif. Schéma par défaut (ID de l'ensemble de données BigQuery). |
defaultLocation |
Facultatif. Emplacement BigQuery par défaut à utiliser. La valeur par défaut est "US". Pour obtenir la liste complète des emplacements, consultez la documentation BigQuery : https://cloud.google.com/bigquery/docs/locations. |
assertionSchema |
Facultatif. Schéma par défaut (ID de l'ensemble de données BigQuery) pour les assertions. |
vars |
Facultatif. Variables définies par l'utilisateur et mises à la disposition du code du projet lors de la compilation. Objet contenant une liste de paires |
databaseSuffix |
Facultatif. Suffixe à ajouter à tous les noms de bases de données (ID de projet Google Cloud). |
schemaSuffix |
Facultatif. Suffixe à ajouter à tous les noms de schémas (ID d'ensemble de données BigQuery). |
tablePrefix |
Facultatif. Préfixe à ajouter à tous les noms de tables. |
builtinAssertionNamePrefix |
Facultatif. Préfixe à ajouter aux noms d'assertion intégrés. |
defaultNotebookRuntimeOptions |
Facultatif. Options d'exécution de notebook par défaut. |
pipelineConfig |
Facultatif. Options de pipeline qui définissent le type et le chemin d'accès du pipeline dans le dépôt Git. |
VarsEntry
| Représentation JSON |
|---|
{ "key": string, "value": string } |
| Champs | |
|---|---|
key |
|
value |
|
NotebookRuntimeOptions
| Représentation JSON |
|---|
{ "aiPlatformNotebookRuntimeTemplate": string, // Union field |
| Champs | |
|---|---|
aiPlatformNotebookRuntimeTemplate |
Facultatif. Nom de ressource du modèle d'exécution Colab à partir duquel un environnement d'exécution est créé pour les exécutions de notebooks. Si aucune valeur n'est spécifiée, un environnement d'exécution est créé avec les spécifications par défaut de Colab. |
Champ d'union execution_sink. Emplacement pour stocker le résultat de l'exécution du notebook. execution_sink ne peut être qu'un des éléments suivants : |
|
gcsOutputBucket |
Facultatif. Emplacement Google Cloud Storage dans lequel importer le résultat. Format : |
Champ d'union repository_snapshot_storage. La destination de l'instantané des fichiers de dépôt qui seront disponibles en lecture seule dans un environnement d'exécution de notebook repository_snapshot_storage ne peut être que l'une des suivantes : |
|
gcsRepositorySnapshotDestination |
Facultatif. Destination Google Cloud Storage vers laquelle importer l'instantané. Si l'URI est vide, le bucket gcs_output_bucket fourni est utilisé par défaut. Format : |
GcsRepositorySnapshotDestination
| Représentation JSON |
|---|
{ "repositorySnapshotUri": string } |
| Champs | |
|---|---|
repositorySnapshotUri |
Facultatif. Destination Google Cloud Storage vers laquelle importer l'instantané du dépôt. Format : |
PipelineConfig
| Représentation JSON |
|---|
{
"pipelineType": enum ( |
| Champs | |
|---|---|
pipelineType |
Obligatoire. Type de pipeline. |
path |
Obligatoire. Chemin d'accès relatif dans le dépôt Git où le pipeline est défini. Par exemple, pour un pipeline Dataform, il s'agit d'un chemin d'accès au dossier où se trouve |
ScheduledReleaseRecord
| Représentation JSON |
|---|
{ "releaseTime": string, // Union field |
| Champs | |
|---|---|
releaseTime |
Uniquement en sortie. Code temporel de cette tentative de publication. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
Champ d'union result. Résultat de cette tentative de publication. result ne peut être qu'un des éléments suivants : |
|
compilationResult |
Nom du résultat de la compilation créé, le cas échéant. Il doit respecter le format |
errorStatus |
État de l'erreur rencontrée lors de cette tentative de création du résultat de compilation, si la tentative a échoué. |
État
| Représentation JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| Champs | |
|---|---|
code |
Code d'état, qui doit être une valeur d'énumération de |
message |
Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ |
details[] |
Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
Tous
| Représentation JSON |
|---|
{ "typeUrl": string, "value": string } |
| Champs | |
|---|---|
typeUrl |
Identifie le type du message Protobuf sérialisé avec une référence URI composée d'un préfixe se terminant par une barre oblique et du nom de type complet. Exemple : type.googleapis.com/google.protobuf.StringValue Cette chaîne doit contenir au moins un caractère Le préfixe est arbitraire et les implémentations Protobuf sont censées supprimer tout ce qui précède le dernier Toutes les chaînes d'URL de type doivent être des références URI valides, avec la restriction supplémentaire (pour le format texte) que le contenu de la référence ne doit comporter que des caractères alphanumériques, des séquences d'échappement encodées en pourcentage et des caractères de l'ensemble suivant (sans les accents graves extérieurs) : Dans la conception d'origine de |
value |
Contient une sérialisation Protobuf du type décrit par type_url. Chaîne encodée en base64. |
Horodatage
| Représentation JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Champs | |
|---|---|
seconds |
Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z). |
nanos |
Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus. |
PipelineType
Type de pipeline. Cette durée pourra être prolongée à l'avenir. En cas de valeur UNSPECIFIED, l'erreur sera générée.
| Enums | |
|---|---|
PIPELINE_TYPE_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
DATAFORM |
Pipeline Dataform standard. |
SQL |
Élément de fichier unique SQL. |
NOTEBOOK |
Composant de fichier unique Notebook. |
Schéma de sortie
Représente une configuration de version Dataform.
ReleaseConfig
| Représentation JSON |
|---|
{ "name": string, "gitCommitish": string, "codeCompilationConfig": { object ( |
| Champs | |
|---|---|
name |
Identifiant. Nom de la configuration de version. |
gitCommitish |
Obligatoire. Nom de la branche, du tag ou du commit Git à partir duquel le dépôt doit être compilé. Doit exister dans le dépôt distant. Exemples : - un SHA de commit : |
codeCompilationConfig |
Facultatif. Si cette option est définie, les champs de |
cronSchedule |
Facultatif. Planification facultative (au format cron) pour la création automatique des résultats de compilation. |
timeZone |
Facultatif. Spécifie le fuseau horaire à utiliser pour interpréter cron_schedule. Doit correspondre à un nom de fuseau horaire de la base de données des fuseaux horaires. Si aucune opération n'est spécifiée, la valeur par défaut est |
recentScheduledReleaseRecords[] |
Uniquement en sortie. Enregistrements des 10 dernières tentatives de programmation de la publication, classés par ordre décroissant de |
releaseCompilationResult |
Facultatif. Nom du résultat de compilation actuellement publié pour cette configuration de version. Cette valeur est mise à jour lorsqu'un résultat de compilation est créé automatiquement à partir de cette configuration de version (à l'aide de cron_schedule) ou lorsque cette ressource est mise à jour par un appel d'API (par exemple, pour effectuer un rollback vers une version antérieure). Le résultat de la compilation doit avoir été créé à l'aide de cette configuration de version. Il doit respecter le format |
disabled |
Facultatif. Désactive la création automatique de résultats de compilation. |
Champ d'union
|
|
internalMetadata |
Uniquement en sortie. Toutes les informations de métadonnées utilisées en interne pour diffuser la ressource. Par exemple : codes temporels, indicateurs, champs d'état, etc. Le format de ce champ est une chaîne JSON. |
CodeCompilationConfig
| Représentation JSON |
|---|
{ "defaultDatabase": string, "defaultSchema": string, "defaultLocation": string, "assertionSchema": string, "vars": { string: string, ... }, "databaseSuffix": string, "schemaSuffix": string, "tablePrefix": string, "builtinAssertionNamePrefix": string, "defaultNotebookRuntimeOptions": { object ( |
| Champs | |
|---|---|
defaultDatabase |
Facultatif. Base de données par défaut (ID du projet Google Cloud). |
defaultSchema |
Facultatif. Schéma par défaut (ID de l'ensemble de données BigQuery). |
defaultLocation |
Facultatif. Emplacement BigQuery par défaut à utiliser. La valeur par défaut est "US". Pour obtenir la liste complète des emplacements, consultez la documentation BigQuery : https://cloud.google.com/bigquery/docs/locations. |
assertionSchema |
Facultatif. Schéma par défaut (ID de l'ensemble de données BigQuery) pour les assertions. |
vars |
Facultatif. Variables définies par l'utilisateur et mises à la disposition du code du projet lors de la compilation. Objet contenant une liste de paires |
databaseSuffix |
Facultatif. Suffixe à ajouter à tous les noms de bases de données (ID de projet Google Cloud). |
schemaSuffix |
Facultatif. Suffixe à ajouter à tous les noms de schémas (ID d'ensemble de données BigQuery). |
tablePrefix |
Facultatif. Préfixe à ajouter à tous les noms de tables. |
builtinAssertionNamePrefix |
Facultatif. Préfixe à ajouter aux noms d'assertion intégrés. |
defaultNotebookRuntimeOptions |
Facultatif. Options d'exécution de notebook par défaut. |
pipelineConfig |
Facultatif. Options de pipeline qui définissent le type et le chemin d'accès du pipeline dans le dépôt Git. |
VarsEntry
| Représentation JSON |
|---|
{ "key": string, "value": string } |
| Champs | |
|---|---|
key |
|
value |
|
NotebookRuntimeOptions
| Représentation JSON |
|---|
{ "aiPlatformNotebookRuntimeTemplate": string, // Union field |
| Champs | |
|---|---|
aiPlatformNotebookRuntimeTemplate |
Facultatif. Nom de ressource du modèle d'exécution Colab à partir duquel un environnement d'exécution est créé pour les exécutions de notebooks. Si aucune valeur n'est spécifiée, un environnement d'exécution est créé avec les spécifications par défaut de Colab. |
Champ d'union execution_sink. Emplacement pour stocker le résultat de l'exécution du notebook. execution_sink ne peut être qu'un des éléments suivants : |
|
gcsOutputBucket |
Facultatif. Emplacement Google Cloud Storage dans lequel importer le résultat. Format : |
Champ d'union repository_snapshot_storage. La destination de l'instantané des fichiers de dépôt qui seront disponibles en lecture seule dans un environnement d'exécution de notebook repository_snapshot_storage ne peut être que l'une des suivantes : |
|
gcsRepositorySnapshotDestination |
Facultatif. Destination Google Cloud Storage vers laquelle importer l'instantané. Si l'URI est vide, le bucket gcs_output_bucket fourni est utilisé par défaut. Format : |
GcsRepositorySnapshotDestination
| Représentation JSON |
|---|
{ "repositorySnapshotUri": string } |
| Champs | |
|---|---|
repositorySnapshotUri |
Facultatif. Destination Google Cloud Storage vers laquelle importer l'instantané du dépôt. Format : |
PipelineConfig
| Représentation JSON |
|---|
{
"pipelineType": enum ( |
| Champs | |
|---|---|
pipelineType |
Obligatoire. Type de pipeline. |
path |
Obligatoire. Chemin d'accès relatif dans le dépôt Git où le pipeline est défini. Par exemple, pour un pipeline Dataform, il s'agit d'un chemin d'accès au dossier où se trouve |
ScheduledReleaseRecord
| Représentation JSON |
|---|
{ "releaseTime": string, // Union field |
| Champs | |
|---|---|
releaseTime |
Uniquement en sortie. Code temporel de cette tentative de publication. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
Champ d'union result. Résultat de cette tentative de publication. result ne peut être qu'un des éléments suivants : |
|
compilationResult |
Nom du résultat de la compilation créé, le cas échéant. Il doit respecter le format |
errorStatus |
État de l'erreur rencontrée lors de cette tentative de création du résultat de compilation, si la tentative a échoué. |
État
| Représentation JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| Champs | |
|---|---|
code |
Code d'état, qui doit être une valeur d'énumération de |
message |
Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ |
details[] |
Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
Tous
| Représentation JSON |
|---|
{ "typeUrl": string, "value": string } |
| Champs | |
|---|---|
typeUrl |
Identifie le type du message Protobuf sérialisé avec une référence URI composée d'un préfixe se terminant par une barre oblique et du nom de type complet. Exemple : type.googleapis.com/google.protobuf.StringValue Cette chaîne doit contenir au moins un caractère Le préfixe est arbitraire et les implémentations Protobuf sont censées supprimer tout ce qui précède le dernier Toutes les chaînes d'URL de type doivent être des références URI valides, avec la restriction supplémentaire (pour le format texte) que le contenu de la référence ne doit comporter que des caractères alphanumériques, des séquences d'échappement encodées en pourcentage et des caractères de l'ensemble suivant (sans les accents graves extérieurs) : Dans la conception d'origine de |
value |
Contient une sérialisation Protobuf du type décrit par type_url. Chaîne encodée en base64. |
Horodatage
| Représentation JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Champs | |
|---|---|
seconds |
Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z). |
nanos |
Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus. |
PipelineType
Type de pipeline. Cette durée pourra être prolongée à l'avenir. En cas de valeur UNSPECIFIED, l'erreur sera générée.
| Enums | |
|---|---|
PIPELINE_TYPE_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
DATAFORM |
Pipeline Dataform standard. |
SQL |
Élément de fichier unique SQL. |
NOTEBOOK |
Composant de fichier unique Notebook. |
Annotations d'outils
Indication destructive : ❌ | Indication d'idempotence : ❌ | Indication de lecture seule : ❌ | Indication de monde ouvert : ❌