findDevicesByIdentifier
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista dispositivos com um determinado identificador.
Assinatura do método
public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request) throws CommonException;
FindDevicesByDeviceIdentifierRequest
Nome da propriedade |
Valor |
Obrigatório |
Descrição |
deviceIdentifier |
object( DeviceIdentifier ) |
Sim |
Identificador dos dispositivos a serem recuperados. O objeto pode ser parcialmente preenchido. |
pageSize |
int |
Não |
O tamanho da página, até 100 . Se for maior que 100 ou null , 100 será usado. |
pageToken |
string |
Não |
O token da página. Se estiver vazio, a primeira página será retornada. |
vendorParams |
map |
Não |
Campos extras, par de chave-valor especificado pelo fornecedor. |
FindDevicesResponse
Nome da propriedade |
Valor |
Descrição |
devices |
object( Device ) |
A lista de dispositivos enviados pelo revendedor. Vai ser vazio se não houver correspondência. |
totalCount |
int |
Contagem total de dispositivos que correspondem à solicitação. |
nextPageToken |
strong |
O token da próxima página. Vazio para a última página. |
vendorParams |
map |
Opcional. Campos extras, par de chave-valor especificado pelo fornecedor. |
Comportamento de erro
Se ocorrer um erro, a biblioteca vai gerar um CommonException
contendo um dos
seguintes códigos de erro:
Código do erro |
INTERNAL_SERVER_ERROR |
INVALID_PAGE_TOKEN |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-29 UTC.
[null,null,["Última atualização 2025-08-29 UTC."],[[["\u003cp\u003eThis method retrieves a list of devices based on a provided device identifier.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003edeviceIdentifier\u003c/code\u003e object, which can be partially filled, to specify the devices to be retrieved.\u003c/p\u003e\n"],["\u003cp\u003eOptional parameters include \u003ccode\u003epageSize\u003c/code\u003e (up to 100), \u003ccode\u003epageToken\u003c/code\u003e for pagination, and \u003ccode\u003evendorParams\u003c/code\u003e for extra data.\u003c/p\u003e\n"],["\u003cp\u003eThe response contains a list of \u003ccode\u003edevices\u003c/code\u003e, the \u003ccode\u003etotalCount\u003c/code\u003e of matching devices, an optional \u003ccode\u003enextPageToken\u003c/code\u003e for additional pages, and \u003ccode\u003evendorParams\u003c/code\u003e for extra information.\u003c/p\u003e\n"],["\u003cp\u003ePotential errors during the process will result in a \u003ccode\u003eCommonException\u003c/code\u003e being thrown, with possible error codes being \u003ccode\u003eINTERNAL_SERVER_ERROR\u003c/code\u003e or \u003ccode\u003eINVALID_PAGE_TOKEN\u003c/code\u003e.\u003c/p\u003e\n"]]],["The `findDevicesByDeviceIdentifier` method retrieves a list of devices based on a provided device identifier. The request requires a `deviceIdentifier`, and optionally accepts `pageSize` (up to 100), `pageToken`, and `vendorParams`. The response includes a list of `devices`, `totalCount`, `nextPageToken`, and optional `vendorParams`. Errors result in a `CommonException`, with codes like `INTERNAL_SERVER_ERROR` or `INVALID_PAGE_TOKEN`.\n"],null,["# findDevicesByIdentifier\n\nLists devices with given device identifier.\n\nMethod signature\n----------------\n\n public FindDevicesResponse findDevicesByDeviceIdentifier(FindDevicesByDeviceIdentifierRequest request) throws CommonException;\n\nFindDevicesByDeviceIdentifierRequest\n------------------------------------\n\n| Property name | Value | Required | Description |\n|--------------------|---------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------|\n| `deviceIdentifier` | `object(`[`DeviceIdentifier`](/zero-touch/reseller-library/reference/objects#deviceidentifier)`)` | Yes | Device identifier of the devices to be retrieve. The object can be partially populated. |\n| `pageSize` | `int` | No | The page size, up to `100`. If greater than `100` or `null`, `100` is used. |\n| `pageToken` | `string` | No | The page token. If empty, the first page is returned. |\n| `vendorParams` | `map` | No | Extra fields, vendor specified key-value pair. |\n\nFindDevicesResponse\n-------------------\n\n| Property name | Value | Description |\n|-----------------|-------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| `devices` | `object(`[`Device`](/zero-touch/reseller-library/reference/objects#device)`)` | The list of devices uploaded by the reseller. Empty if there is no match. |\n| `totalCount` | `int` | The total count of devices matching the request. |\n| `nextPageToken` | `strong` | The next page token. Empty for the last page. |\n| `vendorParams` | `map` | Optional. Extra fields, vendor specified key-value pair. |\n\nError behavior\n--------------\n\nIf an error occurs, the library throws a `CommonException` containing one of the\nfollowing error codes:\n\n| Error code |\n|-------------------------|\n| `INTERNAL_SERVER_ERROR` |\n| `INVALID_PAGE_TOKEN` |"]]