REST Resource: projects.locations.workflows

リソース: MigrationWorkflow

EDW 移行に必要な作業を指定する移行ワークフロー。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "tasks": {
    string: {
      object (MigrationTask)
    },
    ...
  },
  "state": enum (State),
  "createTime": string,
  "lastUpdateTime": string
}
フィールド
name

string

出力専用。変更不可。ID。移行ワークフローの固有識別子。ID はサーバーによって生成されます。

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

string

ワークフローの表示名。ワークフローにわかりやすい名前を付けるために設定できます。一意性の保証も、強制適用もありません。
tasks

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

名前付きマップにあるワークフロー内のタスク。名前（キーなど）に意味はなく、ワークフローの特定のタスクを処理するための便利な方法にすぎません。
state

enum (State)

出力専用。ワークフローのステータス。
createTime

string (Timestamp format)

ワークフローが作成された時刻。
lastUpdateTime

string (Timestamp format)

ワークフローが最後に更新された時刻。

MigrationTask

移行用の単一のタスク。タスクの構成に関する詳細が含まれます。

JSON 表現 
{
  "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.
}
フィールド
id

string

出力専用。変更不可。移行タスクの固有識別子。ID はサーバーによって生成されます。
type

string

タスクのタイプ。サポートされているタスクタイプ（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)

出力専用。デプロイの現在の状態。
processingError

object (ErrorInfo)

出力専用。タスクが FAILED 状態のときに表示される説明。
createTime

string (Timestamp format)

タスクが作成された時刻。
lastUpdateTime

string (Timestamp format)

タスクが最後に更新された時刻。
resourceErrorDetails[]

object (ResourceErrorDetail)

出力専用。タスクの処理中に発生したエラーと問題の詳細を提供します。エラーの詳細が存在しても、タスクが失敗したわけではありません。
共用体フィールド task_details。タスクの詳細。task_details は次のいずれかになります。
translationConfigDetails

object (TranslationConfigDetails)

CW バッチ / オフライン SQL 変換のタスク構成。

TranslationConfigDetails

変換タスクとサブタスクに必要な設定をキャプチャする変換構成。

JSON 表現 
{
  "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.
}
フィールド
sourceDialect

object (Dialect)

入力ファイルの言語。
targetDialect

object (Dialect)

エンジンが入力を変換するターゲット言語。
sourceEnv

object (SourceEnv)

変換のデフォルトのソース環境の値。
requestSource

string

変換リクエストの開始者を示すインジケーター。
共用体フィールド source_location。入力ファイルのソースの場所として選択したパス。source_location は次のいずれかになります。
gcsSourcePath

string

タスクで変換するファイルが存在するディレクトリの Cloud Storage パス。
共用体フィールド target_location。出力ファイルの場所として選択したパス。target_location は次のいずれかになります。
gcsTargetPath

string

対応する入力ファイルを書き戻す Cloud Storage パス。
nameMappingList

object (ObjectNameMappingList)

オブジェクトと目的の出力名のリスト形式のマッピング。

ObjectNameMappingList

名前のマッピングのマップを、既存の名前から目的の出力名への Key:Value プロト メッセージのリストを使用して表します。

JSON 表現 
{
  "nameMap": [
    {
      object (ObjectNameMapping)
    }
  ]
}
フィールド
nameMap[]

object (ObjectNameMapping)

オブジェクト名マップの要素。

ObjectNameMapping

NameMappingKey から NameMappingValue への Key-Value ペアで、入力値から目的の出力への SQL 名のマッピングを表します。

JSON 表現 
{
  "source": {
    object (NameMappingKey)
  },
  "target": {
    object (NameMappingValue)
  }
}
フィールド
source

object (NameMappingKey)

マッピングされるソース内のオブジェクトの名前。
target

object (NameMappingValue)

マッピングされるオブジェクトのターゲット名。

NameMappingKey

完全な名前のマッピングのコンポーネント。ソースデータ ウェアハウスで変換時にマッピングされます。

JSON 表現 
{
  "type": enum (Type),
  "database": string,
  "schema": string,
  "relation": string,
  "attribute": string
}
フィールド
type

enum (Type)

マッピングされるオブジェクトのタイプ。
database

string

データベース名（ソース データ ウェアハウスの BigQuery プロジェクト ID に相当）。
schema

string

スキーマ名（ソース データ ウェアハウスの BigQuery データセットに相当）。
relation

string

関係名（ソースデータ ウェアハウスの BigQuery テーブルまたはビューに相当）。
attribute

string

属性名（ソース データ ウェアハウスの BigQuery 列に相当）。

タイプ

マッピングされるオブジェクトのタイプ。

列挙型
TYPE_UNSPECIFIED 名前のマッピング タイプが指定されていません。
DATABASE マッピングされるオブジェクトはデータベース。
SCHEMA マッピングされるオブジェクトはスキーマ。
RELATION マッピングされるオブジェクトは関係。
ATTRIBUTE マッピングされるオブジェクトは属性。
RELATION_ALIAS マッピングされるオブジェクトはリレーション エイリアス。
ATTRIBUTE_ALIAS マッピングされるオブジェクトは属性のエイリアス。
FUNCTION マッピングされるオブジェクトは関数。

NameMappingValue

