foundation.greensoftware.carbonaware.webapi.client

Class CarbonAwareApi

java.lang.Object

foundation.greensoftware.carbonaware.webapi.client.CarbonAwareApi

public class CarbonAwareApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CarbonAwareApi()
CarbonAwareApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<EmissionsForecastDTO>	batchForecastDataAsync(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO) Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes [start...end] if provided.
okhttp3.Call	batchForecastDataAsyncAsync(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO, ApiCallback<List<EmissionsForecastDTO>> _callback) Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes [start...end] if provided.
okhttp3.Call	batchForecastDataAsyncCall(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO, ApiCallback _callback) Build call for batchForecastDataAsync
ApiResponse<List<EmissionsForecastDTO>>	batchForecastDataAsyncWithHttpInfo(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO) Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes [start...end] if provided.
ApiClient	getApiClient()
CarbonIntensityDTO	getAverageCarbonIntensity(String location, OffsetDateTime startTime, OffsetDateTime endTime) Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period.
okhttp3.Call	getAverageCarbonIntensityAsync(String location, OffsetDateTime startTime, OffsetDateTime endTime, ApiCallback<CarbonIntensityDTO> _callback) Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period.
List<CarbonIntensityDTO>	getAverageCarbonIntensityBatch(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO) Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects.
okhttp3.Call	getAverageCarbonIntensityBatchAsync(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO, ApiCallback<List<CarbonIntensityDTO>> _callback) Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects.
okhttp3.Call	getAverageCarbonIntensityBatchCall(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO, ApiCallback _callback) Build call for getAverageCarbonIntensityBatch
ApiResponse<List<CarbonIntensityDTO>>	getAverageCarbonIntensityBatchWithHttpInfo(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO) Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects.
okhttp3.Call	getAverageCarbonIntensityCall(String location, OffsetDateTime startTime, OffsetDateTime endTime, ApiCallback _callback) Build call for getAverageCarbonIntensity
ApiResponse<CarbonIntensityDTO>	getAverageCarbonIntensityWithHttpInfo(String location, OffsetDateTime startTime, OffsetDateTime endTime) Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period.
List<EmissionsData>	getBestEmissionsDataForLocationsByTime(List<String> location, OffsetDateTime time, OffsetDateTime toTime) Calculate the best emission data by list of locations for a specified time period.
okhttp3.Call	getBestEmissionsDataForLocationsByTimeAsync(List<String> location, OffsetDateTime time, OffsetDateTime toTime, ApiCallback<List<EmissionsData>> _callback) Calculate the best emission data by list of locations for a specified time period.
okhttp3.Call	getBestEmissionsDataForLocationsByTimeCall(List<String> location, OffsetDateTime time, OffsetDateTime toTime, ApiCallback _callback) Build call for getBestEmissionsDataForLocationsByTime
ApiResponse<List<EmissionsData>>	getBestEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location, OffsetDateTime time, OffsetDateTime toTime) Calculate the best emission data by list of locations for a specified time period.
List<EmissionsForecastDTO>	getCurrentForecastData(List<String> location, OffsetDateTime dataStartAt, OffsetDateTime dataEndAt, Integer windowSize) Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
okhttp3.Call	getCurrentForecastDataAsync(List<String> location, OffsetDateTime dataStartAt, OffsetDateTime dataEndAt, Integer windowSize, ApiCallback<List<EmissionsForecastDTO>> _callback) Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
okhttp3.Call	getCurrentForecastDataCall(List<String> location, OffsetDateTime dataStartAt, OffsetDateTime dataEndAt, Integer windowSize, ApiCallback _callback) Build call for getCurrentForecastData
ApiResponse<List<EmissionsForecastDTO>>	getCurrentForecastDataWithHttpInfo(List<String> location, OffsetDateTime dataStartAt, OffsetDateTime dataEndAt, Integer windowSize) Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
String	getCustomBaseUrl()
List<EmissionsData>	getEmissionsDataForLocationByTime(String location, OffsetDateTime time, OffsetDateTime toTime) Calculate the best emission data by location for a specified time period.
okhttp3.Call	getEmissionsDataForLocationByTimeAsync(String location, OffsetDateTime time, OffsetDateTime toTime, ApiCallback<List<EmissionsData>> _callback) Calculate the best emission data by location for a specified time period.
okhttp3.Call	getEmissionsDataForLocationByTimeCall(String location, OffsetDateTime time, OffsetDateTime toTime, ApiCallback _callback) Build call for getEmissionsDataForLocationByTime
ApiResponse<List<EmissionsData>>	getEmissionsDataForLocationByTimeWithHttpInfo(String location, OffsetDateTime time, OffsetDateTime toTime) Calculate the best emission data by location for a specified time period.
List<EmissionsData>	getEmissionsDataForLocationsByTime(List<String> location, OffsetDateTime time, OffsetDateTime toTime) Calculate the observed emission data by list of locations for a specified time period.
okhttp3.Call	getEmissionsDataForLocationsByTimeAsync(List<String> location, OffsetDateTime time, OffsetDateTime toTime, ApiCallback<List<EmissionsData>> _callback) Calculate the observed emission data by list of locations for a specified time period.
okhttp3.Call	getEmissionsDataForLocationsByTimeCall(List<String> location, OffsetDateTime time, OffsetDateTime toTime, ApiCallback _callback) Build call for getEmissionsDataForLocationsByTime
ApiResponse<List<EmissionsData>>	getEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location, OffsetDateTime time, OffsetDateTime toTime) Calculate the observed emission data by list of locations for a specified time period.
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

