REST Resource: projects.locations.workflows

Ressource: MigrationWorkflow

Ein Migrationsworkflow, der angibt, was für eine EDW-Migration zu tun ist.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "tasks": {
    string: {
      object (MigrationTask)
    },
    ...
  },
  "state": enum (State),
  "createTime": string,
  "lastUpdateTime": string
}
Felder
name

string

Nur Ausgabe. Nicht veränderbar. Kennung. Die eindeutige Kennung für den Migrationsworkflow. Die ID wird vom Server generiert.

Beispiel: projects/123/locations/us/workflows/345
displayName

string

Der Anzeigename des Workflows. Dieser kann festgelegt werden, um einem Workflow einen aussagekräftigen Namen zu geben. Die Eindeutigkeit wird weder garantiert noch erzwungen.
tasks

map (key: string, value: object (MigrationTask))

Die Aufgaben in einem Workflow in einer benannten Zuordnung. Der Name (d.h. Schlüssel) hat keine Bedeutung und stellt lediglich eine bequeme Möglichkeit dar, eine bestimmte Aufgabe in einem Workflow zu erledigen.
state

enum (State)

Nur Ausgabe. Dieser Status des Workflows.
createTime

string (Timestamp format)

Zeitpunkt, zu dem der Workflow erstellt wurde.
lastUpdateTime

string (Timestamp format)

Zeitpunkt der letzten Aktualisierung des Workflows.

MigrationTask

Eine einzelne Aufgabe für eine Migration mit Details zur Konfiguration der Aufgabe.

