パッケージ google.cloud.bigquery.datatransfer.v1

インデックス

DataTransferService

Google BigQuery Data Transfer Service API を使用すれば、BigQuery ユーザーは、他の Google プロダクトから BigQuery へのデータの転送を構成することができます。このサービスには、エンドユーザーに公開されるメソッドが含まれています。このサービスは、フロントエンドを支えます。

CheckValidCreds

rpc CheckValidCreds(CheckValidCredsRequest) returns (CheckValidCredsResponse)

指定されたデータソースとリクエストしているユーザーに有効な認証情報が存在する場合、true を返します。一部のデータソースはサービス アカウントをサポートしていないため、エンドユーザーの代わりにそれらと通信する必要があります。この API は、特定のユーザーの OAuth トークンがあるかどうかをチェックするだけです。これが、ユーザーが転送構成を作成するための前提条件になります。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
CreateTransferConfig

rpc CreateTransferConfig(CreateTransferConfigRequest) returns (TransferConfig)

新しいデータ転送の構成を作成します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
DeleteTransferConfig

rpc DeleteTransferConfig(DeleteTransferConfigRequest) returns (Empty)

データ転送の構成を削除します。関連する転送実行とログも削除されます。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
DeleteTransferRun

rpc DeleteTransferRun(DeleteTransferRunRequest) returns (Empty)

指定した転送実行を削除します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

サポートされるデータソースを取得し、設定を返します。この設定は UI のレンダリングに使用できます。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
GetTransferConfig

rpc GetTransferConfig(GetTransferConfigRequest) returns (TransferConfig)

データ転送の構成に関する情報を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
GetTransferRun

rpc GetTransferRun(GetTransferRunRequest) returns (TransferRun)

特定の転送実行に関する情報を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

サポートされるデータソースのリストを作成し、その設定を返します。この設定は UI のレンダリングに使用できます。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
ListTransferConfigs

rpc ListTransferConfigs(ListTransferConfigsRequest) returns (ListTransferConfigsResponse)

プロジェクトのすべてのデータ転送に関する情報を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
ListTransferLogs

rpc ListTransferLogs(ListTransferLogsRequest) returns (ListTransferLogsResponse)

データ転送実行に関するユーザー向けのログメッセージを返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
ListTransferRuns

rpc ListTransferRuns(ListTransferRunsRequest) returns (ListTransferRunsResponse)

実行中のジョブと完了したジョブの情報を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
ScheduleTransferRuns

rpc ScheduleTransferRuns(ScheduleTransferRunsRequest) returns (ScheduleTransferRunsResponse)

時間範囲 [start_time, end_time] の転送実行を作成します。範囲内の日付ごとに 1 つの転送実行が作成されます。データソースがより細かい単位に対応している場合には、その単位で作成します。実行は、時間範囲内で UTC 時間ごとに作成されます。非推奨: 代わりに StartManualTransferRuns を使用してください。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
StartManualTransferRuns

rpc StartManualTransferRuns(StartManualTransferRunsRequest) returns (StartManualTransferRunsResponse)

schedule_time を現在時刻に設定し、手動転送実行をすぐに開始します。start_time（この時間を含む）から end_time（この時間を除く）までの間、あるいは特定の run_time の間、転送実行を作成します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
UpdateTransferConfig

rpc UpdateTransferConfig(UpdateTransferConfigRequest) returns (TransferConfig)

データ転送の構成を更新します。更新しない場合でも、すべてのフィールドを設定する必要があります。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

CheckValidCredsRequest

ユーザーが有効な認証情報を持っているかどうかを判断するためのリクエスト。このメソッドは、ユーザー インターフェースの OAuth ポップアップの数を制限するために使用されます。ユーザー ID は、API 呼び出しコンテキストから推定されます。データソースが Google+ 承認タイプの場合、このメソッドは false を返します。これは、ユーザー ID だけで認証情報がすでに有効になっているかどうかを判断することができないためです。

フィールド
name

string

必須。データソース。形式は projects/{project_id}/dataSources/{data_source_id} または projects/{project_id}/locations/{location_id}/dataSources/{data_source_id} です。

認証には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.transfers.get

CheckValidCredsResponse

