foundation.greensoftware.carbonaware.webapi.client

Class LocationsApi

java.lang.Object

foundation.greensoftware.carbonaware.webapi.client.LocationsApi

public class LocationsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
LocationsApi()
LocationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Map<String,Location>	getAllLocations() Get all locations instances
okhttp3.Call	getAllLocationsAsync(ApiCallback<Map<String,Location>> _callback) Get all locations instances (asynchronously)
okhttp3.Call	getAllLocationsCall(ApiCallback _callback) Build call for getAllLocations
ApiResponse<Map<String,Location>>	getAllLocationsWithHttpInfo() Get all locations instances
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocationsApi

public LocationsApi()

LocationsApi

public LocationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getAllLocationsCall

public okhttp3.Call getAllLocationsCall(ApiCallback _callback)
                                 throws ApiException

Build call for getAllLocations

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Success	-
204	No Content	-

getAllLocations

public Map<String,Location> getAllLocations()
                                     throws ApiException

Get all locations instances

Returns:

Map<String, Location>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Success	-
204	No Content	-

getAllLocationsWithHttpInfo

public ApiResponse<Map<String,Location>> getAllLocationsWithHttpInfo()
                                                              throws ApiException

Get all locations instances

Returns:

ApiResponse<Map<String, Location>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Success	-
204	No Content	-

getAllLocationsAsync

public okhttp3.Call getAllLocationsAsync(ApiCallback<Map<String,Location>> _callback)
                                  throws ApiException

Get all locations instances (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Success	-
204	No Content	-