完全な名前のマッピングのコンポーネント。ターゲット データ ウェアハウスで変換時にマッピングされます。

JSON 表現 
{
  "database": string,
  "schema": string,
  "relation": string,
  "attribute": string
}
フィールド
database

string

データベース名（ターゲット データ ウェアハウスの BigQuery プロジェクト ID に相当）。
schema

string

スキーマ名（ターゲット データ ウェアハウスの BigQuery データセットに相当）。
relation

string

関係名（ターゲット データ ウェアハウスの BigQuery テーブルまたはビューに相当）。
attribute

string

属性名（ターゲット データ ウェアハウスの BigQuery 列に相当）。

言語

変換に使用できる言語のオプション。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド dialect_value。このメッセージが表す可能な言語オプション。dialect_value は次のいずれかになります。
bigqueryDialect

object (BigQueryDialect)

BigQuery 言語
hiveqlDialect

object (HiveQLDialect)

HiveQL 言語
redshiftDialect

object (RedshiftDialect)

Redshift 言語
teradataDialect

object (TeradataDialect)

Teradata 言語
oracleDialect

object (OracleDialect)

Oracle 言語
sparksqlDialect

object (SparkSQLDialect)

SparkSQL 言語
snowflakeDialect

object (SnowflakeDialect)

Snowflake 言語
netezzaDialect

object (NetezzaDialect)

Netezza 言語
azureSynapseDialect

object (AzureSynapseDialect)

Azure Synapse 言語
verticaDialect

object (VerticaDialect)

Vertica 言語
sqlServerDialect

object (SQLServerDialect)

SQL Server 言語
postgresqlDialect

object (PostgresqlDialect)

Postgresql 言語
prestoDialect

object (PrestoDialect)

Presto 言語
mysqlDialect

object (MySQLDialect)

MySQL 言語

BigQueryDialect

この型にはフィールドがありません。

BigQuery の言語定義。

HiveQLDialect

この型にはフィールドがありません。

HiveQL の言語定義。

RedshiftDialect

この型にはフィールドがありません。

Redshift の言語定義。

TeradataDialect

Teradata の言語定義。

JSON 表現 
{
  "mode": enum (Mode)
}
フィールド
mode

enum (Mode)

ユーザーが指定する Teradata サブ言語モード。

モード

Teradata のサブ言語のオプション。

列挙型
MODE_UNSPECIFIED モードが指定されていません。
SQL Teradata SQL モード。
BTEQ BTEQ モード（SQL を含む）。

OracleDialect

この型にはフィールドがありません。

Oracle の言語定義。

SparkSQLDialect

この型にはフィールドがありません。

SparkSQL の言語定義。

SnowflakeDialect

この型にはフィールドがありません。

Snowflake の言語定義。

NetezzaDialect

この型にはフィールドがありません。

Netezza の言語定義。

AzureSynapseDialect

この型にはフィールドがありません。

Azure Synapse の言語定義。

VerticaDialect

この型にはフィールドがありません。

Vertica の言語定義。

SQLServerDialect

この型にはフィールドがありません。

SQL Server の言語定義。

PostgresqlDialect

この型にはフィールドがありません。

Postgresql の言語定義。

PrestoDialect

この型にはフィールドがありません。

Presto の言語定義。

MySQLDialect

この型にはフィールドがありません。

MySQL の言語定義。

SourceEnv

変換のデフォルトのソース環境の値を表します。

JSON 表現 
{
  "defaultDatabase": string,
  "schemaSearchPath": [
    string
  ],
  "metadataStoreDataset": string
}
フィールド
defaultDatabase

string

データベース名がない場合の SQL オブジェクトの完全修飾に使用するデフォルトのデータベース名。
schemaSearchPath[]

string

スキーマの検索パス。SQL オブジェクトにスキーマ名がない場合は、変換エンジンがこのリストを検索して値を見つけます。

状態

移行タスクの取り得る状態。

列挙型
STATE_UNSPECIFIED 状態は指定されていません。
PENDING タスクはオーケストレーションを待っています。
ORCHESTRATING タスクはオーケストレーターに割り当てられます。
RUNNING タスクが実行中です（サブタスクの実行準備が完了しています）。
PAUSED タスクは一時停止されます。割り当てられたサブタスクは継続できますが、新しいサブタスクはスケジュールされません。
SUCCEEDED タスクが正常に完了しました。
FAILED タスクが正常に終了しませんでした。

状態

移行ワークフローの状態。

列挙型
STATE_UNSPECIFIED ワークフローの状態が指定されていません。
DRAFT ワークフローがドラフト ステータスです。つまり、タスクはまだ実行できません。
RUNNING ワークフローが実行中です（タスクが実行可能な状態です）。
PAUSED ワークフローは一時停止しています。現在進行中のタスクは続行されますが、それ以降のタスクはスケジュールされません。
COMPLETED ワークフローが完了しました。終了以外の状態のタスクは存在しないはずですが、存在する場合（強制終了など）はスケジュールされません。

メソッド

create

 移行ワークフローを作成します。

delete

 移行ワークフローを名前で削除します。

get

 以前に作成された移行ワークフローを取得します。

list

 以前に作成された移行ワークフローを一覧表示します。

start

 以前に作成した移行ワークフローを開始します。