認証情報が存在し、有効かどうかを表すレスポンス。

フィールド
has_valid_creds

bool

true に設定されている場合、認証情報が存在し、有効です。

CreateTransferConfigRequest

データ転送構成を作成するためのリクエスト。この転送構成に新しい認証情報が必要な場合は、認証コードを指定する必要があります。認証コードが指定された場合は、転送構成が認証コードに対応するユーザー ID に関連付けられます。そうでない場合は、転送構成が呼び出し側のユーザーに関連付けられます。

フィールド
parent

string

必須。転送構成が作成される BigQuery プロジェクト ID。projects/{project_id}/locations/{location_id} または projects/{project_id} の形式にする必要があります。指定したロケーションと宛先 BigQuery データセットのロケーションが一致しない場合、リクエストが失敗します。

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.update
transfer_config

TransferConfig

必須。作成するデータ転送構成。
authorization_code

string

（省略可）この転送構成で使用される OAuth2 認証コード。CheckValidCreds で指定されているように、新しい認証情報が必要な場合は必須です。authorization_code を取得するには、https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= に対してリクエストを発行してください。

  • client_id は、ListDataSources メソッドから返される特定のデータソースの BigQuery DTS API の OAuth client_id である必要があります。
  • data_source_scopes は、ListDataSources メソッドから返されるスコープです。
  • redirect_uri は、オプション パラメータです。指定されなかった場合は、認証コードが認証フロー ウィンドウのオープナーに送信されます。そうでない場合は、リダイレクト URI に送信されます。urn:ietf:wg:oauth:2.0:oob の特殊な値は、ユーザーにコードをコピーしてアプリケーションに貼り付けるように要求するページテキストとともに、認証コードがブラウザのタイトルバーに返されることを意味します。
version_info

string

バージョン情報。これは省略可能です。直近、つまりアクセス承認直後のアクセス トークンを検索する場合は、トークン リクエストに version_info クレームを設定する必要があります。version_info を取得するには、レスポンス タイプに none+gsession を使用する必要があります。これにより、認証レスポンスで version_info が返されます。これはトークン リクエストの JWT クレームに格納されます。
service_account_name

string

サービス アカウント名。これは省略可能です。このフィールドが設定されている場合、このサービス アカウントの認証情報を使用して転送構成が作成されます。この API を呼び出すユーザーには、このサービス アカウントとして機能するための権限が必要です。

DataSource

データソースのメタデータを表します。メタデータだけで UI をレンダリングし、適切な OAuth トークンをリクエストできます。

フィールド
name

string

出力のみ。データソースのリソース名。
data_source_id

string

データソースの ID。
display_name

string

わかりやすいデータソース名。
description

string

わかりやすいデータソースの説明。
client_id

string

更新トークンの取得に使用するデータソースのクライアント ID。
scopes[]

string

更新トークンを取得する API auth スコープ。これらのスコープは、データソースがデータを準備し、BigQuery に取り込む場合に必要になります（たとえば、https://www.googleapis.com/auth/bigquery）。
transfer_type
(deprecated)

TransferType

非推奨。このフィールドは無視されます。
supports_multiple_transfers
(deprecated)

bool

非推奨。このフィールドは無視されます。
update_deadline_seconds

int32

Data Transfer Service が転送を失敗としてマークするまで、データソースからの更新を待機する秒数。
default_schedule

string

デフォルトのデータ転送スケジュール。有効なスケジュールの例: 1st,3rd monday of month 15:30、every wed,fri of jan,jun 13:15、first sunday of quarter 00:00。
supports_custom_schedule

bool

データソースがユーザー定義のスケジュールをサポートするのか、デフォルトのスケジュールを使用するのかを指定します。true に設定すると、ユーザーがデフォルトのスケジュールを上書きできます。
parameters[]

DataSourceParameter

データソースのパラメータ。
help_url

string

このデータソースのヘルプ ドキュメントの URI。
authorization_type

AuthorizationType

認証タイプを表します。
data_refresh_type

DataRefreshType

データソースが過去数日分のデータの自動更新をサポートするかどうかを指定します。サポートする場合には、その方法も設定します。データソースによっては、データが完了するまでに数日かかる場合があります。この場合、データの自動更新は便利な機能です。
default_data_refresh_window_days

