Operation には、非同期 API 呼び出しのステータスが含まれます。このメソッドは、指定された OperationType または OperationState に一致するオペレーションを一覧表示します。
メソッド シグネチャ
public ListOperationsResponse listOperations(ListOperationsRequest request) throws CommonException;
ListOperationsRequest
| プロパティ名 |
値 |
必須 |
説明 |
operationType |
enum(OperationType) |
いいえ |
オペレーション タイプ: CLAIM_DEVICES、UNCLAIM_DEVICES、UPDATE_CLAIMS。 |
state |
enum(OperationState) |
いいえ |
オペレーションのステータス: IN_PROGRESS、COMPLETE、COMPLETE_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 |
