listOperations

Operation には、非同期 API 呼び出しのステータスが含まれます。このメソッドは、指定した OperationTypeOperationState に一致するオペレーションを一覧表示します。

メソッド シグネチャ

public ListOperationsResponse listOperations(ListOperationsRequest request) throws CommonException;

ListOperationsRequest

プロパティ名 必須 説明
operationType enum(OperationType) × オペレーション タイプ: CLAIM_DEVICESUNCLAIM_DEVICESUPDATE_CLAIMS
state enum(OperationState) × オペレーションの状態: IN_PROGRESSCOMPLETECOMPLETE_WITH_ERRORS
pageSize int × ページサイズ(最大 100)。100 または null より大きい場合、100 が使用されます。
pageToken string × ページトークン。空白の場合は、最初のページが返されます。
vendorParams map × 追加フィールド、ベンダー指定の Key-Value ペア。

ListOperationsResponse

プロパティ名 説明
operations object(Operation) のリスト リクエストに一致するオペレーションのリスト。
totalCount int リクエストに一致するデバイスの合計数。
nextPageToken strong 次のページトークン。最後のページは空です。
vendorParams map 追加フィールド、ベンダー指定の Key-Value ペア。

エラーの動作

エラーが発生すると、ライブラリは次のいずれかのエラーコードを含む CommonException をスローします。

エラーコード
INTERNAL_SERVER_ERROR
INVALID_PAGE_TOKEN
NOT_IMPLEMENTED