int32

デフォルトのデータ更新ウィンドウ（日数）。data_refresh_type = SLIDING_WINDOW の場合にのみ有効です。
manual_runs_disabled

bool

データソースのバックフィルと手動実行スケジュールを無効にします。
minimum_schedule_interval

Duration

スケジューラが実行をスケジュールする最小間隔。

AuthorizationType

このデータソースに必要な認証タイプ。

列挙値
AUTHORIZATION_TYPE_UNSPECIFIED 未指定
AUTHORIZATION_CODE バックエンドの更新トークンと交換可能な OAuth 2 認証コードを使用します。
GOOGLE_PLUS_AUTHORIZATION_CODE 特定の Google+ ページの認証コードを返します。このコードは、バックエンドの更新トークンと交換できます。
FIRST_PARTY_OAUTH Loas Owned Clients に基づいて First Party OAuth を使用します。First Party OAuth では、オフライン アクセス トークンの取得に更新トークンを必要としません。代わりに、クライアントによって署名された JWT アサーションを使用してアクセス トークンを取得します。

DataRefreshType

データソースがデータの自動更新をサポートする方法を表します。

列挙値
DATA_REFRESH_TYPE_UNSPECIFIED データソースはデータの自動更新をサポートしません。これはデフォルトの値です。
SLIDING_WINDOW データソースはデータの自動更新をサポートし、過去数日分の更新スケジュールを設定できます。転送構成にカスタム値を設定することはできません。
CUSTOM_SLIDING_WINDOW データソースはデータの自動更新をサポートし、過去数日分の更新スケジュールを設定できます。転送構成にカスタム値を設定できます。

DataSourceParameter

パラメータを UI でレンダリングできるように検証ルールを含むデータソース パラメータを表します。これらのパラメータは対応のデータソースによって提供され、レンダリングと検証に必要なすべての情報が含まれています。この API の使用者が汎用的な UI を生成するのか、カスタム データソース固有の形式を生成するのかを決めることができます。

フィールド
param_id

string

パラメータ ID。
display_name

string

ユーザー インターフェースに表示されるパラメータ名。
description

string

パラメータの説明。
type

Type

パラメータの型。
required

bool

パラメータが必須かどうかを表します。
repeated

bool

非推奨。このフィールドは無視されます。
validation_regex

string

パラメータの検証で使用できる正規表現。
allowed_values[]

string

パラメータに使用可能な値。
min_value

DoubleValue

整数型と倍精度型の場合、使用可能な最小値を指定します。
max_value

DoubleValue

整数型と倍精度型の場合、使用可能な最大値を指定します。
fields[]

DataSourceParameter

非推奨。このフィールドは無視されます。
validation_description

string

このフィールドの要件。ユーザーの入力が正規表現のパターンまたは最大値 / 最小値を満たしてない場合に表示します。
validation_help_url

string

命名規則を説明するヘルプ ドキュメントの URL。
immutable

bool

最初の作成後に変更することはできません。
recurse

bool

非推奨。このフィールドは無視されます。
deprecated

bool

true の場合、新しい転送では使用できず、ユーザーにも表示されません。

型

パラメータの型。

列挙値
TYPE_UNSPECIFIED 未指定
STRING 文字列型パラメータ
INTEGER 整数型パラメータ（64 ビット）。JSON には文字列としてシリアライズされます。
DOUBLE 倍精度浮動小数点型パラメータ
BOOLEAN ブール型パラメータ
RECORD 非推奨。このフィールドは無視されます。
PLUS_PAGE Google+ ページのページ ID

DeleteTransferConfigRequest

データ転送情報を削除するためのリクエスト。関連する転送実行とログメッセージもすべて削除されます。

フィールド
name

string

必須。このフィールドには、リクエストされたリソースの名前が入ります。例: projects/{project_id}/transferConfigs/{config_id}、projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

認証には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.transfers.update

DeleteTransferRunRequest

データ転送実行情報を削除するためのリクエスト。

フィールド
name

string

必須。このフィールドには、リクエストされたリソースの名前が入ります。例: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}、projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

認証には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.transfers.update

