SL-API issue pagination of virtual machines with masks #52

Activity

1. acamacho82 commented on May 17, 2018

   

   acamacho82

   on May 17, 2018

   Last edited by acamacho82

   Contributor

   More actions

   Yeah I got the same behavior, there is no way to set resultLimits and masks in order to be used in the same method.

   Result limit is being ignored with the following code:

   service.setResultLimit(new ResultLimit(offset, limit));
   service.withMask().virtualGuests().powerState().name();
   List<Guest> listGuests = service.getObject().getVirtualGuests();

   And on this case, when removing getObject(), the object-mask doesn't work.

   service.setResultLimit(new ResultLimit(offset, limit));
   service.withMask().virtualGuests().powerState().name();
   List<Guest> listGuests = service.getVirtualGuests();

   It seems that it could be fixed here #19

   @isrfig the workaround you are using isn't the best on this case but I think it is still correct. In other cases this approach is the best solution because some relational properties have a lot of data and/or the mask is to long in depth (for example, to retrieve detailed information of items of all invoices in the account)
2. allmightyspiff commented on May 17, 2018

   

   allmightyspiff

   on May 17, 2018

   Member

   More actions

   This may just be a bug with the java-client, I think the SLAPI itself supports resultLimits and objectMasks.

   I'll mark this as a bug for future development. I don't have an ETA, so your work around might be best.

   Just keep in mind there is a rate limit imposed by the API, so you may have to watch out for a rate limit exception and be prepared to sleep for a second before continuing.
3. allmightyspiff

   added

   bug

   help wanted

   on May 17, 2018
4. allmightyspiff commented on Jun 14, 2018

   

   allmightyspiff

   on Jun 14, 2018

   Last edited by allmightyspiff

   Member

   More actions

   @isrfig instead of using withMask() you can set the object mask manually with setMask(string) which can be used to work around this bug until we figure out a more clever solution.

   ApiClient client = new RestApiClient().withCredentials(user, apiKey);
   ((RestApiClient) client).setLoggingEnabled(true);
   Account.Service accountService = Account.service(client);
   accountService.setResultLimit(new ResultLimit(10));
   
   accountService.setMask("mask[id, hostname, powerState[name]]");
       for (Guest bd : accountService.getVirtualGuests()) {
       System.out.println("BD: " + bd.getId() + " - " + bd.getHostname());
   }
5. allmightyspiff

   added a commit that references this issue on Jun 18, 2018

   #52 some unit tests around objectMasks, groundwork for withMask() imp…

   ...

   bb92e07
6. camporter commented on Jun 20, 2018

   

   camporter

   on Jun 20, 2018

   Member

   More actions

   The result limit is not being ignored in the initial case. The result limit applies to the base object being queried. In the case of a getObject request, it won't do anything, as the virtual guests are masked off the account which is result limited, not the virtual guests.

   The string-based mask is an available workaround for now.