この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

BackgroundOperation

非同期ジョブキューのバックグラウンド操作を表します。このオブジェクトは、API バージョン 35.0 以降で使用できます。

サポートされているコール

describeSObjects()getDeleted()getUpdated()query()retrieve()

項目

項目名 詳細
Error
string
プロパティ
Filter、Group、Nillable、Sort
説明
操作に対するエラーメッセージ。操作に Error の状況がある場合のみ適用されます。
ExecutionGroup
string
プロパティ
Filter、Group、Nillable、Sort
説明
操作が他の操作とマージされ、一括処理される実行グループになっている場合のみ適用されます。実行グループを識別します。
ExpiresAt
dateTime
プロパティ
Filter、Nillable、Sort
説明
この時点以降、操作は非同期ジョブキューから削除されます。操作に Complete、Canceled、Error、Merged の状況がある場合のみ適用されます。
FinishedAt
dateTime
プロパティ
Filter、Nillable、Sort
説明
操作が Completed または Error の状況になった時点。
GroupLeaderId
reference
プロパティ
Filter、Group、Nillable、Sort
説明
操作が他の操作とマージされ、一括処理される実行グループになっている場合のみ適用されます。実行グループのリーダーとして選択された操作を識別します。
Name
string
プロパティ
Filter、Group、idLookup、Sort
説明
バックグラウンド操作を識別します。
NumFollowers
int
プロパティ
Filter、Group、Nillable、Sort
説明
操作が他の操作とマージされ、一括処理される実行グループになっている場合のみ適用されます。実行グループ内の他の操作の数。
ParentKey
string
プロパティ
Filter、Group、idLookup、Nillable、Sort
説明
関連する操作セットを識別するタグ (存在する場合)。
ProcessAfter
dateTime
プロパティ
Filter、Nillable、Sort
説明
操作は、この時点以降に処理するようにスケジュールされています。
RetryBackoff
int
プロパティ
Filter、Group、Nillable、Sort
説明
操作に Error の状況がある場合のみ適用されます。最初の再試行は直後に実行されます。後続の再試行は、指数式に RetryBackoff を掛けた時間 (ミリ秒単位) に従って徐々に遅延時間が長くなります。

具体的には、遅延時間は (2n-1)×R です。ここで、nRetryCountRRetryBackoff です。

RetryBackoff のデフォルト値は操作の種類によって異なります。たとえば、外部オブジェクトへの書き込み操作に対する RetryBackoff のデフォルトは 1,000 ミリ秒です。書き込み操作の場合、再試行は直後、3 秒後、7 秒後、15 秒後というようになります。

RetryCount
int
プロパティ
Filter、Group、Nillable、Sort
説明

実行した試行回数。操作に Error の状況がある場合のみ適用されます。

RetryLimit
int
プロパティ
Filter、Group、Nillable、Sort
説���

試行の最大回数。操作に Error の状況がある場合のみ適用されます。

SequenceGroup
string
プロパティ
Filter、Group、Nillable、Sort
説明
順序グループを識別します。操作が他の操作とマージされ、一括処理される実行グループになっている場合のみ適用されます。実行グループで操作が順序グループにマージされ、特定の順序で実行されます。
SequenceNumber
int
プロパティ
Filter、Group、Nillable、Sort
説明
順序グループ内の順序位置。操作が他の操作とマージされ、一括処理される実行グループになっている場合のみ適用されます。実行グループで操作が順序グループにマージされ、特定の順序で実行されます。
StartedAt
dateTime
プロパティ
Filter、Nillable、Sort
説明

操作が実行開始された時点。

Status
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
バックグラウンド操作の状況。選択肢は次のとおりです。
  • New
  • スケジュール済み
  • Canceled
  • Merged
  • Waiting
  • Running
  • Error
  • Complete
SubmittedAt
dateTime
プロパティ
Filter、Nillable、Sort
説明
操作がジョブキューに追加された時点。
Timeout
int
プロパティ
Filter、Group、Nillable、Sort
説明
操作の実行開始後に結果を待機する最大時間 (ミリ秒単位)。
WorkerUri
string
プロパティ
Filter、Group、idLookup、Nillable、Sort
説明
操作を実行した作業者の URI。
たとえば、Salesforce Connect OData 操作の場合、次のようになります。
1services/data/v35.0/xds/upsert

使用方法

BackgroundOperation オブジェクトを使用すると、次のことができます。
  • 非同期操作のジョブの状況を監視する。
  • 非同期操作に関連するエラーを参照する。
  • 非同期ジョブキューの統計情報を抽出する。