EmailPreferences

転送実行イベントのメール通知を送信する設定。

フィールド
enable_failure_email

bool

true の場合、転送実行の失敗時にメール通知が送信されます。

GetDataSourceRequest

データソース情報を取得するためのリクエスト。

フィールド
name

string

必須。このフィールドには、リクエストされたリソースの名前が入ります。例: projects/{project_id}/dataSources/{data_source_id}、projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

認証には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.transfers.get

GetTransferConfigRequest

データ転送情報を取得するためのリクエスト。

フィールド
name

string

必須。このフィールドには、リクエストされたリソースの名前が入ります。例: projects/{project_id}/transferConfigs/{config_id}、projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

認証には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.transfers.get

GetTransferRunRequest

データ転送実行情報を取得するためのリクエスト。

フィールド
name

string

必須。このフィールドには、リクエストされたリソースの名前が入ります。例: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}、projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

認証には、指定されたリソース name に対する次の IAM の権限が必要です。

  • bigquery.transfers.get

ListDataSourcesRequest

サポートされているデータソースとそのデータ転送設定を一覧表示するためのリクエスト。

フィールド
parent

string

必須。データソースを返す必要がある BigQuery プロジェクト ID。projects/{project_id} または projects/{project_id}/locations/{location_id} の形式にする必要があります

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.get
page_token

string

ページ分割トークン。ListDataSourcesRequest リスト結果の特定のページをリクエストする場合に使用できます。複数ページの結果の場合は、ListDataSourcesResponse が next_page トークンを出力します。このトークンを page_token 値として使用して、リスト結果の次のページをリクエストできます。
page_size

int32

ページサイズ。デフォルトのページサイズは 1,000（最大値）です。

ListDataSourcesResponse

サポートされるデータソースとメタデータのリストを返します。

フィールド
data_sources[]

DataSource

サポートされているデータソースと転送設定のリスト。
next_page_token

string

出力のみ。次のページ分割トークン。複数ページのリスト結果の場合、このトークンを ListDataSourcesRequest.page_token として使用すると、リスト結果の次のページをリクエストできます。

ListTransferConfigsRequest

BigQuery プロジェクト用に構成されたデータ転送を一覧表示するためのリクエスト。

フィールド
parent

string

必須。データソースを返す必要がある BigQuery プロジェクト ID（projects/{project_id} または projects/{project_id}/locations/{location_id}）。

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.get
data_source_ids[]

string

指定した場合、リクエストしたデータソースの構成のみを返します。
page_token

string

ページ分割トークン。ListTransfersRequest リスト結果の特定のページをリクエストする場合に使用できます。複数ページの結果の場合は、ListTransfersResponse が next_page トークンを出力します。このトークンを page_token 値として使用して、リスト結果の次のページをリクエストできます。
page_size

int32

ページサイズ。デフォルトのページサイズは 1,000（最大値）です。

ListTransferConfigsResponse

プロジェクトに返されたパイプラインのリスト。

フィールド
transfer_configs[]

TransferConfig

出力のみ。保存されたパイプライン転送構成。
next_page_token

string

出力のみ。次のページ分割トークン。複数ページのリスト結果の場合、このトークンを ListTransferConfigsRequest.page_token として使用すると、リスト結果の次のページをリクエストできます。

ListTransferLogsRequest

データ転送実行に関連付けられたユーザー向けのログメッセージを取得するためのリクエスト。

フィールド
parent

string

必須。転送実行名。形式は projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} または projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id} です。

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.get
page_token

string

ページ分割トークン。ListTransferLogsRequest リスト結果の特定のページをリクエストする場合に使用できます。複数ページの結果の場合は、ListTransferLogsResponse が next_page トークンを出力します。このトークンを page_token 値として使用して、リスト結果の次のページをリクエストできます。
page_size

int32

ページサイズ。デフォルトのページサイズは 1,000（最大値）です。
message_types[]

MessageSeverity

返されるメッセージのタイプ。指定しないと、INFO、WARNING または ERROR メッセージが返されます。

ListTransferLogsResponse

返された転送実行メッセージのリスト

フィールド
transfer_messages[]

TransferMessage