CarbonAwareApi

public CarbonAwareApi()

CarbonAwareApi

public CarbonAwareApi(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)

batchForecastDataAsyncCall

public okhttp3.Call batchForecastDataAsyncCall(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for batchForecastDataAsync

Parameters:

emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)

_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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

batchForecastDataAsync

public List<EmissionsForecastDTO> batchForecastDataAsync(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO)
                                                  throws ApiException

Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes [start...end] if provided. This endpoint takes a batch of requests for historical forecast data, fetches them, and calculates the optimal marginal carbon intensity windows for each using the same parameters available to the '/emissions/forecasts/current' endpoint. This endpoint is useful for back-testing what one might have done in the past, if they had access to the current forecast at the time.

Parameters:

emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)

Returns:

List<EmissionsForecastDTO>

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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

batchForecastDataAsyncWithHttpInfo

public ApiResponse<List<EmissionsForecastDTO>> batchForecastDataAsyncWithHttpInfo(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO)
                                                                           throws ApiException

Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes [start...end] if provided. This endpoint takes a batch of requests for historical forecast data, fetches them, and calculates the optimal marginal carbon intensity windows for each using the same parameters available to the '/emissions/forecasts/current' endpoint. This endpoint is useful for back-testing what one might have done in the past, if they had access to the current forecast at the time.

Parameters:

emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)

Returns:

ApiResponse<List<EmissionsForecastDTO>>

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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

batchForecastDataAsyncAsync

public okhttp3.Call batchForecastDataAsyncAsync(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO,
                                                ApiCallback<List<EmissionsForecastDTO>> _callback)
                                         throws ApiException

Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes [start...end] if provided. (asynchronously) This endpoint takes a batch of requests for historical forecast data, fetches them, and calculates the optimal marginal carbon intensity windows for each using the same parameters available to the '/emissions/forecasts/current' endpoint. This endpoint is useful for back-testing what one might have done in the past, if they had access to the current forecast at the time.

Parameters:

emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)

_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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

getAverageCarbonIntensityCall

