Examples with Nullable com.arm.mbed.cloud.sdk.annotations.Nullable used on opensource projects

Example 21 with Nullable

use of com.arm.mbed.cloud.sdk.annotations.Nullable in project mbed-cloud-sdk-java by ARMmbed.

the class Update method listCampaignDeviceStates.

/**
 * Lists campaign devices states.
 * <p>
 * Example:
 *
 * <pre>
 * {@code
 * try {
 *     String campaignId = "015f4ac587f500000000000100109294";
 *     CampaignDevicesStatesListOptions options = new CampaignDevicesStatesListOptions();
 *     options.setLimit(10);
 *
 *     ListResponse<CampaignDeviceState> states = updateApi.listCampaignDeviceStates(campaignId, options);
 *     for (CampaignDeviceState state : states) {
 *         System.out.println("Device ID: " + state.getId());
 *         System.out.println("Currently in state: " + state.getState());
 *     }
 * } catch (MbedCloudException e) {
 *     e.printStackTrace();
 * }
 * }
 * </pre>
 *
 * @param campaignId
 *            The ID of the update campaign.
 * @param options
 *            filter options.
 * @return The list of campaign device states corresponding to filter options (One page).
 * @throws MbedCloudException
 *             if a problem occurred during request processing.
 */
@API
@Nullable
public ListResponse<CampaignDeviceState> listCampaignDeviceStates(@NonNull String campaignId, @Nullable CampaignDevicesStatesListOptions options) throws MbedCloudException {
    checkNotNull(campaignId, TAG_CAMPAIGN_ID);
    final String finalId = campaignId;
    final CampaignDevicesStatesListOptions finalOptions = (options == null) ? new CampaignDevicesStatesListOptions() : options;
    return CloudCaller.call(this, "listCampaignDeviceStates()", CampaignDeviceStateAdapter.getListMapper(), new CloudCall<CampaignDeviceMetadataPage>() {

        @Override
        public Call<CampaignDeviceMetadataPage> call() {
            return endpoint.getUpdate().updateCampaignMetadataList(finalId, finalOptions.getLimit(), finalOptions.getOrder().toString(), finalOptions.getAfter(), finalOptions.encodeInclude());
        }
    });
}

Example 22 with Nullable

use of com.arm.mbed.cloud.sdk.annotations.Nullable in project mbed-cloud-sdk-java by ARMmbed.

the class Connect method listObservableResources.

/**
 * Lists device's observable resources.
 *
 * @see Resource#isObservable()
 *      <p>
 *      Example:
 *
 *      <pre>
 * {@code
 * try {
 *     Device device = new Device();
 *     device.setId("015f4ac587f500000000000100100249");
 *
 *     List<Resource> resources = connectApi.listObservableResources(device);
 *     for (Resource resource : resources) {
 *         System.out.println("Resource path: " + resource.getPath());
 *     }
 * } catch (MbedCloudException e) {
 *     e.printStackTrace();
 * }
 * }
 *      </pre>
 *
 * @param device
 *            Device.
 * @return list of observable resources present on a device.
 * @throws MbedCloudException
 *             if a problem occurred during request processing.
 */
@API
@Nullable
public List<Resource> listObservableResources(@NonNull Device device) throws MbedCloudException {
    final List<Resource> resources = listResources(device);
    if (resources == null || resources.isEmpty()) {
        return null;
    }
    final List<Resource> observableResources = new LinkedList<>();
    for (final Resource resource : resources) {
        if (resource.isObservable()) {
            observableResources.add(resource);
        }
    }
    return observableResources.isEmpty() ? null : observableResources;
}

Example 23 with Nullable

use of com.arm.mbed.cloud.sdk.annotations.Nullable in project mbed-cloud-sdk-java by ARMmbed.

the class Enrollment method addEnrollmentClaim.

/**
 * Places an enrolment claim for one or several devices.
 * <p>
 * Example:
 *
 * <pre>
 * {@code
 * try {
 *     String claimId = "A-35:e7:72:8a:07:50:3b:3d:75:96:57:52:72:41:0d:78:cc:c6:e5:53:48:c6:65:58:5b:fa:af:4d:2d:73:95:c5";
 *     EnrollmentClaim claim = enrollmentApi.addEnrollmentClaim(claimId)
 *     System.out.println(claim);
 *
 * } catch (MbedCloudException e) {
 *     e.printStackTrace();
 * }
 * }
 * </pre>
 *
 * @param claimId
 *            Claim Id. Pattern: '^[A-Z]{1}-[A-Za-z0-9:]{1, 256}' e.g.
 *            A-35:e7:72:8a:07:50:3b:3d:75:96:57:52:72:41:0d:78:cc:c6:e5:53:48:c6:65:58:5b:fa:af:4d:2d:73:95:c5
 * @return enrollment claim.
 * @throws MbedCloudException
 *             if a problem occurred during request processing.
 */
@API
@Nullable
public EnrollmentClaim addEnrollmentClaim(@NonNull String claimId) throws MbedCloudException {
    checkNotNull(claimId, TAG_ENROLLMENT_ID);
    final EnrollmentId finalEnrollmentId = new EnrollmentId().enrollmentIdentity(claimId);
    return CloudCaller.call(this, "addEnrollmentClaim()", EnrollmentAdapter.getMapper(), new CloudCall<EnrollmentIdentity>() {

        @Override
        public Call<EnrollmentIdentity> call() {
            return endpoint.getEnrollment().createDeviceEnrollment(finalEnrollmentId);
        }
    });
}