出力のみ。保存されたパイプライン転送のメッセージ。
next_page_token

string

出力のみ。次のページ分割トークン。複数ページのリスト結果の場合、このトークンを GetTransferRunLogRequest.page_token として使用すると、リスト結果の次のページをリクエストできます。

ListTransferRunsRequest

データ転送実行を一覧表示するためのリクエスト。UI は、このメソッドを使用して、特定のデータ転送実行を表示 / フィルタできます。データソースは、このメソッドを使用して、すべてのスケジュールされた転送実行をリクエストできます。

フィールド
parent

string

必須。取得する必要のある転送実行の転送構成の名前。転送構成リソース名の形式は projects/{project_id}/transferConfigs/{config_id} または projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} です。

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.get
states[]

TransferState

指定した場合は、リクエストされた状態の転送実行だけが返されます。
page_token

string

ページ分割トークン。ListTransferRunsRequest リスト結果の特定のページをリクエストする場合に使用できます。複数ページの結果の場合は、ListTransferRunsResponse が next_page トークンを出力します。このトークンを page_token 値として使用して、リスト結果の次のページをリクエストできます。
page_size

int32

ページサイズ。デフォルトのページサイズは 1,000（最大値）です。
run_attempt

RunAttempt

実行を pull する方法を表します。

RunAttempt

pull する実行を表します。

列挙値
RUN_ATTEMPT_UNSPECIFIED すべての実行を返します。
LATEST 毎日最後の実行だけを返します。

ListTransferRunsResponse

プロジェクトに返されたパイプラインのリスト。

フィールド
transfer_runs[]

TransferRun

出力のみ。保存されたパイプラインの転送実行。
next_page_token

string

出力のみ。次のページ分割トークン。複数ページのリスト結果の場合、このトークンを ListTransferRunsRequest.page_token として使用すると、リスト結果の次のページをリクエストできます。

ScheduleOptions

データ転送スケジュールをカスタマイズするオプション。

フィールド
disable_auto_scheduling

bool

true の場合、この構成のデータ転送の自動スケジュールは無効になります。StartManualTransferRuns API を使用すると、実行をアドホック ベースで開始できます。自動スケジュールが無効になっている場合、TransferConfig.schedule フィールドは無視されます。
start_time

Timestamp

転送実行のスケジュールを開始する時間を指定します。最初の実行は、スケジュール文字列に定義された繰り返しパターンに従って開始時間またはそれ以降にスケジュールされます。開始時間はいつでも変更できます。このオプションでは、手動でデータ転送が開始されるまでの時間は制限されません。
end_time

Timestamp

転送実行のスケジュールを停止する時間を定義します。転送実行は、終了時間またはそれ以降にスケジュールできません。終了時間はいつでも変更できます。このオプションでは、手動でデータ転送が開始されるまでの時間は制限されません。

ScheduleTransferRunsRequest

時間範囲内の転送実行をスケジュールするためのリクエスト。

フィールド
parent

string

必須。転送構成名。形式は projects/{project_id}/transferConfigs/{config_id} または projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} です。

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.update
start_time

Timestamp

必須。転送実行の範囲の開始時刻。例: "2017-05-25T00:00:00+00:00"。
end_time

Timestamp

必須。転送実行の範囲の終了時刻。例: "2017-05-30T00:00:00+00:00"。

ScheduleTransferRunsResponse

ある時間内にスケジュールされた転送実行に対するレスポンス。

フィールド
runs[]

TransferRun

スケジュールされた転送実行。

StartManualTransferRunsRequest

手動転送実行を開始するためのリクエスト。

フィールド
parent

string

転送構成名。形式は projects/{project_id}/transferConfigs/{config_id} または projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} です。

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.update
共用体フィールド time。リクエストされた時間指定 - 期間または特定の run_time を指定できます。time は次のいずれかになります。
requested_time_range

TimeRange

転送実行を開始する期間。
requested_run_time

Timestamp

転送実行を開始する特定の run_time。requested_run_time に将来の時間を指定することはできません。

TimeRange

時間指定の仕様。start_time（この時間を含む）から end_time（この時間を除く）までの run_time を使用して転送実行をリクエストします。

フィールド
start_time

Timestamp