JSON-Darstellung 
{
  "id": string,
  "type": string,
  "state": enum (State),
  "processingError": {
    object (ErrorInfo)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "resourceErrorDetails": [
    {
      object (ResourceErrorDetail)
    }
  ],

  // Union field task_details can be only one of the following:
  "translationConfigDetails": {
    object (TranslationConfigDetails)
  }
  // End of list of possible types for union field task_details.
}
Felder
id

string

Nur Ausgabe. Nicht veränderbar. Die eindeutige Kennung für die Migrationsaufgabe. Die ID wird vom Server generiert.
type

string

Der Typ der Aufgabe. Dies muss einer der folgenden unterstützten Aufgabentypen sein: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ.
state

enum (State)

Nur Ausgabe. Der aktuelle Status der Aufgabe.
processingError

object (ErrorInfo)

Nur Ausgabe. Eine Erläuterung, die ausgefüllt werden kann, wenn die Aufgabe den Status FAILED hat.
createTime

string (Timestamp format)

Zeitpunkt, zu dem die Aufgabe erstellt wurde.
lastUpdateTime

string (Timestamp format)

Gibt an, wann die Aufgabe zuletzt aktualisiert wurde.
resourceErrorDetails[]

object (ResourceErrorDetail)

Nur Ausgabe. Enthält Details zu Fehlern und Problemen, die bei der Aufgabenverarbeitung aufgetreten sind. Wenn Fehlerdetails vorhanden sind, bedeutet das nicht, dass die Aufgabe fehlgeschlagen ist.
Union-Feld task_details. Die Details der Aufgabe. Für task_details ist nur einer der folgenden Werte zulässig:
translationConfigDetails

object (TranslationConfigDetails)

Aufgabenkonfiguration für die CW-Batch/Offline-SQL-Übersetzung.

TranslationConfigDetails

Die Übersetzungskonfiguration zum Erfassen der erforderlichen Einstellungen für eine Übersetzungsaufgabe und eine Unteraufgabe.

JSON-Darstellung 
{
  "sourceDialect": {
    object (Dialect)
  },
  "targetDialect": {
    object (Dialect)
  },
  "sourceEnv": {
    object (SourceEnv)
  },
  "gcsSourcePath": string,
  "gcsTargetPath": string,
  "nameMappingList": {
    object (ObjectNameMappingList)
  }
  // End of list of possible types for union field output_name_mapping.
}
Felder
sourceDialect

object (Dialect)

Der Dialekt der Eingabedateien.
targetDialect

object (Dialect)

Der Zieldialekt, in das die Engine die Eingabe übersetzen soll.
sourceEnv

object (SourceEnv)

Die Standardwerte der Quellumgebung für die Übersetzung.
requestSource

string

Der Indikator zum Anzeigen des Initiators von Übersetzungsanfragen.
Union-Feld source_location. Der ausgewählte Pfad, unter dem sich die Quelle für Eingabedateien befindet. Für source_location ist nur einer der folgenden Werte zulässig:
gcsSourcePath

string

Der Cloud Storage-Pfad für ein Verzeichnis von Dateien, die in einer Aufgabe übersetzt werden sollen.
Union-Feld target_location. Der ausgewählte Pfad, in dem sich das Ziel für Ausgabedateien befindet. Für target_location ist nur einer der folgenden Werte zulässig:
gcsTargetPath

string

Der Cloud Storage-Pfad, in den die entsprechenden Eingabedateien zurückgeschrieben werden sollen.
nameMappingList

object (ObjectNameMappingList)

Die Zuordnung von Objekten zu ihren gewünschten Ausgabenamen in Listenform.

ObjectNameMappingList

Stellt eine Zuordnung von Namenszuordnungen mit einer Liste von Schlüssel/Wert-Proto-Nachrichten des vorhandenen Namens zum gewünschten Ausgabenamen dar.

JSON-Darstellung 
{
  "nameMap": [
    {
      object (ObjectNameMapping)
    }
  ]
}
Felder
nameMap[]

object (ObjectNameMapping)

Die Elemente der Objektnamenzuordnung.

ObjectNameMapping

Stellt ein Schlüssel/Wert-Paar von NameMappingKey zu NameMappingValue dar, um die Zuordnung von SQL-Namen vom Eingabewert zur gewünschten Ausgabe darzustellen.

JSON-Darstellung 
{
  "source": {
    object (NameMappingKey)
  },
  "target": {
    object (NameMappingValue)
  }
}
Felder
source

object (NameMappingKey)

Der Name des Objekts in der Quelle, das zugeordnet wird.
target

object (NameMappingValue)

Der gewünschte Zielname des Objekts, das zugeordnet wird.

NameMappingKey

Die potenziellen Komponenten einer vollständigen Namenszuordnung, die während der Übersetzung im Quell-Data-Warehouse zugeordnet werden.

JSON-Darstellung 
{
  "type": enum (Type),
  "database": string,
  "schema": string,
  "relation": string,
  "attribute": string
}
Felder
type

enum (Type)

Der Typ des Objekts, das zugeordnet wird.
database

string

Der Datenbankname (BigQuery-Projekt-ID-Äquivalent im Quell-Data-Warehouse).
schema

string

Der Schemaname (BigQuery-Dataset-Äquivalent im Quell-Data-Warehouse).
relation

string

Der Beziehungsname (Äquivalent der BigQuery-Tabelle oder -Ansicht im Quell-Data-Warehouse).
attribute

string

Der Attributname (Äquivalent der BigQuery-Spalte im Quell-Data-Warehouse).

Typ

Der Typ des Objekts, das zugeordnet wird.

Enums
TYPE_UNSPECIFIED Nicht angegebener Typ der Namenszuordnung.
DATABASE Das zugeordnete Objekt ist eine Datenbank.
SCHEMA Das zuzuordnende Objekt ist ein Schema.
RELATION Das zuzuordnende Objekt ist eine Beziehung.
ATTRIBUTE Das zugeordnete Objekt ist ein Attribut.
RELATION_ALIAS Das zuzuordnende Objekt ist ein Beziehungsalias.
ATTRIBUTE_ALIAS Das zugeordnete Objekt ist ein Attributalias.
FUNCTION Das zugeordnete Objekt ist eine Funktion.

NameMappingValue

Die potenziellen Komponenten einer vollständigen Namenszuordnung, die während der Übersetzung im Ziel-Data Warehouse zugeordnet werden.

JSON-Darstellung 
{
  "database": string,
  "schema": string,
  "relation": string,
  "attribute": string
}
Felder
database

string

Der Datenbankname (BigQuery-Projekt-ID-Äquivalent im Ziel-Data-Warehouse).
schema

string

Der Schemaname (BigQuery-Dataset-Entsprechung im Ziel-Data-Warehouse).
relation

string

Der Beziehungsname (Äquivalent der BigQuery-Tabelle oder -Ansicht im Ziel-Data-Warehouse).
attribute

string

Der Attributname (Äquivalent der BigQuery-Spalte im Ziel-Data-Warehouse).

Dialekt

Die möglichen Dialektoptionen für die Übersetzung.

JSON-Darstellung 
{

  // Union field dialect_value can be only one of the following:
  "bigqueryDialect": {
    object (BigQueryDialect)
  },
  "hiveqlDialect": {
    object (HiveQLDialect)
  },
  "redshiftDialect": {
    object (RedshiftDialect)
  },
  "teradataDialect": {
    object (TeradataDialect)
  },
  "oracleDialect": {
    object (OracleDialect)
  },
  "sparksqlDialect": {
    object (SparkSQLDialect)
  },
  "snowflakeDialect": {
    object (SnowflakeDialect)
  },
  "netezzaDialect": {
    object (NetezzaDialect)
  },
  "azureSynapseDialect": {
    object (AzureSynapseDialect)
  },
  "verticaDialect": {
    object (VerticaDialect)
  },
  "sqlServerDialect": {
    object (SQLServerDialect)
  },
  "postgresqlDialect": {
    object (PostgresqlDialect)
  },
  "prestoDialect": {
    object (PrestoDialect)
  },
  "mysqlDialect": {
    object (MySQLDialect)
  }
  // End of list of possible types for union field dialect_value.
}
Felder
Union-Feld dialect_value. Die möglichen Dialektoptionen, die diese Nachricht darstellt. Für dialect_value ist nur einer der folgenden Werte zulässig:
bigqueryDialect

object (BigQueryDialect)

BigQuery-Dialekt
hiveqlDialect

object (HiveQLDialect)

HiveQL-Dialekt
redshiftDialect

object (RedshiftDialect)

Redshift-Dialekt
teradataDialect

object (TeradataDialect)

Teradata-Dialekt
oracleDialect

object (OracleDialect)

Oracle-Dialekt
sparksqlDialect

object (SparkSQLDialect)

SparkSQL-Dialekt
snowflakeDialect

object (SnowflakeDialect)

Snowflake-Dialekt
netezzaDialect

object (NetezzaDialect)

Netezza-Dialekt
azureSynapseDialect

object (AzureSynapseDialect)

Azure Synapse-Dialekt
verticaDialect

object (VerticaDialect)

Der Vertica-Dialekt
sqlServerDialect

object (SQLServerDialect)

SQL Server-Dialekt
postgresqlDialect

object (PostgresqlDialect)

Postgresql-Dialekt
prestoDialect

object (PrestoDialect)

Presto-Dialekt
mysqlDialect

object (MySQLDialect)

MySQL-Dialekt

BigQueryDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für BigQuery.

HiveQLDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für HiveQL.

RedshiftDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Redshift.

TeradataDialect

Die Dialektdefinition für Teradata.

JSON-Darstellung 
{
  "mode": enum (Mode)
}
Felder
mode

enum (Mode)

Welchen Teradata-Subdialektsmodus der Nutzer angibt.

Modus

Die Subdialektsoptionen für Teradata.

Enums
MODE_UNSPECIFIED Nicht angegebener Modus.
SQL Teradata SQL-Modus.
BTEQ BTEQ-Modus (einschließlich SQL).

OracleDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Oracle.

SparkSQLDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für SparkSQL.

SnowflakeDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Snowflake.

NetezzaDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Netezza.

AzureSynapseDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Azure Synapse.

VerticaDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Vertica.

SQLServerDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für SQL Server.

PostgresqlDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Postgresql.

PrestoDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für Presto.

MySQLDialect

Dieser Typ hat keine Felder.

Die Dialektdefinition für MySQL.

SourceEnv

Stellt die Standardwerte der Quellumgebung für die Übersetzung dar.

JSON-Darstellung 
{
  "defaultDatabase": string,
  "schemaSearchPath": [
    string
  ],
  "metadataStoreDataset": string
}
Felder
defaultDatabase

string

Der Standarddatenbankname, um SQL-Objekte vollständig zu qualifizieren, wenn deren Datenbankname fehlt.
schemaSearchPath[]

string

Der Schemasuchpfad. Wenn SQL-Objekten der Schemaname fehlt, durchsucht das Übersetzungsmodul diese Liste nach dem Wert.

Status

Mögliche Status einer Migrationsaufgabe.

Enums
STATE_UNSPECIFIED Der Zustand ist nicht spezifiziert.
PENDING Die Aufgabe wartet auf die Orchestrierung.
ORCHESTRATING Die Aufgabe wird einem Orchestrator zugewiesen.
RUNNING Die Aufgabe wird ausgeführt, d.h., die Unteraufgaben sind zur Ausführung bereit.
PAUSED Die Aufgabe wurde pausiert. Zugewiesene Unteraufgaben können fortgesetzt werden, es werden jedoch keine neuen Unteraufgaben geplant.
SUCCEEDED Die Aufgabe wurde erfolgreich abgeschlossen.
FAILED Die Aufgabe wurde nicht erfolgreich abgeschlossen.

Status

Mögliche Status des Migrationsworkflows.

Enums
STATE_UNSPECIFIED Workflowstatus ist nicht angegeben.
DRAFT Der Workflow befindet sich im Entwurfsstatus, d.h., die Aufgaben können noch nicht ausgeführt werden.
RUNNING Der Workflow wird ausgeführt (d.h. die Aufgaben können ausgeführt werden).
PAUSED Der Workflow ist pausiert. Derzeit ausgeführte Aufgaben können fortgesetzt werden, es werden jedoch keine weiteren Aufgaben geplant.
COMPLETED Der Workflow ist abgeschlossen. Es sollte keine Aufgaben geben, die sich in einem nicht-terminalen Zustand befinden, aber falls doch (z.B. durch erzwungene Beendigung), werden sie nicht eingeplant.

Methoden

create

 Erstellt einen Migrationsworkflow.

delete

 Löscht einen Migrationsworkflow nach Name.

get

 Ruft einen zuvor erstellten Migrationsworkflow ab.

list

 Listet den zuvor erstellten Migrationsworkflow auf.

start

 Startet einen zuvor erstellten Migrationsworkflow.