لیست عملیات

یک 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 خیر فیلدهای اضافی، جفت کلید-مقدار مشخص شده توسط فروشنده.

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;

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 خیر فیلدهای اضافی، جفت کلید-مقدار مشخص شده توسط فروشنده.

ListOperationsResponse

نام ملک ارزش شرح
operations لیست object( Operation ) لیست عملیات مطابق با درخواست
totalCount int تعداد کل دستگاه های مطابق با درخواست.
nextPageToken strong توکن صفحه بعد. برای صفحه آخر خالی است.
vendorParams map فیلدهای اضافی، جفت کلید-مقدار مشخص شده توسط فروشنده.

رفتار خطا

اگر خطایی رخ دهد، کتابخانه یک CommonException حاوی یکی از کدهای خطای زیر می‌فرستد:

کد خطا
INTERNAL_SERVER_ERROR
INVALID_PAGE_TOKEN
NOT_IMPLEMENTED