• Home
• com.arm.mbed.cloud.sdk
• mbed-cloud-sdk
• 2.2.1
• source code
• CloudRequest.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.arm.mbed.cloud.sdk.common.CloudRequest Maven / Gradle / Ivy

package com.arm.mbed.cloud.sdk.common;

import com.arm.mbed.cloud.sdk.annotations.Preamble;
import com.arm.mbed.cloud.sdk.common.listing.ListOptions;
import com.arm.mbed.cloud.sdk.common.listing.ListResponse;

import retrofit2.Call;

/**
 * Request definition.
 *
 * @param 
 *            type of response object.
 * @param 
 *            service defining the API.
 */
@Preamble(description = "Generic cloud request definition")
public interface CloudRequest {
    /**
     * Defines how to create a request to Pelion Cloud based on parameters;
     *
     * @param service
     *            service defining the API.
     * @param parameters
     *            request parameters
     * @return request definition
     * @throws MbedCloudException
     *             if the parameters are invalid.
     */
    CloudCall defineCall(S service, Object... parameters) throws MbedCloudException;

    /**
     * Request definition for list endpoints/APIs.
     *
     * @param 
     *            type of the model being listed.
     * @param 
     *            service defining the API.
     * @param 
     *            list options.
     */
    interface CloudListRequest {
        /**
         * Defines how to create a request to Pelion Cloud based on parameters;
         *
         * @param service
         *            service defining the API.
         * @param options
         *            list options
         * @param extraParameters
         *            request parameters
         * @return request definition
         * @throws MbedCloudException
         *             if the parameters are invalid.
         */
        CloudCall> defineCall(S service, O options,
                                              Object... extraParameters) throws MbedCloudException;
    }

    /**
     * Defines a call to Pelion Cloud.
     *
     * @param 
     *            type of response object.
     */
    @Preamble(description = "Definition of a call to Pelion Cloud")
    interface CloudCall {
        /**
         * Defines a low level call.
         *
         * @return low level call definition.
         */
        Call call();
    }
}