public okhttp3.Call getAverageCarbonIntensityCall(String location,
                                                  OffsetDateTime startTime,
                                                  OffsetDateTime endTime,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getAverageCarbonIntensity

Parameters:

location - The location name where workflow is run (required)

startTime - The time at which the workflow we are measuring carbon intensity for started (required)

endTime - The time at which the workflow we are measuring carbon intensity for ended (required)

_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	Returns a single object that contains the information about the request and the average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getAverageCarbonIntensity

public CarbonIntensityDTO getAverageCarbonIntensity(String location,
                                                    OffsetDateTime startTime,
                                                    OffsetDateTime endTime)
                                             throws ApiException

Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period. This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.

Parameters:

location - The location name where workflow is run (required)

startTime - The time at which the workflow we are measuring carbon intensity for started (required)

endTime - The time at which the workflow we are measuring carbon intensity for ended (required)

Returns:

CarbonIntensityDTO

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	Returns a single object that contains the information about the request and the average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getAverageCarbonIntensityWithHttpInfo

public ApiResponse<CarbonIntensityDTO> getAverageCarbonIntensityWithHttpInfo(String location,
                                                                             OffsetDateTime startTime,
                                                                             OffsetDateTime endTime)
                                                                      throws ApiException

Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period. This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.

Parameters:

location - The location name where workflow is run (required)

startTime - The time at which the workflow we are measuring carbon intensity for started (required)

endTime - The time at which the workflow we are measuring carbon intensity for ended (required)

Returns:

ApiResponse<CarbonIntensityDTO>

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	Returns a single object that contains the information about the request and the average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getAverageCarbonIntensityAsync

public okhttp3.Call getAverageCarbonIntensityAsync(String location,
                                                   OffsetDateTime startTime,
                                                   OffsetDateTime endTime,
                                                   ApiCallback<CarbonIntensityDTO> _callback)
                                            throws ApiException

Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period. (asynchronously) This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.

Parameters:

location - The location name where workflow is run (required)

startTime - The time at which the workflow we are measuring carbon intensity for started (required)

endTime - The time at which the workflow we are measuring carbon intensity for ended (required)

_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	Returns a single object that contains the information about the request and the average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getAverageCarbonIntensityBatchCall

public okhttp3.Call getAverageCarbonIntensityBatchCall(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO,
                                                       ApiCallback _callback)
                                                throws ApiException

Build call for getAverageCarbonIntensityBatch

Parameters:

carbonIntensityBatchParametersDTO - Array of inputs where each contains a \"location\", \"startDate\", and \"endDate\" for which to calculate average marginal carbon intensity. (optional)

_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	Returns an array of objects where each contains location, time boundaries and the corresponding average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getAverageCarbonIntensityBatch

public List<CarbonIntensityDTO> getAverageCarbonIntensityBatch(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO)
                                                        throws ApiException

Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects. The application only supports batching across a single location with different time boundaries. If multiple locations are provided, an error is returned. For each item in the request array, the application returns a corresponding object containing the location, time boundaries, and average marginal carbon intensity.

Parameters:

carbonIntensityBatchParametersDTO - Array of inputs where each contains a \"location\", \"startDate\", and \"endDate\" for which to calculate average marginal carbon intensity. (optional)

Returns:

List<CarbonIntensityDTO>

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	Returns an array of objects where each contains location, time boundaries and the corresponding average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getAverageCarbonIntensityBatchWithHttpInfo

public ApiResponse<List<CarbonIntensityDTO>> getAverageCarbonIntensityBatchWithHttpInfo(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO)
                                                                                 throws ApiException

Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects. The application only supports batching across a single location with different time boundaries. If multiple locations are provided, an error is returned. For each item in the request array, the application returns a corresponding object containing the location, time boundaries, and average marginal carbon intensity.

Parameters:

carbonIntensityBatchParametersDTO - Array of inputs where each contains a \"location\", \"startDate\", and \"endDate\" for which to calculate average marginal carbon intensity. (optional)

Returns:

ApiResponse<List<CarbonIntensityDTO>>

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	Returns an array of objects where each contains location, time boundaries and the corresponding average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getAverageCarbonIntensityBatchAsync

public okhttp3.Call getAverageCarbonIntensityBatchAsync(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO,
                                                        ApiCallback<List<CarbonIntensityDTO>> _callback)
                                                 throws ApiException

Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects. (asynchronously) The application only supports batching across a single location with different time boundaries. If multiple locations are provided, an error is returned. For each item in the request array, the application returns a corresponding object containing the location, time boundaries, and average marginal carbon intensity.

Parameters:

carbonIntensityBatchParametersDTO - Array of inputs where each contains a \"location\", \"startDate\", and \"endDate\" for which to calculate average marginal carbon intensity. (optional)

_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	Returns an array of objects where each contains location, time boundaries and the corresponding average marginal carbon intensity	-
400	Returned if any of the requested items are invalid	-
500	Internal server error	-

getBestEmissionsDataForLocationsByTimeCall

public okhttp3.Call getBestEmissionsDataForLocationsByTimeCall(List<String> location,
                                                               OffsetDateTime time,
                                                               OffsetDateTime toTime,
                                                               ApiCallback _callback)
                                                        throws ApiException

Build call for getBestEmissionsDataForLocationsByTime

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

_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	-
400	Bad Request	-

getBestEmissionsDataForLocationsByTime

public List<EmissionsData> getBestEmissionsDataForLocationsByTime(List<String> location,
                                                                  OffsetDateTime time,
                                                                  OffsetDateTime toTime)
                                                           throws ApiException

Calculate the best emission data by list of locations for a specified time period.

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

Returns:

List<EmissionsData>

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	-
400	Bad Request	-

getBestEmissionsDataForLocationsByTimeWithHttpInfo

public ApiResponse<List<EmissionsData>> getBestEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
                                                                                           OffsetDateTime time,
                                                                                           OffsetDateTime toTime)
                                                                                    throws ApiException

