Operation
содержит статус асинхронного вызова API. Этот метод перечисляет операции, соответствующие указанному OperationType
и/или OperationState
.
Сигнатура метода
public ListOperationsResponse listOperations(ListOperationsRequest request) throws CommonException;
Запрос списка операций
Имя свойства | Ценить | Необходимый | Описание |
---|
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 | Нет | Дополнительные поля, пара ключ-значение, указанная поставщиком. |
ListOperationsResponse
Имя свойства | Ценить | Описание |
---|
operations | Список object( Operation ) | Список операций, соответствующих запросу. |
totalCount | int | Общее количество устройств, соответствующих запросу. |
nextPageToken | strong | Токен следующей страницы. Пусто на последней странице. |
vendorParams | map | Дополнительные поля, пара ключ-значение, указанная поставщиком. |
Поведение при ошибке
В случае возникновения ошибки библиотека выдает CommonException
, содержащий один из следующих кодов ошибки:
Код ошибки |
---|
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
NOT_IMPLEMENTED |
,
Operation
содержит статус асинхронного вызова API. Этот метод перечисляет операции, соответствующие указанному OperationType
и/или OperationState
.
Сигнатура метода
public ListOperationsResponse listOperations(ListOperationsRequest request) throws CommonException;
Запрос списка операций
Имя свойства | Ценить | Необходимый | Описание |
---|
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 | Нет | Дополнительные поля, пара ключ-значение, указанная поставщиком. |
ListOperationsResponse
Имя свойства | Ценить | Описание |
---|
operations | Список object( Operation ) | Список операций, соответствующих запросу. |
totalCount | int | Общее количество устройств, соответствующих запросу. |
nextPageToken | strong | Токен следующей страницы. Пусто на последней странице. |
vendorParams | map | Дополнительные поля, пара ключ-значение, указанная поставщиком. |
Поведение при ошибке
В случае возникновения ошибки библиотека выдает CommonException
, содержащий один из следующих кодов ошибки:
Код ошибки |
---|
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
NOT_IMPLEMENTED |