MCP Tools Reference: dataform.googleapis.com

Tool: create_release_config

Erstellen einer neuen Releasekonfiguration in einem bestimmten Dataform-Repository

Der Parameterwert parent muss das Format projects/{project_id}/locations/{location}/repositories/{repository} haben.

release_config_id ist die benutzerdefinierte ID für die Releasekonfiguration. Wenn der Nutzer keine ID angibt, generiere eine kurze, beschreibende ID mit Kleinbuchstaben, Zahlen und Bindestrichen, die auf seiner Anfrage basiert.

Im folgenden Beispiel wird gezeigt, wie Sie mit curl das MCP-Tool create_release_config aufrufen.

Curl-Anfrage
                  
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
}'
                

Eingabeschema

CreateReleaseConfig-Anfragenachricht.

CreateReleaseConfigRequest

JSON-Darstellung
{
  "parent": string,
  "releaseConfig": {
    object (ReleaseConfig)
  },
  "releaseConfigId": string
}
Felder
parent

string

Erforderlich. Das Repository, in dem die Releasekonfiguration erstellt werden soll. Muss das Format projects/*/locations/*/repositories/* aufweisen.

releaseConfig

object (ReleaseConfig)

Erforderlich. Die zu erstellende Releasekonfiguration.

releaseConfigId

string

Erforderlich. Die ID der Releasekonfiguration. Sie ist die letzte Komponente im Ressourcennamen der Releasekonfiguration.

ReleaseConfig

JSON-Darstellung
{
  "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.
}
Felder
name

string

ID. Der Name der Releasekonfiguration.

gitCommitish

string

Erforderlich. Name des Git-Commits, -Tags oder -Zweigs, in dem das Repository kompiliert werden soll. Muss im Remote-Repository vorhanden sein. Beispiele: – ein Commit-SHA: 12ade345 – ein Tag: tag1 – ein Zweigname: branch1

codeCompilationConfig

object (CodeCompilationConfig)

Optional. Wenn festgelegt, überschreiben die Felder von code_compilation_config die Standardeinstellungen für die Kompilierung, die in „dataform.json“ angegeben sind.

cronSchedule

string

Optional. Optionaler Zeitplan (im Cron-Format) für die automatische Erstellung von Kompilierungsergebnissen.

timeZone

string

Optional. Gibt die Zeitzone an, die bei der Interpretation von „cron_schedule“ verwendet werden soll. Muss ein Zeitzonenname aus der Zeitzonendatenbank sein. Wird keine Operation angegeben, wird standardmäßig immer UTC verwendet.

recentScheduledReleaseRecords[]

object (ScheduledReleaseRecord)

Nur Ausgabe. Datensätze der zehn letzten geplanten Release-Versuche, sortiert in absteigender Reihenfolge nach release_time. Wird aktualisiert, wenn die automatische Erstellung eines Kompilierungsergebnisses durch cron_schedule ausgelöst wird.

releaseCompilationResult

string

Optional. Der Name des aktuell veröffentlichten Kompilierungsergebnisses für diese Releasekonfiguration. Dieser Wert wird aktualisiert, wenn ein Kompilierungsergebnis automatisch aus dieser Release-Konfiguration erstellt wird (mit cron_schedule) oder wenn diese Ressource durch einen API-Aufruf aktualisiert wird (z. B. um ein Rollback auf ein früheres Release durchzuführen). Das Kompilierungsergebnis muss mit dieser Releasekonfiguration erstellt worden sein. Muss das Format projects/*/locations/*/repositories/*/compilationResults/* aufweisen.

disabled

boolean

Optional. Deaktiviert die automatische Erstellung von Kompilierungsergebnissen.

Union-Feld _internal_metadata.

Für _internal_metadata ist nur einer der folgenden Werte zulässig:

internalMetadata

string

Nur Ausgabe. Alle Metadateninformationen, die intern zum Bereitstellen der Ressource verwendet werden. Beispiele: Zeitstempel, Flags, Statusfelder usw. Das Format dieses Felds ist ein JSON-String.

CodeCompilationConfig

JSON-Darstellung
{
  "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)
  }
}
Felder
defaultDatabase

string

Optional. Die Standarddatenbank (Google Cloud-Projekt-ID).

defaultSchema

string

Optional. Das Standardschema (BigQuery-Dataset-ID).

defaultLocation

string

Optional. Der zu verwendende Standard-BigQuery-Standort. Der Standardwert ist „US“. Eine vollständige Liste der Standorte finden Sie in der BigQuery-Dokumentation: https://cloud.google.com/bigquery/docs/locations.

assertionSchema

string

Optional. Das Standardschema (BigQuery-Dataset-ID) für Behauptungen.

vars

map (key: string, value: string)

Optional. Benutzerdefinierte Variablen, die dem Projektcode während der Kompilierung zur Verfügung gestellt werden.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

databaseSuffix

string

Optional. Das Suffix, das an alle Datenbanknamen (Google Cloud-Projekt-ID) angehängt werden soll.

schemaSuffix

string

Optional. Das Suffix, das an alle Schemanamen (BigQuery-Dataset-ID) angehängt werden soll.

tablePrefix

string

Optional. Das Präfix, das allen Tabellennamen vorangestellt werden soll.

builtinAssertionNamePrefix

string

Optional. Das Präfix, das den Namen integrierter Zusicherungen vorangestellt wird.

defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

Optional. Die Standardoptionen für die Notebook-Laufzeit.

pipelineConfig

object (PipelineConfig)

Optional. Die Pipelineoptionen, die den Pipelinetyp und den Pfad innerhalb des Git-Repositorys definieren.

VarsEntry

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

value

string

NotebookRuntimeOptions

JSON-Darstellung
{
  "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.
}
Felder
aiPlatformNotebookRuntimeTemplate

string

Optional. Der Ressourcenname der Colab-Laufzeitvorlage, aus der eine Laufzeit für Notebook-Ausführungen erstellt wird. Wenn keine Angabe erfolgt, wird eine Laufzeit mit den Standardspezifikationen von Colab erstellt.

Union-Feld execution_sink. Der Speicherort, an dem das Ergebnis der Notebookausführung gespeichert werden soll. Für execution_sink ist nur einer der folgenden Werte zulässig:
gcsOutputBucket

string

Optional. Der Google Cloud Storage-Speicherort, an den das Ergebnis hochgeladen werden soll. Format: gs://bucket-name.

Union-Feld repository_snapshot_storage. Das Ziel des Snapshots von Repository-Dateien, auf die in einer Notebook-Laufzeit repository_snapshot_storage schreibgeschützt zugegriffen werden kann, kann nur eines der folgenden sein:
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

Optional. Das Google Cloud Storage-Ziel, in das der Snapshot hochgeladen werden soll. Bei einem leeren URI wird standardmäßig der angegebene gcs_output_bucket verwendet. Format: gs://bucket-name/path/.

GcsRepositorySnapshotDestination

JSON-Darstellung
{
  "repositorySnapshotUri": string
}
Felder
repositorySnapshotUri

string

Optional. Das Google Cloud Storage-Ziel, in das der Repository-Snapshot hochgeladen werden soll. Format: gs://bucket-name/path/.

PipelineConfig

JSON-Darstellung
{
  "pipelineType": enum (PipelineType),
  "path": string
}
Felder
pipelineType

enum (PipelineType)

Erforderlich. Der Typ der Pipeline.

path

string

Erforderlich. Der relative Pfad im Git-Repository, in dem die Pipeline definiert ist. Bei einer Dataform-Pipeline ist das beispielsweise ein Pfad zum Ordner, in dem sich workflow_settings.yaml oder dataform.json befindet.

ScheduledReleaseRecord

JSON-Darstellung
{
  "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.
}
Felder
releaseTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel dieses Release-Versuchs.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Union-Feld result. Das Ergebnis dieses Release-Versuchs. Für result ist nur einer der folgenden Werte zulässig:
compilationResult

string

Der Name des erstellten Kompilierungsergebnisses, falls eines erstellt wurde. Muss das Format projects/*/locations/*/repositories/*/compilationResults/* aufweisen.

errorStatus

object (Status)

Der Fehlerstatus, der bei diesem Versuch, das Kompilierungsergebnis zu erstellen, aufgetreten ist, falls der Versuch fehlgeschlagen ist.

Status

JSON-Darstellung
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.

message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede für Nutzer sichtbare Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.

details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Beliebig

JSON-Darstellung
{
  "typeUrl": string,
  "value": string
}
Felder
typeUrl

string

Gibt den Typ der serialisierten Protobuf-Nachricht mit einem URI-Verweis an, der aus einem Präfix, das mit einem Schrägstrich endet, und dem vollständig qualifizierten Typnamen besteht.

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

Dieser String muss mindestens ein /-Zeichen enthalten. Der Inhalt nach dem letzten / muss der vollständig qualifizierte Name des Typs in kanonischer Form ohne führenden Punkt sein. Schreiben Sie kein Schema in diese URI-Referenzen, damit Clients nicht versuchen, sie zu kontaktieren.

Das Präfix ist beliebig. Protobuf-Implementierungen entfernen einfach alles bis zum letzten / (einschließlich) und identifizieren so den Typ. type.googleapis.com/ ist ein häufiges Standardpräfix, das für einige ältere Implementierungen erforderlich ist. Dieses Präfix gibt nicht den Ursprung des Typs an und URIs, die es enthalten, werden voraussichtlich nicht auf Anfragen reagieren.

Alle Typ-URL-Strings müssen gültige URI-Referenzen sein. Für das Textformat gilt die zusätzliche Einschränkung, dass der Inhalt der Referenz nur aus alphanumerischen Zeichen, prozentual codierten Escape-Sequenzen und Zeichen aus der folgenden Menge bestehen darf (ohne die äußeren Backticks): /-.~_!$&()*+,;=. Obwohl wir Prozentcodierungen zulassen, sollten Implementierungen sie nicht dekodieren, um Verwechslungen mit vorhandenen Parsern zu vermeiden. Beispiel: type.googleapis.com%2FFoo sollte abgelehnt werden.

Im ursprünglichen Design von Any wurde die Möglichkeit in Betracht gezogen, einen Dienst zur Typauflösung unter diesen Typ-URLs zu starten. Protobuf hat jedoch nie einen solchen Dienst implementiert und betrachtet das Kontaktieren dieser URLs als problematisch und als potenzielles Sicherheitsproblem. Versuchen Sie nicht, URLs vom Typ „Kontakt“ aufzurufen.

value

string (bytes format)

Enthält eine Protobuf-Serialisierung des Typs, der durch „type_url“ beschrieben wird.

Ein base64-codierter String.

Zeitstempel

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).

nanos

integer

Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld enthält den Nanosekundenanteil der Dauer und ist keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 liegen (einschließlich).

PipelineType

Der Typ der Pipeline. Diese Frist kann in Zukunft verlängert werden. Im Fall von UNSPECIFIED wird der Fehler ausgegeben.

Enums
PIPELINE_TYPE_UNSPECIFIED Standardwert. Dieser Wert wird nicht verwendet.
DATAFORM Reguläre Dataform-Pipeline.
SQL SQL-Einzeldatei-Asset.
NOTEBOOK Einzelnes Datei-Asset für Notebooks.

Ausgabeschema

Stellt eine Dataform-Releasekonfiguration dar.

ReleaseConfig

JSON-Darstellung
{
  "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.
}
Felder
name

string

ID. Der Name der Releasekonfiguration.

gitCommitish

string

Erforderlich. Name des Git-Commits, -Tags oder -Zweigs, in dem das Repository kompiliert werden soll. Muss im Remote-Repository vorhanden sein. Beispiele: – ein Commit-SHA: 12ade345 – ein Tag: tag1 – ein Zweigname: branch1

codeCompilationConfig

object (CodeCompilationConfig)

Optional. Wenn festgelegt, überschreiben die Felder von code_compilation_config die Standardeinstellungen für die Kompilierung, die in „dataform.json“ angegeben sind.

cronSchedule

string

Optional. Optionaler Zeitplan (im Cron-Format) für die automatische Erstellung von Kompilierungsergebnissen.

timeZone

string

Optional. Gibt die Zeitzone an, die bei der Interpretation von „cron_schedule“ verwendet werden soll. Muss ein Zeitzonenname aus der Zeitzonendatenbank sein. Wird keine Operation angegeben, wird standardmäßig immer UTC verwendet.

recentScheduledReleaseRecords[]

object (ScheduledReleaseRecord)

Nur Ausgabe. Datensätze der zehn letzten geplanten Release-Versuche, sortiert in absteigender Reihenfolge nach release_time. Wird aktualisiert, wenn die automatische Erstellung eines Kompilierungsergebnisses durch cron_schedule ausgelöst wird.

releaseCompilationResult

string

Optional. Der Name des aktuell veröffentlichten Kompilierungsergebnisses für diese Releasekonfiguration. Dieser Wert wird aktualisiert, wenn ein Kompilierungsergebnis automatisch aus dieser Release-Konfiguration erstellt wird (mit cron_schedule) oder wenn diese Ressource durch einen API-Aufruf aktualisiert wird (z. B. um ein Rollback auf ein früheres Release durchzuführen). Das Kompilierungsergebnis muss mit dieser Releasekonfiguration erstellt worden sein. Muss das Format projects/*/locations/*/repositories/*/compilationResults/* aufweisen.

disabled

boolean

Optional. Deaktiviert die automatische Erstellung von Kompilierungsergebnissen.

Union-Feld _internal_metadata.

Für _internal_metadata ist nur einer der folgenden Werte zulässig:

internalMetadata

string

Nur Ausgabe. Alle Metadateninformationen, die intern zum Bereitstellen der Ressource verwendet werden. Beispiele: Zeitstempel, Flags, Statusfelder usw. Das Format dieses Felds ist ein JSON-String.

CodeCompilationConfig

JSON-Darstellung
{
  "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)
  }
}
Felder
defaultDatabase

string

Optional. Die Standarddatenbank (Google Cloud-Projekt-ID).

defaultSchema

string

Optional. Das Standardschema (BigQuery-Dataset-ID).

defaultLocation

string

Optional. Der zu verwendende Standard-BigQuery-Standort. Der Standardwert ist „US“. Eine vollständige Liste der Standorte finden Sie in der BigQuery-Dokumentation: https://cloud.google.com/bigquery/docs/locations.

assertionSchema

string

Optional. Das Standardschema (BigQuery-Dataset-ID) für Behauptungen.

vars

map (key: string, value: string)

Optional. Benutzerdefinierte Variablen, die dem Projektcode während der Kompilierung zur Verfügung gestellt werden.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

databaseSuffix

string

Optional. Das Suffix, das an alle Datenbanknamen (Google Cloud-Projekt-ID) angehängt werden soll.

schemaSuffix

string

Optional. Das Suffix, das an alle Schemanamen (BigQuery-Dataset-ID) angehängt werden soll.

tablePrefix

string

Optional. Das Präfix, das allen Tabellennamen vorangestellt werden soll.

builtinAssertionNamePrefix

string

Optional. Das Präfix, das den Namen integrierter Zusicherungen vorangestellt wird.

defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

Optional. Die Standardoptionen für die Notebook-Laufzeit.

pipelineConfig

object (PipelineConfig)

Optional. Die Pipelineoptionen, die den Pipelinetyp und den Pfad innerhalb des Git-Repositorys definieren.

VarsEntry

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

value

string

NotebookRuntimeOptions

JSON-Darstellung
{
  "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.
}
Felder
aiPlatformNotebookRuntimeTemplate

string

Optional. Der Ressourcenname der Colab-Laufzeitvorlage, aus der eine Laufzeit für Notebook-Ausführungen erstellt wird. Wenn keine Angabe erfolgt, wird eine Laufzeit mit den Standardspezifikationen von Colab erstellt.

Union-Feld execution_sink. Der Speicherort, an dem das Ergebnis der Notebookausführung gespeichert werden soll. Für execution_sink ist nur einer der folgenden Werte zulässig:
gcsOutputBucket

string

Optional. Der Google Cloud Storage-Speicherort, an den das Ergebnis hochgeladen werden soll. Format: gs://bucket-name.

Union-Feld repository_snapshot_storage. Das Ziel des Snapshots von Repository-Dateien, auf die in einer Notebook-Laufzeit repository_snapshot_storage schreibgeschützt zugegriffen werden kann, kann nur eines der folgenden sein:
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

Optional. Das Google Cloud Storage-Ziel, in das der Snapshot hochgeladen werden soll. Bei einem leeren URI wird standardmäßig der angegebene gcs_output_bucket verwendet. Format: gs://bucket-name/path/.

GcsRepositorySnapshotDestination

JSON-Darstellung
{
  "repositorySnapshotUri": string
}
Felder
repositorySnapshotUri

string

Optional. Das Google Cloud Storage-Ziel, in das der Repository-Snapshot hochgeladen werden soll. Format: gs://bucket-name/path/.

PipelineConfig

JSON-Darstellung
{
  "pipelineType": enum (PipelineType),
  "path": string
}
Felder
pipelineType

enum (PipelineType)

Erforderlich. Der Typ der Pipeline.

path

string

Erforderlich. Der relative Pfad im Git-Repository, in dem die Pipeline definiert ist. Bei einer Dataform-Pipeline ist das beispielsweise ein Pfad zum Ordner, in dem sich workflow_settings.yaml oder dataform.json befindet.

ScheduledReleaseRecord

JSON-Darstellung
{
  "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.
}
Felder
releaseTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel dieses Release-Versuchs.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Union-Feld result. Das Ergebnis dieses Release-Versuchs. Für result ist nur einer der folgenden Werte zulässig:
compilationResult

string

Der Name des erstellten Kompilierungsergebnisses, falls eines erstellt wurde. Muss das Format projects/*/locations/*/repositories/*/compilationResults/* aufweisen.

errorStatus

object (Status)

Der Fehlerstatus, der bei diesem Versuch, das Kompilierungsergebnis zu erstellen, aufgetreten ist, falls der Versuch fehlgeschlagen ist.

Status

JSON-Darstellung
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.

message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede für Nutzer sichtbare Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.

details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Beliebig

JSON-Darstellung
{
  "typeUrl": string,
  "value": string
}
Felder
typeUrl

string

Gibt den Typ der serialisierten Protobuf-Nachricht mit einem URI-Verweis an, der aus einem Präfix, das mit einem Schrägstrich endet, und dem vollständig qualifizierten Typnamen besteht.

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

Dieser String muss mindestens ein /-Zeichen enthalten. Der Inhalt nach dem letzten / muss der vollständig qualifizierte Name des Typs in kanonischer Form ohne führenden Punkt sein. Schreiben Sie kein Schema in diese URI-Referenzen, damit Clients nicht versuchen, sie zu kontaktieren.

Das Präfix ist beliebig. Protobuf-Implementierungen entfernen einfach alles bis zum letzten / (einschließlich) und identifizieren so den Typ. type.googleapis.com/ ist ein häufiges Standardpräfix, das für einige ältere Implementierungen erforderlich ist. Dieses Präfix gibt nicht den Ursprung des Typs an und URIs, die es enthalten, werden voraussichtlich nicht auf Anfragen reagieren.

Alle Typ-URL-Strings müssen gültige URI-Referenzen sein. Für das Textformat gilt die zusätzliche Einschränkung, dass der Inhalt der Referenz nur aus alphanumerischen Zeichen, prozentual codierten Escape-Sequenzen und Zeichen aus der folgenden Menge bestehen darf (ohne die äußeren Backticks): /-.~_!$&()*+,;=. Obwohl wir Prozentcodierungen zulassen, sollten Implementierungen sie nicht dekodieren, um Verwechslungen mit vorhandenen Parsern zu vermeiden. Beispiel: type.googleapis.com%2FFoo sollte abgelehnt werden.

Im ursprünglichen Design von Any wurde die Möglichkeit in Betracht gezogen, einen Dienst zur Typauflösung unter diesen Typ-URLs zu starten. Protobuf hat jedoch nie einen solchen Dienst implementiert und betrachtet das Kontaktieren dieser URLs als problematisch und als potenzielles Sicherheitsproblem. Versuchen Sie nicht, URLs vom Typ „Kontakt“ aufzurufen.

value

string (bytes format)

Enthält eine Protobuf-Serialisierung des Typs, der durch „type_url“ beschrieben wird.

Ein base64-codierter String.

Zeitstempel

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).

nanos

integer

Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld enthält den Nanosekundenanteil der Dauer und ist keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 liegen (einschließlich).

PipelineType

Der Typ der Pipeline. Diese Frist kann in Zukunft verlängert werden. Im Fall von UNSPECIFIED wird der Fehler ausgegeben.

Enums
PIPELINE_TYPE_UNSPECIFIED Standardwert. Dieser Wert wird nicht verwendet.
DATAFORM Reguläre Dataform-Pipeline.
SQL SQL-Einzeldatei-Asset.
NOTEBOOK Einzelnes Datei-Asset für Notebooks.

Tool-Annotationen

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ❌ | Hinweis „Nur lesen“: ❌ | Hinweis „Offene Welt“: ❌