REST Resource: transferOperations

リソース: TransferOperation

転送の実行についての説明。

JSON 表現 
{
  "name": string,
  "projectId": string,
  "transferSpec": {
    object (TransferSpec)
  },
  "notificationConfig": {
    object (NotificationConfig)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "startTime": string,
  "endTime": string,
  "status": enum (Status),
  "counters": {
    object (TransferCounters)
  },
  "errorBreakdowns": [
    {
      object (ErrorSummary)
    }
  ],
  "transferJobName": string
}
フィールド
name

string

システムによって割り当てられたグローバルに一意の ID。
projectId

string

オペレーションを所有する Google Cloud プロジェクトの ID。
transferSpec

object (TransferSpec)

転送仕様。
notificationConfig

object (NotificationConfig)

通知の構成。
loggingConfig

object (LoggingConfig)

Cloud Logging の構成。
startTime

string (Timestamp format)

この転送の実行の開始時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

この転送の実行の終了時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
status

enum (Status)

転送オペレーションのステータス。
counters

object (TransferCounters)

転送オペレーションの進行状況に関する情報。
errorBreakdowns[]

object (ErrorSummary)

サンプル エラーログエントリで発生したエラーの概要を表示します。
transferJobName

string

この転送オペレーションをトリガーする転送ジョブの名前。

ステータス

TransferOperation のステータス。

列挙型
STATUS_UNSPECIFIED ゼロは無効な値です。
IN_PROGRESS 進行中です。
PAUSED 一時停止しました。
SUCCESS 正常に完了しました。
FAILED 回復不能なエラーのため終了しました。
ABORTED ユーザーによって中止されました。
QUEUED システムにより一時的に遅延しています。ユーザーによる対応は必要ありません。
SUSPENDING オペレーションが停止し、進行中の処理が完了するまでドレインされます。

TransferCounters

転送操作の進行状況を報告するカウンターのコレクション。

JSON 表現 
{
  "objectsFoundFromSource": string,
  "bytesFoundFromSource": string,
  "objectsFoundOnlyFromSink": string,
  "bytesFoundOnlyFromSink": string,
  "objectsFromSourceSkippedBySync": string,
  "bytesFromSourceSkippedBySync": string,
  "objectsCopiedToSink": string,
  "bytesCopiedToSink": string,
  "objectsDeletedFromSource": string,
  "bytesDeletedFromSource": string,
  "objectsDeletedFromSink": string,
  "bytesDeletedFromSink": string,
  "objectsFromSourceFailed": string,
  "bytesFromSourceFailed": string,
  "objectsFailedToDeleteFromSink": string,
  "bytesFailedToDeleteFromSink": string,
  "directoriesFoundFromSource": string,
  "directoriesFailedToListFromSource": string,
  "directoriesSuccessfullyListedFromSource": string,
  "intermediateObjectsCleanedUp": string,
  "intermediateObjectsFailedCleanedUp": string
}
フィールド
objectsFoundFromSource

string (int64 format)

転送がスケジュールされているデータソース内のオブジェクト（オブジェクトの条件に基づいてフィルタリングされたオブジェクトや、同期によってスキップされたオブジェクトは除く）。
bytesFoundFromSource

string (int64 format)

転送がスケジュールされているデータソース内のバイト数（オブジェクトの条件に基づいてフィルタリングされたバイト数や、同期によってスキップされたバイト数は除く）。
objectsFoundOnlyFromSink

string (int64 format)

データシンク内にのみ存在し、削除がスケジュールされているオブジェクト。
bytesFoundOnlyFromSink

string (int64 format)

データシンク内にあるのみで、削除がスケジュールされているバイト数。
objectsFromSourceSkippedBySync

string (int64 format)

データシンクにすでに存在しているため、転送されないデータソース内のオブジェクト。
bytesFromSourceSkippedBySync

string (int64 format)

データソースのバイトのうち、データシンクにすでに存在しているため転送されないもの。
objectsCopiedToSink

string (int64 format)

データシンクにコピーされるオブジェクト。
bytesCopiedToSink

string (int64 format)

データシンクにコピーされるバイト数。
objectsDeletedFromSource

string (int64 format)

データソースから削除されたオブジェクト。
bytesDeletedFromSource

string (int64 format)

データソースから削除されたバイト数。
objectsDeletedFromSink

string (int64 format)

データシンクから削除されるオブジェクト。
bytesDeletedFromSink

string (int64 format)

データシンクから削除されたバイト数。
objectsFromSourceFailed

string (int64 format)

転送に失敗した、または転送後に削除できなかったデータソース内のオブジェクト。
bytesFromSourceFailed

string (int64 format)

転送できなかった、または転送後に削除できなかったデータソースのバイト数。
objectsFailedToDeleteFromSink

string (int64 format)

データシンクから削除できなかったオブジェクト。
bytesFailedToDeleteFromSink

string (int64 format)

データシンクから削除できなかったバイト数。
directoriesFoundFromSource

string (int64 format)

PosixFilesystem を含む転送にのみ使用します。

リスト取得中に見つかったディレクトリの数。たとえば、転送のルート ディレクトリが base/ で、このディレクトリの下に a/ と b/ の 2 つのディレクトリがある場合、base/、base/a/、base/b/ を一覧表示した後のカウントは 3 になります。
directoriesFailedToListFromSource

string (int64 format)

PosixFilesystem を含む転送にのみ使用します。

ソースで検出された各ディレクトリのリスト失敗数。ディレクトリのリスト時に発生する可能性のある障害には、権限エラーやブロックエラーなどがあります。ディレクトリの一覧表示が失敗した場合、ディレクトリ内のファイルは転送されません。
directoriesSuccessfullyListedFromSource

string (int64 format)

PosixFilesystem を含む転送にのみ使用します。

ソースで検出された各ディレクトリの正常なリスティング数。
intermediateObjectsCleanedUp

string (int64 format)

正常にクリーンアップされた中間オブジェクトの数。
intermediateObjectsFailedCleanedUp

string (int64 format)

クリーンアップに失敗した中間オブジェクトの数。

ErrorSummary

エラーコード、数、サンプルエラーのログエントリによるエラーの概要。

JSON 表現 
{
  "errorCode": enum (Code),
  "errorCount": string,
  "errorLogEntries": [
    {
      object (ErrorLogEntry)
    }
  ]
}
フィールド
errorCode

enum (Code)

必須。
errorCount

string (int64 format)

必須。このタイプのエラーの数。
errorLogEntries[]

object (ErrorLogEntry)

エラーサンプル。

1 回の転送オペレーションで、特定のエラーコードに対して最大 5 つのエラーログ エントリが記録されます。

コード

Google API の正規エラーコード。

列挙型
OK

エラーではありません。成功したときに返されます。

HTTP マッピング: 200 OK
CANCELLED

オペレーションがキャンセルされました。通常、キャンセルは呼び出し元により行われます。

HTTP マッピング: 499 クライアントのクローズ リクエスト
UNKNOWN

不明なエラーです。たとえば、別のアドレス空間から受信した Status 値がこのアドレス空間で不明なエラー空間に属している場合に、このエラーが返される可能性があります。また、十分なエラー情報を返さない API によって発生したエラーは、このエラーに変換できます。

HTTP マッピング: 500 内部サーバーエラー
INVALID_ARGUMENT

クライアントが無効な引数を指定しました。これは FAILED_PRECONDITION とは異なることに注意してください。INVALID_ARGUMENT は、システムの状態を問わず問題（ファイル名の形式が不適切であるなど）があった引数を示します。

HTTP マッピング: 400 不正なリクエスト
DEADLINE_EXCEEDED

オペレーションが完了する前に期限が切れました。システムの状態を変更するオペレーションの場合、オペレーションが正常に終了しても、このエラーが返されることがあります。たとえば、サーバーからの正常なレスポンスが期限切れになるほど遅延する場合もあります。

HTTP マッピング: 504 ゲートウェイ タイムアウト
NOT_FOUND

一部のリクエストされたエンティティ（ファイルやディレクトリなど）が見つかりませんでした。

サーバー デベロッパーへの注: 段階的な機能のロールアウトや文書化されていない許可リストなど、ユーザークラス全体に対してリクエストが拒否された場合は、NOT_FOUND を使用できます。ユーザー単位のアクセス制御など、あるユーザークラス内の一部のユーザーに対してリクエストが拒否された場合は、PERMISSION_DENIED を使用する必要があります。

HTTP マッピング: 404 見つかりません
ALREADY_EXISTS

クライアントが作成しようとしたエンティティ（ファイルまたはディレクトリなど）はすでに存在しています。

HTTP マッピング: 409 競合
PERMISSION_DENIED

呼び出し元には、指定されたオペレーションを実行する権限がありません。PERMISSION_DENIED は一部のリソースが枯渇し拒否されたため使用できません（このようなエラーには代わりに RESOURCE_EXHAUSTED を使用します）。呼び出し元が特定できない場合は、PERMISSION_DENIED を使用しないでください（このようなエラーには代わりに UNAUTHENTICATED を使用します）。このエラーコードは、リクエストが有効であること、リクエストされたエンティティが存在すること、および他の事前条件が満たされていることを意味するものではありません。

HTTP マッピング: 403 禁止です
UNAUTHENTICATED

リクエストにはオペレーションに有効な認証情報がありません。

HTTP マッピング: 401 権限なし
RESOURCE_EXHAUSTED

ユーザーごとの割り当て、またはファイル システム全体で容量が不足しているため、一部のリソースが枯渇しています。

HTTP マッピング: 429 リクエストが多すぎます
FAILED_PRECONDITION

システムがオペレーションの実行に必要な状態ではないため、オペレーションが拒否されました。たとえば、削除されるディレクトリが空でない、rmdir オペレーションがディレクトリ以外に適用されているなどの状態です。

サービスの実装者は、次のガイドラインを使用して、FAILED_PRECONDITION、ABORTED、UNAVAILABLE のいずれかに決定できます。（a）クライアントが失敗した呼び出しのみを再試行できる場合は、UNAVAILABLE を使用します。（b）クライアントがより高いレベルで再試行する必要がある場合は、ABORTED を使用します。たとえば、クライアント指定のテストと設定が失敗し、クライアントが読み取り、変更、書き込みのシーケンスをやり直す必要がある場合です。（c）システムの状態が明示的に修正されるまでクライアントが再試行すべきでない場合は、FAILED_PRECONDITION を使用します。たとえば、ディレクトリが空でないため「rmdir」が失敗した場合は、ディレクトリからファイルが削除されない限りクライアントは再試行すべきではないため、FAILED_PRECONDITION を返します。

HTTP マッピング: 400 不正なリクエスト
ABORTED

オペレーションは、通常、シーケンサー チェックの失敗、またはトランザクションの中止などの同時実行の問題のために中止されています。

FAILED_PRECONDITION、ABORTED、UNAVAILABLE の決定については、上記のガイドラインをご覧ください。

HTTP マッピング: 409 競合
OUT_OF_RANGE

オペレーションが有効な範囲を超えて試行されました。たとえば、ファイルの終わりを超えたシークまたは読み取りなどが該当します。

INVALID_ARGUMENT とは異なり、このエラーは、システムの状態が変化すれば修正できる可能性のある問題を示しています。たとえば、32 ビット ファイルシステムは [0,2^32-1] の範囲にないオフセットでの読み取りを要求されると、INVALID_ARGUMENT を生成しますが、現在のファイルサイズを超えるオフセットからの読み取りを要求されると、OUT_OF_RANGE を生成します。

FAILED_PRECONDITION と OUT_OF_RANGE は重複しています。空間を経由して反復している呼び出し元が、完了時に OUT_OF_RANGE エラーを簡単に探せるようにするために、可能な限り OUT_OF_RANGE（より具体的なエラー）の使用をおすすめします。

HTTP マッピング: 400 不正なリクエスト
UNIMPLEMENTED

オペレーションが実装されていないか、このサービスでサポートまたは有効にされていません。

HTTP マッピング: 501 実装されていません
INTERNAL

内部エラー。これは、基盤となるシステムで予期される一部の不変条件が満たされていないことを意味します。このエラーコードは深刻なエラーのために予約されています。

HTTP マッピング: 500 内部サーバーエラー
UNAVAILABLE

サービスは現在使用できません。これは、バックオフで再試行することで解決できる可能性が高い一時的な状態です。非べき等オペレーションの再試行が常に安全であるとは限りません。

FAILED_PRECONDITION、ABORTED、UNAVAILABLE の決定については、上記のガイドラインをご覧ください。

HTTP マッピング: 503 サービスを利用できません
DATA_LOSS

回復不能なデータの消失や破損。

「HTTP Mapping: 500 Internal Server Error」（HTTP マッピング: 500 内部サーバーエラー）

ErrorLogEntry

発生したエラーを説明するエントリ。

JSON 表現 
{
  "url": string,
  "errorDetails": [
    string
  ]
}
フィールド
url

string

必須。エラーが関連付けられているターゲット（データソース、データシンク、オブジェクト）を参照する URL。
errorDetails[]

string

エラーの詳細を保持するメッセージのリスト。

メソッド

cancel

 転送をキャンセルします。

get

 長時間実行オペレーションの最新状態を取得します。

list

 転送オペレーションを一覧表示します。

pause

 転送操作を一時停止します。

resume

 一時停止されていた転送操作を再開します。