com.hp.autonomy.hod.client.api.resource.ResourcesBackend Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-hod-client Show documentation

Java Client for communicating with HP Haven OnDemand

There is a newer version: 0.25.3

/*
 * Copyright 2015-2016 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.hod.client.api.resource;

import com.hp.autonomy.hod.client.api.authentication.AuthenticationToken;
import com.hp.autonomy.hod.client.error.HodErrorException;
import retrofit.client.Response;
import retrofit.http.GET;
import retrofit.http.Header;
import retrofit.http.QueryMap;

import java.util.Map;

/**
 * Interface representing the list resources API.
 */
interface ResourcesBackend {

    String URL = "/2/api/sync/resource/v1";

    /**
     * Query HP Haven OnDemand for the list of resources with the given token
     * @param token The authentication token
     * @param parameters Request parameters (can be built using {@link ListResourcesRequestBuilder}
     * @return Public and private resources
     */
    @GET(URL)
    Response list(@Header("token") AuthenticationToken token, @QueryMap Map parameters) throws HodErrorException;

}