転送実行の範囲の開始時刻。例: "2017-05-25T00:00:00+00:00"。start_time は end_time より前に厳密に指定する必要があります。run_time が start_time（この時間を含む）から end_time（この時間を除く）までの範囲内にある間、転送実行を作成します。
end_time

Timestamp

転送実行の範囲の終了時刻。例: "2017-05-30T00:00:00+00:00"。end_time に将来の日付を指定することはできません。run_time が start_time（この時間を含む）から end_time（この時間を除く）までの範囲内にある間、転送実行を作成します。

StartManualTransferRunsResponse

手動転送実行を開始するためのレスポンス。

フィールド
runs[]

TransferRun

作成された転送実行の作成。

TransferConfig

データ転送の構成を表します。転送構成には、データ転送に必要なすべてのメタデータが含まれます。たとえば、destination_dataset_id はデータの保存場所を表します。新しい転送構成を作成すると、指定された destination_dataset_id が必要に応じて作成され、該当するデータソースのサービス アカウントと共有されます。

フィールド
name

string

転送構成のリソース名。転送構成名の形式は projects/{project_id}/locations/{region}/transferConfigs/{config_id} です。名前は、CreateTransferConfigRequest に指定された config_id、project_id、リージョンに基づいて自動的に生成されます。config_id が指定されていない場合、通常は config_id に uuid が生成されます。ただし uuid は生成されない場合や不要な場合もあります。
display_name

string

データ転送にユーザーが指定した表示名。
data_source_id

string

データソースの ID。データ転送の作成後は変更できません。
params

Struct

データ転送固有のパラメータ。
schedule

string

データ転送スケジュール。データソースでカスタム スケジュールがサポートされていない場合には、空にします。空の場合、データソースのデフォルト値が使用されます。時刻は UTC で指定します。有効な形式の例: 1st,3rd monday of month 15:30、every wed,fri of jan,jun 13:15、first sunday of quarter 00:00。形式の詳細については、https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format をご覧ください。注: 単位を 8 時間以上にするか、頻度を下げる必要があります。
schedule_options

ScheduleOptions

データ転送スケジュールをカスタマイズするオプション。
data_refresh_window_days

int32

自動的に更新するデータの日数。たとえば、data_refresh_window_days = 10 の場合、BigQuery は毎日、[today-1] のデータのみを取り込むのではなく、[today-10, today-1] のデータを再度取り込みます。データソースがこの機能をサポートしている場合にのみ有効です。デフォルト値を使用する場合には、値を 0 に設定します。
disabled

bool

この構成を無効にします。true に設定すると、指定した転送実行がスケジュールされません。
update_time

Timestamp

出力のみ。データ転送の変更時間。サーバーの入力では無視されます。
next_run_time

Timestamp

出力のみ。データ転送の次の実行時間。
state

TransferState

出力のみ。最後に更新された転送実行の状態。
user_id

int64

非推奨。転送が代行されたユーザーの一意の ID。
dataset_region

string

出力のみ。BigQuery データセットが配置されたリージョン。
notification_pubsub_topic

string

この転送構成に関連付けられた転送実行が完了した後に通知を送信する Pub/Sub トピック。
email_preferences

EmailPreferences

これらの設定により、この転送構成を所有しているユーザーのメールアドレスに通知が送信されます。
destination_dataset_id

string

BigQuery ターゲット データセット ID。

TransferMessage

特定のデータ転送でユーザーに表示されるメッセージを表します。

フィールド
message_time

Timestamp

メッセージがログに記録された時間。
severity

MessageSeverity

メッセージの重大度。
message_text

string

メッセージ文。

MessageSeverity

データ転送でユーザーに表示するメッセージの重大度を表します。

列挙値
MESSAGE_SEVERITY_UNSPECIFIED 重大度は指定されていません。
INFO 情報メッセージ
WARNING 警告メッセージ
ERROR エラー メッセージ

TransferRun

実行されるデータ転送を表します。

フィールド
name

string

転送実行のリソース名。転送実行名の形式は projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id} です。転送実行を作成する場合、この名前は無視されます。
schedule_time

Timestamp

転送実行が開始するまでの最小時間。
run_time

Timestamp