Calculate the best emission data by list of locations for a specified time period.

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

Returns:

ApiResponse<List<EmissionsData>>

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	-
400	Bad Request	-

getBestEmissionsDataForLocationsByTimeAsync

public okhttp3.Call getBestEmissionsDataForLocationsByTimeAsync(List<String> location,
                                                                OffsetDateTime time,
                                                                OffsetDateTime toTime,
                                                                ApiCallback<List<EmissionsData>> _callback)
                                                         throws ApiException

Calculate the best emission data by list of locations for a specified time period. (asynchronously)

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

_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	-
400	Bad Request	-

getCurrentForecastDataCall

public okhttp3.Call getCurrentForecastDataCall(List<String> location,
                                               OffsetDateTime dataStartAt,
                                               OffsetDateTime dataEndAt,
                                               Integer windowSize,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for getCurrentForecastData

Parameters:

location - String array of named locations (required)

dataStartAt - Start time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data. (optional)

dataEndAt - End time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data. (optional)

windowSize - The estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point. (optional)

_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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

getCurrentForecastData

public List<EmissionsForecastDTO> getCurrentForecastData(List<String> location,
                                                         OffsetDateTime dataStartAt,
                                                         OffsetDateTime dataEndAt,
                                                         Integer windowSize)
                                                  throws ApiException

Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window. This endpoint fetches only the most recently generated forecast for all provided locations. It uses the \"dataStartAt\" and \"dataEndAt\" parameters to scope the forecasted data points (if available for those times). If no start or end time boundaries are provided, the entire forecast dataset is used. The scoped data points are used to calculate average marginal carbon intensities of the specified \"windowSize\" and the optimal marginal carbon intensity window is identified. The forecast data represents what the data source predicts future marginal carbon intensity values to be, not actual measured emissions data (as future values cannot be known). This endpoint is useful for determining if there is a more carbon-optimal time to use electricity predicted in the future.

Parameters:

location - String array of named locations (required)

dataStartAt - Start time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data. (optional)

dataEndAt - End time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data. (optional)

windowSize - The estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point. (optional)

Returns:

List<EmissionsForecastDTO>

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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

getCurrentForecastDataWithHttpInfo

public ApiResponse<List<EmissionsForecastDTO>> getCurrentForecastDataWithHttpInfo(List<String> location,
                                                                                  OffsetDateTime dataStartAt,
                                                                                  OffsetDateTime dataEndAt,
                                                                                  Integer windowSize)
                                                                           throws ApiException

Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window. This endpoint fetches only the most recently generated forecast for all provided locations. It uses the \"dataStartAt\" and \"dataEndAt\" parameters to scope the forecasted data points (if available for those times). If no start or end time boundaries are provided, the entire forecast dataset is used. The scoped data points are used to calculate average marginal carbon intensities of the specified \"windowSize\" and the optimal marginal carbon intensity window is identified. The forecast data represents what the data source predicts future marginal carbon intensity values to be, not actual measured emissions data (as future values cannot be known). This endpoint is useful for determining if there is a more carbon-optimal time to use electricity predicted in the future.

Parameters:

location - String array of named locations (required)

dataStartAt - Start time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data. (optional)

dataEndAt - End time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data. (optional)

windowSize - The estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point. (optional)

Returns:

ApiResponse<List<EmissionsForecastDTO>>

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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

getCurrentForecastDataAsync

public okhttp3.Call getCurrentForecastDataAsync(List<String> location,
                                                OffsetDateTime dataStartAt,
                                                OffsetDateTime dataEndAt,
                                                Integer windowSize,
                                                ApiCallback<List<EmissionsForecastDTO>> _callback)
                                         throws ApiException

Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window. (asynchronously) This endpoint fetches only the most recently generated forecast for all provided locations. It uses the \"dataStartAt\" and \"dataEndAt\" parameters to scope the forecasted data points (if available for those times). If no start or end time boundaries are provided, the entire forecast dataset is used. The scoped data points are used to calculate average marginal carbon intensities of the specified \"windowSize\" and the optimal marginal carbon intensity window is identified. The forecast data represents what the data source predicts future marginal carbon intensity values to be, not actual measured emissions data (as future values cannot be known). This endpoint is useful for determining if there is a more carbon-optimal time to use electricity predicted in the future.

Parameters:

location - String array of named locations (required)

dataStartAt - Start time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data. (optional)

dataEndAt - End time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data. (optional)

windowSize - The estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point. (optional)

_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	Returns the requested forecast objects	-
400	Returned if any of the input parameters are invalid	-
500	Internal server error	-
501	Returned if the underlying data source does not support forecasting	-

getEmissionsDataForLocationByTimeCall

public okhttp3.Call getEmissionsDataForLocationByTimeCall(String location,
                                                          OffsetDateTime time,
                                                          OffsetDateTime toTime,
                                                          ApiCallback _callback)
                                                   throws ApiException

Build call for getEmissionsDataForLocationByTime

Parameters:

location - String named location. (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

_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	-
400	Bad Request	-

getEmissionsDataForLocationByTime

public List<EmissionsData> getEmissionsDataForLocationByTime(String location,
                                                             OffsetDateTime time,
                                                             OffsetDateTime toTime)
                                                      throws ApiException

Calculate the best emission data by location for a specified time period.

Parameters:

location - String named location. (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

Returns:

List<EmissionsData>

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	-
400	Bad Request	-

getEmissionsDataForLocationByTimeWithHttpInfo

public ApiResponse<List<EmissionsData>> getEmissionsDataForLocationByTimeWithHttpInfo(String location,
                                                                                      OffsetDateTime time,
                                                                                      OffsetDateTime toTime)
                                                                               throws ApiException

Calculate the best emission data by location for a specified time period.

Parameters:

location - String named location. (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

Returns:

ApiResponse<List<EmissionsData>>

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	-
400	Bad Request	-

getEmissionsDataForLocationByTimeAsync

public okhttp3.Call getEmissionsDataForLocationByTimeAsync(String location,
                                                           OffsetDateTime time,
                                                           OffsetDateTime toTime,
                                                           ApiCallback<List<EmissionsData>> _callback)
                                                    throws ApiException

Calculate the best emission data by location for a specified time period. (asynchronously)

Parameters:

location - String named location. (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

_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	-
400	Bad Request	-

getEmissionsDataForLocationsByTimeCall

public okhttp3.Call getEmissionsDataForLocationsByTimeCall(List<String> location,
                                                           OffsetDateTime time,
                                                           OffsetDateTime toTime,
                                                           ApiCallback _callback)
                                                    throws ApiException

Build call for getEmissionsDataForLocationsByTime

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

_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	-
400	Bad Request	-

getEmissionsDataForLocationsByTime

public List<EmissionsData> getEmissionsDataForLocationsByTime(List<String> location,
                                                              OffsetDateTime time,
                                                              OffsetDateTime toTime)
                                                       throws ApiException

Calculate the observed emission data by list of locations for a specified time period.

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

Returns:

List<EmissionsData>

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	-
400	Bad Request	-

getEmissionsDataForLocationsByTimeWithHttpInfo

public ApiResponse<List<EmissionsData>> getEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
                                                                                       OffsetDateTime time,
                                                                                       OffsetDateTime toTime)
                                                                                throws ApiException

Calculate the observed emission data by list of locations for a specified time period.

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

Returns:

ApiResponse<List<EmissionsData>>

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	-
400	Bad Request	-

getEmissionsDataForLocationsByTimeAsync

public okhttp3.Call getEmissionsDataForLocationsByTimeAsync(List<String> location,
                                                            OffsetDateTime time,
                                                            OffsetDateTime toTime,
                                                            ApiCallback<List<EmissionsData>> _callback)
                                                     throws ApiException

Calculate the observed emission data by list of locations for a specified time period. (asynchronously)

Parameters:

location - String array of named locations (required)

time - [Optional] Start time for the data query. (optional)

toTime - [Optional] End time for the data query. (optional)

_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	-
400	Bad Request	-