バッチ転送実行の場合、データを取り込む日時を指定します。
error_status

Status

転送実行のステータス。
start_time

Timestamp

出力のみ。転送実行の開始時間。入力リクエストでは、パラメータが無視されます。
end_time

Timestamp

出力のみ。転送実行の終了時間。入力リクエストでは、パラメータが無視されます。
update_time

Timestamp

出力のみ。データ転送実行状態が最後に更新された時間。
params

Struct

出力のみ。データ転送固有のパラメータ。
data_source_id

string

出力のみ。データソースの ID。
state

TransferState

データ転送の実行状態。入力リクエストでは無視されます。
user_id

int64

非推奨。転送が代行されたユーザーの一意の ID。
schedule

string

出力のみ。定期的なスケジュールの一部として転送ジョブが作成されている場合には、この転送ジョブのスケジュールが入ります。手動でスケジュールされたバッチ転送実行の場合、このフィールドは空になります。注: 現在の負荷状態に応じて、システムがスケジュールの延期を選択する場合があります。このため、この値と schedule_time が一致しないことがあります。
notification_pubsub_topic

string

出力のみ。この転送実行の完了後に通知を送信する Pub/Sub トピック
email_preferences

EmailPreferences

出力のみ。これらの設定により、この実行の転送構成を所有しているユーザーのメールアドレスに通知が送信されます。
destination_dataset_id

string

出力のみ。BigQuery ターゲット データセット ID。

TransferState

データ転送の実行状態を表します。

列挙値
TRANSFER_STATE_UNSPECIFIED 状態プレースホルダ。
PENDING データ転送はスケジュールされ、データ転送バックエンドによる実行を待機しています。
RUNNING データ転送の実行中です。
SUCCEEDED データ転送が正常に完了しました。
FAILED データ転送に失敗しました。
CANCELLED データ転送がキャンセルされました。

TransferType

非推奨。データ転送タイプを表します。

列挙値
TRANSFER_TYPE_UNSPECIFIED 転送タイプが無効または不明な場合のプレースホルダ。
BATCH バッチデータ転送。
STREAMING ストリーミング データ転送。現在、データソースのストリーミングでは、1 つのプロジェクトに複数の転送構成を作成できません。

UpdateTransferConfigRequest

転送構成を更新するためのリクエスト。転送構成のユーザー ID を更新するには、認証コードを指定する必要があります。

フィールド
transfer_config

TransferConfig

必須。作成するデータ転送構成。

認証には、指定されたリソース transferConfig に対する次の IAM の権限が必要です。

  • bigquery.transfers.update
authorization_code

string

（省略可）この転送構成で使用される OAuth2 認証コード。指定された場合は、転送構成が承認するユーザーに関連付けられます。authorization_code を取得するには、https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= に対してリクエストを発行してください。

  • client_id は、ListDataSources メソッドから返される特定のデータソースの BigQuery DTS API の OAuth client_id である必要があります。
  • data_source_scopes は、ListDataSources メソッドから返されるスコープです。
  • redirect_uri は、オプション パラメータです。指定されなかった場合は、認証コードが認証フロー ウィンドウのオープナーに送信されます。そうでない場合は、リダイレクト URI に送信されます。urn:ietf:wg:oauth:2.0:oob の特殊な値は、ユーザーにコードをコピーしてアプリケーションに貼り付けるように要求するページテキストとともに、認証コードがブラウザのタイトルバーに返されることを意味します。
update_mask

FieldMask

必須。このリクエストで更新が必要なフィールドのリスト。
version_info

string

バージョン情報。これは省略可能です。直近、つまりアクセス承認直後のアクセス トークンを検索する場合は、トークン リクエストに version_info クレームを設定する必要があります。version_info を取得するには、レスポンス タイプに none+gsession を使用する必要があります。これにより、認証レスポンスで version_info が返されます。これはトークン リクエストの JWT クレームに格納されます。
service_account_name

string

サービス アカウント名。これは省略可能です。このフィールドが設定され、update_mask で service_account_name が設定されている場合、このサービス アカウントの認証情報を使用して転送構成が更新されます。この API を呼び出すユーザーには、このサービス アカウントとして機能するための権限が必要です。