| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+VERSION |
+"1.0.0" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_END_TIME |
+"endTime" |
+
+
+public static final String |
+SERIALIZED_NAME_LOCATION |
+"location" |
+
+
+public static final String |
+SERIALIZED_NAME_START_TIME |
+"startTime" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_CARBON_INTENSITY |
+"carbonIntensity" |
+
+
+public static final String |
+SERIALIZED_NAME_END_TIME |
+"endTime" |
+
+
+public static final String |
+SERIALIZED_NAME_LOCATION |
+"location" |
+
+
+public static final String |
+SERIALIZED_NAME_START_TIME |
+"startTime" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_DURATION |
+"duration" |
+
+
+public static final String |
+SERIALIZED_NAME_LOCATION |
+"location" |
+
+
+public static final String |
+SERIALIZED_NAME_RATING |
+"rating" |
+
+
+public static final String |
+SERIALIZED_NAME_TIME |
+"time" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_DURATION |
+"duration" |
+
+
+public static final String |
+SERIALIZED_NAME_LOCATION |
+"location" |
+
+
+public static final String |
+SERIALIZED_NAME_TIMESTAMP |
+"timestamp" |
+
+
+public static final String |
+SERIALIZED_NAME_VALUE |
+"value" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_DATA_END_AT |
+"dataEndAt" |
+
+
+public static final String |
+SERIALIZED_NAME_DATA_START_AT |
+"dataStartAt" |
+
+
+public static final String |
+SERIALIZED_NAME_LOCATION |
+"location" |
+
+
+public static final String |
+SERIALIZED_NAME_REQUESTED_AT |
+"requestedAt" |
+
+
+public static final String |
+SERIALIZED_NAME_WINDOW_SIZE |
+"windowSize" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_DATA_END_AT |
+"dataEndAt" |
+
+
+public static final String |
+SERIALIZED_NAME_DATA_START_AT |
+"dataStartAt" |
+
+
+public static final String |
+SERIALIZED_NAME_FORECAST_DATA |
+"forecastData" |
+
+
+public static final String |
+SERIALIZED_NAME_GENERATED_AT |
+"generatedAt" |
+
+
+public static final String |
+SERIALIZED_NAME_LOCATION |
+"location" |
+
+
+public static final String |
+SERIALIZED_NAME_OPTIMAL_DATA_POINTS |
+"optimalDataPoints" |
+
+
+public static final String |
+SERIALIZED_NAME_REQUESTED_AT |
+"requestedAt" |
+
+
+public static final String |
+SERIALIZED_NAME_WINDOW_SIZE |
+"windowSize" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_LATITUDE |
+"latitude" |
+
+
+public static final String |
+SERIALIZED_NAME_LONGITUDE |
+"longitude" |
+
+
+public static final String |
+SERIALIZED_NAME_NAME |
+"name" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+SERIALIZED_NAME_DETAIL |
+"detail" |
+
+
+public static final String |
+SERIALIZED_NAME_ERRORS |
+"errors" |
+
+
+public static final String |
+SERIALIZED_NAME_INSTANCE |
+"instance" |
+
+
+public static final String |
+SERIALIZED_NAME_STATUS |
+"status" |
+
+
+public static final String |
+SERIALIZED_NAME_TITLE |
+"title" |
+
+
+public static final String |
+SERIALIZED_NAME_TYPE |
+"type" |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/deprecated-list.html b/casdk-docs/static/client-apidocs/1.0.0/java/deprecated-list.html new file mode 100644 index 000000000..6ccf7a78f --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/deprecated-list.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiCallback.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiCallback.html new file mode 100644 index 000000000..ec279039d --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiCallback.html @@ -0,0 +1,321 @@ + + + + + + +T - The return typepublic interface ApiCallback<T>
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+onDownloadProgress(long bytesRead,
+ long contentLength,
+ boolean done)
+This is called when the API download processing.
+ |
+
void |
+onFailure(ApiException e,
+ int statusCode,
+ Map<String,List<String>> responseHeaders)
+This is called when the API call fails.
+ |
+
void |
+onSuccess(T result,
+ int statusCode,
+ Map<String,List<String>> responseHeaders)
+This is called when the API call succeeded.
+ |
+
void |
+onUploadProgress(long bytesWritten,
+ long contentLength,
+ boolean done)
+This is called when the API upload processing.
+ |
+
void onFailure(ApiException e, + int statusCode, + Map<String,List<String>> responseHeaders)+
e - The exception causing the failurestatusCode - Status code of the response if available, otherwise it would be 0responseHeaders - Headers of the response if available, otherwise it would be nullvoid onSuccess(T result, + int statusCode, + Map<String,List<String>> responseHeaders)+
result - The result deserialized from responsestatusCode - Status code of the responseresponseHeaders - Headers of the responsevoid onUploadProgress(long bytesWritten, + long contentLength, + boolean done)+
bytesWritten - bytes WrittencontentLength - content length of request bodydone - write endvoid onDownloadProgress(long bytesRead, + long contentLength, + boolean done)+
bytesRead - bytes ReadcontentLength - content length of the responsedone - Read endCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiClient.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiClient.html new file mode 100644 index 000000000..88d4c8f2c --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiClient.html @@ -0,0 +1,2114 @@ + + + + + + +public class ApiClient +extends Object+
ApiClient class.
| Modifier and Type | +Field and Description | +
|---|---|
protected Integer |
+serverIndex |
+
protected List<ServerConfiguration> |
+servers |
+
protected Map<String,String> |
+serverVariables |
+
| Constructor and Description | +
|---|
ApiClient()
+Basic constructor for ApiClient
+ |
+
ApiClient(okhttp3.OkHttpClient client)
+Basic constructor with custom OkHttpClient
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ApiClient |
+addDefaultCookie(String key,
+ String value)
+Add a default cookie.
+ |
+
ApiClient |
+addDefaultHeader(String key,
+ String value)
+Add a default header.
+ |
+
okhttp3.Call |
+buildCall(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build HTTP call with the given options.
+ |
+
okhttp3.Request |
+buildRequest(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build an HTTP request with the given options.
+ |
+
okhttp3.RequestBody |
+buildRequestBodyFormEncoding(Map<String,Object> formParams)
+Build a form-encoding request body with the given form parameters.
+ |
+
okhttp3.RequestBody |
+buildRequestBodyMultipart(Map<String,Object> formParams)
+Build a multipart (file uploading) request body with the given form parameters,
+ which could contain text fields and file fields.
+ |
+
String |
+buildUrl(String baseUrl,
+ String path,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams)
+Build full URL by concatenating base path, the given sub path and query parameters.
+ |
+
String |
+collectionPathParameterToString(String collectionFormat,
+ Collection value)
+Formats the specified collection path parameter to a string value.
+ |
+
<T> T |
+deserialize(okhttp3.Response response,
+ Type returnType)
+Deserialize response body to Java object, according to the return type and
+ the Content-Type response header.
+ |
+
File |
+downloadFileFromResponse(okhttp3.Response response)
+Download file from the given response.
+ |
+
String |
+escapeString(String str)
+Escape the given string to be used as URL query value.
+ |
+
<T> ApiResponse<T> |
+execute(okhttp3.Call call)
+
+ |
+
<T> ApiResponse<T> |
+execute(okhttp3.Call call,
+ Type returnType)
+Execute HTTP call and deserialize the HTTP response body into the given return type.
+ |
+
<T> void |
+executeAsync(okhttp3.Call call,
+ ApiCallback<T> callback)
+
+ |
+
<T> void |
+executeAsync(okhttp3.Call call,
+ Type returnType,
+ ApiCallback<T> callback)
+Execute HTTP call asynchronously.
+ |
+
List<Pair> |
+freeFormParameterToPairs(Object value)
+Formats the specified free-form query parameters to a list of
+Pair objects. |
+
Authentication |
+getAuthentication(String authName)
+Get authentication for the given name.
+ |
+
Map<String,Authentication> |
+getAuthentications()
+Get authentications (key: authentication name, value: authentication).
+ |
+
String |
+getBasePath()
+Get base path
+ |
+
int |
+getConnectTimeout()
+Get connection timeout (in milliseconds).
+ |
+
DateFormat |
+getDateFormat()
+Getter for the field
+dateFormat. |
+
okhttp3.OkHttpClient |
+getHttpClient()
+Get HTTP client
+ |
+
JSON |
+getJSON()
+Get JSON
+ |
+
KeyManager[] |
+getKeyManagers()
+Getter for the field
+keyManagers. |
+
int |
+getReadTimeout()
+Get read timeout (in milliseconds).
+ |
+
Integer |
+getServerIndex() |
+
List<ServerConfiguration> |
+getServers() |
+
Map<String,String> |
+getServerVariables() |
+
InputStream |
+getSslCaCert()
+Get SSL CA cert.
+ |
+
String |
+getTempFolderPath()
+The path of temporary folder used to store downloaded files from endpoints
+ with file response.
+ |
+
int |
+getWriteTimeout()
+Get write timeout (in milliseconds).
+ |
+
String |
+guessContentTypeFromFile(File file)
+Guess Content-Type header from the given file (defaults to "application/octet-stream").
+ |
+
<T> T |
+handleResponse(okhttp3.Response response,
+ Type returnType)
+Handle the given response, return the deserialized object when the response is successful.
+ |
+
boolean |
+isDebugging()
+Check that whether debugging is enabled for this API client.
+ |
+
boolean |
+isJsonMime(String mime)
+Check if the given MIME is a JSON MIME.
+ |
+
boolean |
+isVerifyingSsl()
+True if isVerifyingSsl flag is on
+ |
+
List<Pair> |
+parameterToPair(String name,
+ Object value)
+Formats the specified query parameter to a list containing a single
+Pair object. |
+
List<Pair> |
+parameterToPairs(String collectionFormat,
+ String name,
+ Collection value)
+Formats the specified collection query parameters to a list of
+Pair objects. |
+
String |
+parameterToString(Object param)
+Format the given parameter object into string.
+ |
+
File |
+prepareDownloadFile(okhttp3.Response response)
+Prepare file for download
+ |
+
void |
+processCookieParams(Map<String,String> cookieParams,
+ okhttp3.Request.Builder reqBuilder)
+Set cookie parameters to the request builder, including default cookies.
+ |
+
void |
+processHeaderParams(Map<String,String> headerParams,
+ okhttp3.Request.Builder reqBuilder)
+Set header parameters to the request builder, including default headers.
+ |
+
String |
+sanitizeFilename(String filename)
+Sanitize filename by removing path.
+ |
+
String |
+selectHeaderAccept(String[] accepts)
+Select the Accept header's value from the given accepts array:
+ if JSON exists in the given array, use it;
+ otherwise use all of them (joining into a string)
+ |
+
String |
+selectHeaderContentType(String[] contentTypes)
+Select the Content-Type header's value from the given array:
+ if JSON exists in the given array, use it;
+ otherwise use the first one of the array.
+ |
+
okhttp3.RequestBody |
+serialize(Object obj,
+ String contentType)
+Serialize the given Java object into request body according to the object's
+ class and the request Content-Type.
+ |
+
void |
+setAccessToken(String accessToken)
+Helper method to set access token for the first OAuth2 authentication.
+ |
+
void |
+setApiKey(String apiKey)
+Helper method to set API key value for the first API key authentication.
+ |
+
void |
+setApiKeyPrefix(String apiKeyPrefix)
+Helper method to set API key prefix for the first API key authentication.
+ |
+
void |
+setAWS4Configuration(String accessKey,
+ String secretKey,
+ String region,
+ String service)
+Helper method to set credentials for AWSV4 Signature
+ |
+
void |
+setAWS4Configuration(String accessKey,
+ String secretKey,
+ String sessionToken,
+ String region,
+ String service)
+Helper method to set credentials for AWSV4 Signature
+ |
+
ApiClient |
+setBasePath(String basePath)
+Set base path
+ |
+
ApiClient |
+setConnectTimeout(int connectionTimeout)
+Sets the connect timeout (in milliseconds).
+ |
+
ApiClient |
+setDateFormat(DateFormat dateFormat)
+Setter for the field
+dateFormat. |
+
ApiClient |
+setDebugging(boolean debugging)
+Enable/disable debugging for this API client.
+ |
+
ApiClient |
+setHttpClient(okhttp3.OkHttpClient newHttpClient)
+Set HTTP client, which must never be null.
+ |
+
ApiClient |
+setJSON(JSON json)
+Set JSON
+ |
+
ApiClient |
+setKeyManagers(KeyManager[] managers)
+Configure client keys to use for authorization in an SSL session.
+ |
+
ApiClient |
+setLenientOnJson(boolean lenientOnJson)
+Set LenientOnJson.
+ |
+
ApiClient |
+setLocalDateFormat(DateTimeFormatter dateFormat)
+Set LocalDateFormat.
+ |
+
ApiClient |
+setOffsetDateTimeFormat(DateTimeFormatter dateFormat)
+Set OffsetDateTimeFormat.
+ |
+
void |
+setPassword(String password)
+Helper method to set password for the first HTTP basic authentication.
+ |
+
ApiClient |
+setReadTimeout(int readTimeout)
+Sets the read timeout (in milliseconds).
+ |
+
ApiClient |
+setServerIndex(Integer serverIndex) |
+
ApiClient |
+setServers(List<ServerConfiguration> servers) |
+
ApiClient |
+setServerVariables(Map<String,String> serverVariables) |
+
ApiClient |
+setSqlDateFormat(DateFormat dateFormat)
+Set SqlDateFormat.
+ |
+
ApiClient |
+setSslCaCert(InputStream sslCaCert)
+Configure the CA certificate to be trusted when making https requests.
+ |
+
ApiClient |
+setTempFolderPath(String tempFolderPath)
+Set the temporary folder path (for downloading files)
+ |
+
ApiClient |
+setUserAgent(String userAgent)
+Set the User-Agent header's value (by adding to the default header map).
+ |
+
void |
+setUsername(String username)
+Helper method to set username for the first HTTP basic authentication.
+ |
+
ApiClient |
+setVerifyingSsl(boolean verifyingSsl)
+Configure whether to verify certificate and hostname when making https requests.
+ |
+
ApiClient |
+setWriteTimeout(int writeTimeout)
+Sets the write timeout (in milliseconds).
+ |
+
void |
+updateParamsForAuth(String[] authNames,
+ List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Update query and header parameters based on authentication settings.
+ |
+
protected List<ServerConfiguration> servers+
protected Integer serverIndex+
public ApiClient()+
public ApiClient(okhttp3.OkHttpClient client)+
client - a OkHttpClient objectpublic String getBasePath()+
public ApiClient setBasePath(String basePath)+
basePath - Base path of the URL (e.g http://localhostpublic List<ServerConfiguration> getServers()+
public ApiClient setServers(List<ServerConfiguration> servers)+
public Integer getServerIndex()+
public okhttp3.OkHttpClient getHttpClient()+
public ApiClient setHttpClient(okhttp3.OkHttpClient newHttpClient)+
newHttpClient - An instance of OkHttpClientNullPointerException - when newHttpClient is nullpublic JSON getJSON()+
public ApiClient setJSON(JSON json)+
json - JSON objectpublic boolean isVerifyingSsl()+
public ApiClient setVerifyingSsl(boolean verifyingSsl)+
verifyingSsl - True to verify TLS/SSL connectionpublic InputStream getSslCaCert()+
public ApiClient setSslCaCert(InputStream sslCaCert)+
sslCaCert - input stream for SSL CA certpublic KeyManager[] getKeyManagers()+
Getter for the field keyManagers.
KeyManager objectspublic ApiClient setKeyManagers(KeyManager[] managers)+
managers - The KeyManagers to usepublic DateFormat getDateFormat()+
Getter for the field dateFormat.
DateFormat objectpublic ApiClient setDateFormat(DateFormat dateFormat)+
Setter for the field dateFormat.
dateFormat - a DateFormat objectApiClient objectpublic ApiClient setSqlDateFormat(DateFormat dateFormat)+
Set SqlDateFormat.
dateFormat - a DateFormat objectApiClient objectpublic ApiClient setOffsetDateTimeFormat(DateTimeFormatter dateFormat)+
Set OffsetDateTimeFormat.
dateFormat - a DateTimeFormatter objectApiClient objectpublic ApiClient setLocalDateFormat(DateTimeFormatter dateFormat)+
Set LocalDateFormat.
dateFormat - a DateTimeFormatter objectApiClient objectpublic ApiClient setLenientOnJson(boolean lenientOnJson)+
Set LenientOnJson.
lenientOnJson - a booleanApiClient objectpublic Map<String,Authentication> getAuthentications()+
public Authentication getAuthentication(String authName)+
authName - The authentication namepublic void setUsername(String username)+
username - Usernamepublic void setPassword(String password)+
password - Passwordpublic void setApiKey(String apiKey)+
apiKey - API keypublic void setApiKeyPrefix(String apiKeyPrefix)+
apiKeyPrefix - API key prefixpublic void setAccessToken(String accessToken)+
accessToken - Access tokenpublic void setAWS4Configuration(String accessKey, + String secretKey, + String region, + String service)+
accessKey - Access KeysecretKey - Secret Keyregion - Regionservice - Service to access topublic void setAWS4Configuration(String accessKey, + String secretKey, + String sessionToken, + String region, + String service)+
accessKey - Access KeysecretKey - Secret KeysessionToken - Session Tokenregion - Regionservice - Service to access topublic ApiClient setUserAgent(String userAgent)+
userAgent - HTTP request's user agentpublic ApiClient addDefaultHeader(String key, + String value)+
key - The header's keyvalue - The header's valuepublic ApiClient addDefaultCookie(String key, + String value)+
key - The cookie's keyvalue - The cookie's valuepublic boolean isDebugging()+
public ApiClient setDebugging(boolean debugging)+
debugging - To enable (true) or disable (false) debuggingpublic String getTempFolderPath()+
null, i.e. using
+ the system's default temporary folder.public ApiClient setTempFolderPath(String tempFolderPath)+
tempFolderPath - Temporary folder pathpublic int getConnectTimeout()+
public ApiClient setConnectTimeout(int connectionTimeout)+
Integer.MAX_VALUE.connectionTimeout - connection timeout in millisecondspublic int getReadTimeout()+
public ApiClient setReadTimeout(int readTimeout)+
Integer.MAX_VALUE.readTimeout - read timeout in millisecondspublic int getWriteTimeout()+
public ApiClient setWriteTimeout(int writeTimeout)+
Integer.MAX_VALUE.writeTimeout - connection timeout in millisecondspublic String parameterToString(Object param)+
param - Parameterpublic List<Pair> parameterToPair(String name, + Object value)+
Pair object.
+
+ Note that value must not be a collection.name - The name of the parameter.value - The value of the parameter.Pair object.public List<Pair> parameterToPairs(String collectionFormat, + String name, + Collection value)+
Pair objects.
+
+ Note that the values of each of the returned Pair objects are percent-encoded.collectionFormat - The collection format of the parameter.name - The name of the parameter.value - The value of the parameter.Pair objects.public List<Pair> freeFormParameterToPairs(Object value)+
Pair objects.value - The free-form query parameters.Pair objects.public String collectionPathParameterToString(String collectionFormat, + Collection value)+
collectionFormat - The collection format of the parameter.value - The value of the parameter.public String sanitizeFilename(String filename)+
filename - The filename to be sanitizedpublic boolean isJsonMime(String mime)+
mime - MIME (Multipurpose Internet Mail Extensions)public String selectHeaderAccept(String[] accepts)+
accepts - The accepts array to select frompublic String selectHeaderContentType(String[] contentTypes)+
contentTypes - The Content-Type array to select frompublic String escapeString(String str)+
str - String to be escapedpublic <T> T deserialize(okhttp3.Response response, + Type returnType) + throws ApiException+
T - Typeresponse - HTTP responsereturnType - The type of the Java objectApiException - If fail to deserialize response body, i.e. cannot read response body
+ or the Content-Type of the response is not supported.public okhttp3.RequestBody serialize(Object obj, + String contentType) + throws ApiException+
obj - The Java objectcontentType - The request Content-TypeApiException - If fail to serialize the given objectpublic File downloadFileFromResponse(okhttp3.Response response) + throws ApiException+
response - An instance of the Response objectApiException - If fail to read file content from response and write to diskpublic File prepareDownloadFile(okhttp3.Response response) + throws IOException+
response - An instance of the Response objectIOException - If fail to prepare file for downloadpublic <T> ApiResponse<T> execute(okhttp3.Call call) + throws ApiException+ +
T - Typecall - An instance of the Call objectApiException - If fail to execute the callpublic <T> ApiResponse<T> execute(okhttp3.Call call, + Type returnType) + throws ApiException+
T - The return type corresponding to (same with) returnTypereturnType - The return type used to deserialize HTTP response bodycall - CallApiException - If fail to execute the callpublic <T> void executeAsync(okhttp3.Call call, + ApiCallback<T> callback)+ +
T - Typecall - An instance of the Call objectcallback - ApiCallback<T>public <T> void executeAsync(okhttp3.Call call, + Type returnType, + ApiCallback<T> callback)+
T - Typecall - The callback to be executed when the API call finishesreturnType - Return typecallback - ApiCallbackexecute(Call, Type)public <T> T handleResponse(okhttp3.Response response, + Type returnType) + throws ApiException+
T - Typeresponse - ResponsereturnType - Return typeApiException - If the response has an unsuccessful status code or
+ fail to deserialize the response bodypublic okhttp3.Call buildCall(String baseUrl, + String path, + String method, + List<Pair> queryParams, + List<Pair> collectionQueryParams, + Object body, + Map<String,String> headerParams, + Map<String,String> cookieParams, + Map<String,Object> formParams, + String[] authNames, + ApiCallback callback) + throws ApiException+
baseUrl - The base URLpath - The sub-path of the HTTP URLmethod - The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"queryParams - The query parameterscollectionQueryParams - The collection query parametersbody - The request body objectheaderParams - The header parameterscookieParams - The cookie parametersformParams - The form parametersauthNames - The authentications to applycallback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic okhttp3.Request buildRequest(String baseUrl, + String path, + String method, + List<Pair> queryParams, + List<Pair> collectionQueryParams, + Object body, + Map<String,String> headerParams, + Map<String,String> cookieParams, + Map<String,Object> formParams, + String[] authNames, + ApiCallback callback) + throws ApiException+
baseUrl - The base URLpath - The sub-path of the HTTP URLmethod - The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"queryParams - The query parameterscollectionQueryParams - The collection query parametersbody - The request body objectheaderParams - The header parameterscookieParams - The cookie parametersformParams - The form parametersauthNames - The authentications to applycallback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic String buildUrl(String baseUrl, + String path, + List<Pair> queryParams, + List<Pair> collectionQueryParams)+
baseUrl - The base URLpath - The sub pathqueryParams - The query parameterscollectionQueryParams - The collection query parameterspublic void processHeaderParams(Map<String,String> headerParams, + okhttp3.Request.Builder reqBuilder)+
headerParams - Header parameters in the form of MapreqBuilder - Request.Builderpublic void processCookieParams(Map<String,String> cookieParams, + okhttp3.Request.Builder reqBuilder)+
cookieParams - Cookie parameters in the form of MapreqBuilder - Request.Builderpublic void updateParamsForAuth(String[] authNames, + List<Pair> queryParams, + Map<String,String> headerParams, + Map<String,String> cookieParams, + String payload, + String method, + URI uri) + throws ApiException+
authNames - The authentications to applyqueryParams - List of query parametersheaderParams - Map of header parameterscookieParams - Map of cookie parameterspayload - HTTP request bodymethod - HTTP methoduri - URIApiException - If fails to update the parameterspublic okhttp3.RequestBody buildRequestBodyFormEncoding(Map<String,Object> formParams)+
formParams - Form parameters in the form of Mappublic okhttp3.RequestBody buildRequestBodyMultipart(Map<String,Object> formParams)+
formParams - Form parameters in the form of MapCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiException.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiException.html new file mode 100644 index 000000000..a649762d8 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiException.html @@ -0,0 +1,574 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class ApiException +extends Exception+
ApiException class.
| Constructor and Description | +
|---|
ApiException()
+Constructor for ApiException.
+ |
+
ApiException(int code,
+ Map<String,List<String>> responseHeaders,
+ String responseBody)
+Constructor for ApiException.
+ |
+
ApiException(int code,
+ String message)
+Constructor for ApiException.
+ |
+
ApiException(int code,
+ String message,
+ Map<String,List<String>> responseHeaders,
+ String responseBody)
+Constructor for ApiException.
+ |
+
ApiException(String message)
+Constructor for ApiException.
+ |
+
ApiException(String message,
+ int code,
+ Map<String,List<String>> responseHeaders,
+ String responseBody)
+Constructor for ApiException.
+ |
+
ApiException(String message,
+ Throwable throwable,
+ int code,
+ Map<String,List<String>> responseHeaders)
+Constructor for ApiException.
+ |
+
ApiException(String message,
+ Throwable throwable,
+ int code,
+ Map<String,List<String>> responseHeaders,
+ String responseBody)
+Constructor for ApiException.
+ |
+
ApiException(Throwable throwable)
+Constructor for ApiException.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getCode()
+Get the HTTP status code.
+ |
+
String |
+getMessage()
+Get the exception message including HTTP response data.
+ |
+
String |
+getResponseBody()
+Get the HTTP response body.
+ |
+
Map<String,List<String>> |
+getResponseHeaders()
+Get the HTTP response headers.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic ApiException()+
Constructor for ApiException.
public ApiException(Throwable throwable)+
Constructor for ApiException.
throwable - a Throwable objectpublic ApiException(String message)+
Constructor for ApiException.
message - the error messagepublic ApiException(String message, + Throwable throwable, + int code, + Map<String,List<String>> responseHeaders, + String responseBody)+
Constructor for ApiException.
public ApiException(String message, + int code, + Map<String,List<String>> responseHeaders, + String responseBody)+
Constructor for ApiException.
message - the error messagecode - HTTP status coderesponseHeaders - a Map of HTTP response headersresponseBody - the response bodypublic ApiException(String message, + Throwable throwable, + int code, + Map<String,List<String>> responseHeaders)+
Constructor for ApiException.
public ApiException(int code, + Map<String,List<String>> responseHeaders, + String responseBody)+
Constructor for ApiException.
code - HTTP status coderesponseHeaders - a Map of HTTP response headersresponseBody - the response bodypublic ApiException(int code, + String message)+
Constructor for ApiException.
code - HTTP status codemessage - a String objectpublic ApiException(int code, + String message, + Map<String,List<String>> responseHeaders, + String responseBody)+
Constructor for ApiException.
code - HTTP status codemessage - the error messageresponseHeaders - a Map of HTTP response headersresponseBody - the response bodypublic int getCode()+
public Map<String,List<String>> getResponseHeaders()+
public String getResponseBody()+
public String getMessage()+
getMessage in class ThrowableCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiResponse.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiResponse.html new file mode 100644 index 000000000..b7f42783f --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ApiResponse.html @@ -0,0 +1,358 @@ + + + + + + +public class ApiResponse<T> +extends Object+
| Constructor and Description | +
|---|
ApiResponse(int statusCode,
+ Map<String,List<String>> headers)
+Constructor for ApiResponse.
+ |
+
ApiResponse(int statusCode,
+ Map<String,List<String>> headers,
+ T data)
+Constructor for ApiResponse.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+getData()
+Get the
+data. |
+
Map<String,List<String>> |
+getHeaders()
+Get the
+headers. |
+
int |
+getStatusCode()
+Get the
+status code. |
+
public ApiResponse(int statusCode, + Map<String,List<String>> headers)+
Constructor for ApiResponse.
statusCode - The status code of HTTP responseheaders - The headers of HTTP responsepublic int getStatusCode()+
Get the status code.
public Map<String,List<String>> getHeaders()+
Get the headers.
Map of headerspublic T getData()+
Get the data.
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/Configuration.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/Configuration.html new file mode 100644 index 000000000..4b6d24d40 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/Configuration.html @@ -0,0 +1,347 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class Configuration +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+VERSION |
+
| Constructor and Description | +
|---|
Configuration() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ApiClient |
+getDefaultApiClient()
+Get the default API client, which would be used when creating API
+ instances without providing an API client.
+ |
+
static void |
+setDefaultApiClient(ApiClient apiClient)
+Set the default API client, which would be used when creating API
+ instances without providing an API client.
+ |
+
public static final String VERSION+
public static ApiClient getDefaultApiClient()+
public static void setDefaultApiClient(ApiClient apiClient)+
apiClient - API clientCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.ByteArrayAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.ByteArrayAdapter.html new file mode 100644 index 000000000..99a231928 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.ByteArrayAdapter.html @@ -0,0 +1,319 @@ + + + + + + +public static class JSON.ByteArrayAdapter
+extends com.google.gson.TypeAdapter<byte[]>
+| Constructor and Description | +
|---|
ByteArrayAdapter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
byte[] |
+read(com.google.gson.stream.JsonReader in) |
+
void |
+write(com.google.gson.stream.JsonWriter out,
+ byte[] value) |
+
fromJson, fromJson, fromJsonTree, nullSafe, toJson, toJson, toJsonTreepublic void write(com.google.gson.stream.JsonWriter out, + byte[] value) + throws IOException+
write in class com.google.gson.TypeAdapter<byte[]>IOExceptionpublic byte[] read(com.google.gson.stream.JsonReader in) + throws IOException+
read in class com.google.gson.TypeAdapter<byte[]>IOExceptionCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.DateTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.DateTypeAdapter.html new file mode 100644 index 000000000..606dde062 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.DateTypeAdapter.html @@ -0,0 +1,345 @@ + + + + + + +| Constructor and Description | +
|---|
DateTypeAdapter() |
+
DateTypeAdapter(DateFormat dateFormat) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Date |
+read(com.google.gson.stream.JsonReader in) |
+
void |
+setFormat(DateFormat dateFormat) |
+
void |
+write(com.google.gson.stream.JsonWriter out,
+ Date date) |
+
fromJson, fromJson, fromJsonTree, nullSafe, toJson, toJson, toJsonTreepublic DateTypeAdapter()+
public DateTypeAdapter(DateFormat dateFormat)+
public void setFormat(DateFormat dateFormat)+
public void write(com.google.gson.stream.JsonWriter out, + Date date) + throws IOException+
write in class com.google.gson.TypeAdapter<Date>IOExceptionpublic Date read(com.google.gson.stream.JsonReader in) + throws IOException+
read in class com.google.gson.TypeAdapter<Date>IOExceptionCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.LocalDateTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.LocalDateTypeAdapter.html new file mode 100644 index 000000000..7409d4335 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.LocalDateTypeAdapter.html @@ -0,0 +1,344 @@ + + + + + + +| Constructor and Description | +
|---|
LocalDateTypeAdapter() |
+
LocalDateTypeAdapter(DateTimeFormatter formatter) |
+
| Modifier and Type | +Method and Description | +
|---|---|
LocalDate |
+read(com.google.gson.stream.JsonReader in) |
+
void |
+setFormat(DateTimeFormatter dateFormat) |
+
void |
+write(com.google.gson.stream.JsonWriter out,
+ LocalDate date) |
+
fromJson, fromJson, fromJsonTree, nullSafe, toJson, toJson, toJsonTreepublic LocalDateTypeAdapter()+
public LocalDateTypeAdapter(DateTimeFormatter formatter)+
public void setFormat(DateTimeFormatter dateFormat)+
public void write(com.google.gson.stream.JsonWriter out, + LocalDate date) + throws IOException+
write in class com.google.gson.TypeAdapter<LocalDate>IOExceptionpublic LocalDate read(com.google.gson.stream.JsonReader in) + throws IOException+
read in class com.google.gson.TypeAdapter<LocalDate>IOExceptionCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.OffsetDateTimeTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.OffsetDateTimeTypeAdapter.html new file mode 100644 index 000000000..5bfd4193d --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.OffsetDateTimeTypeAdapter.html @@ -0,0 +1,344 @@ + + + + + + +public static class JSON.OffsetDateTimeTypeAdapter +extends com.google.gson.TypeAdapter<OffsetDateTime>+
| Constructor and Description | +
|---|
OffsetDateTimeTypeAdapter() |
+
OffsetDateTimeTypeAdapter(DateTimeFormatter formatter) |
+
| Modifier and Type | +Method and Description | +
|---|---|
OffsetDateTime |
+read(com.google.gson.stream.JsonReader in) |
+
void |
+setFormat(DateTimeFormatter dateFormat) |
+
void |
+write(com.google.gson.stream.JsonWriter out,
+ OffsetDateTime date) |
+
fromJson, fromJson, fromJsonTree, nullSafe, toJson, toJson, toJsonTreepublic OffsetDateTimeTypeAdapter()+
public OffsetDateTimeTypeAdapter(DateTimeFormatter formatter)+
public void setFormat(DateTimeFormatter dateFormat)+
public void write(com.google.gson.stream.JsonWriter out, + OffsetDateTime date) + throws IOException+
write in class com.google.gson.TypeAdapter<OffsetDateTime>IOExceptionpublic OffsetDateTime read(com.google.gson.stream.JsonReader in) + throws IOException+
read in class com.google.gson.TypeAdapter<OffsetDateTime>IOExceptionCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.SqlDateTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.SqlDateTypeAdapter.html new file mode 100644 index 000000000..9f86a129d --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.SqlDateTypeAdapter.html @@ -0,0 +1,346 @@ + + + + + + +| Constructor and Description | +
|---|
SqlDateTypeAdapter() |
+
SqlDateTypeAdapter(DateFormat dateFormat) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Date |
+read(com.google.gson.stream.JsonReader in) |
+
void |
+setFormat(DateFormat dateFormat) |
+
void |
+write(com.google.gson.stream.JsonWriter out,
+ Date date) |
+
fromJson, fromJson, fromJsonTree, nullSafe, toJson, toJson, toJsonTreepublic SqlDateTypeAdapter()+
public SqlDateTypeAdapter(DateFormat dateFormat)+
public void setFormat(DateFormat dateFormat)+
public void write(com.google.gson.stream.JsonWriter out, + Date date) + throws IOException+
write in class com.google.gson.TypeAdapter<Date>IOExceptionpublic Date read(com.google.gson.stream.JsonReader in) + throws IOException+
read in class com.google.gson.TypeAdapter<Date>IOExceptionCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.html new file mode 100644 index 000000000..b8aa6efb6 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/JSON.html @@ -0,0 +1,475 @@ + + + + + + +public class JSON +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+JSON.ByteArrayAdapter
+Gson TypeAdapter for Byte Array type
+ |
+
static class |
+JSON.DateTypeAdapter
+Gson TypeAdapter for java.util.Date type
+ If the dateFormat is null, ISO8601Utils will be used.
+ |
+
static class |
+JSON.LocalDateTypeAdapter
+Gson TypeAdapter for JSR310 LocalDate type
+ |
+
static class |
+JSON.OffsetDateTimeTypeAdapter
+Gson TypeAdapter for JSR310 OffsetDateTime type
+ |
+
static class |
+JSON.SqlDateTypeAdapter
+Gson TypeAdapter for java.sql.Date type
+ If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
+ (more efficient than SimpleDateFormat).
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static com.google.gson.GsonBuilder |
+createGson() |
+
static <T> T |
+deserialize(String body,
+ Type returnType)
+Deserialize the given JSON string to Java object.
+ |
+
static com.google.gson.Gson |
+getGson()
+Get Gson.
+ |
+
static String |
+serialize(Object obj)
+Serialize the given Java object into JSON string.
+ |
+
static void |
+setDateFormat(DateFormat dateFormat) |
+
static void |
+setGson(com.google.gson.Gson gson)
+Set Gson.
+ |
+
static void |
+setLenientOnJson(boolean lenientOnJson) |
+
static void |
+setLocalDateFormat(DateTimeFormatter dateFormat) |
+
static void |
+setOffsetDateTimeFormat(DateTimeFormatter dateFormat) |
+
static void |
+setSqlDateFormat(DateFormat dateFormat) |
+
public static com.google.gson.GsonBuilder createGson()+
public static com.google.gson.Gson getGson()+
public static void setGson(com.google.gson.Gson gson)+
gson - Gsonpublic static void setLenientOnJson(boolean lenientOnJson)+
public static String serialize(Object obj)+
obj - Objectpublic static <T> T deserialize(String body, + Type returnType)+
T - Typebody - The JSON stringreturnType - The type to deserialize intopublic static void setOffsetDateTimeFormat(DateTimeFormatter dateFormat)+
public static void setLocalDateFormat(DateTimeFormatter dateFormat)+
public static void setDateFormat(DateFormat dateFormat)+
public static void setSqlDateFormat(DateFormat dateFormat)+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/Pair.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/Pair.html new file mode 100644 index 000000000..67cd057b5 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/Pair.html @@ -0,0 +1,291 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class Pair +extends Object+
| Constructor and Description | +
|---|
Pair(String name,
+ String value) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getName() |
+
String |
+getValue() |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ProgressRequestBody.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ProgressRequestBody.html new file mode 100644 index 000000000..68f772b4d --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ProgressRequestBody.html @@ -0,0 +1,361 @@ + + + + + + +public class ProgressRequestBody
+extends okhttp3.RequestBody
+okhttp3.RequestBody.Companion| Constructor and Description | +
|---|
ProgressRequestBody(okhttp3.RequestBody requestBody,
+ ApiCallback callback) |
+
| Modifier and Type | +Method and Description | +
|---|---|
long |
+contentLength() |
+
okhttp3.MediaType |
+contentType() |
+
void |
+writeTo(okio.BufferedSink sink) |
+
create, create, create, create, create, create, create, create, create, create, create, create, create, isDuplex, isOneShotpublic ProgressRequestBody(okhttp3.RequestBody requestBody, + ApiCallback callback)+
public okhttp3.MediaType contentType()+
contentType in class okhttp3.RequestBodypublic long contentLength() + throws IOException+
contentLength in class okhttp3.RequestBodyIOExceptionpublic void writeTo(okio.BufferedSink sink) + throws IOException+
writeTo in class okhttp3.RequestBodyIOExceptionCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ProgressResponseBody.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ProgressResponseBody.html new file mode 100644 index 000000000..4e1dfe3bf --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ProgressResponseBody.html @@ -0,0 +1,359 @@ + + + + + + +public class ProgressResponseBody
+extends okhttp3.ResponseBody
+okhttp3.ResponseBody.BomAwareReader, okhttp3.ResponseBody.Companion| Constructor and Description | +
|---|
ProgressResponseBody(okhttp3.ResponseBody responseBody,
+ ApiCallback callback) |
+
| Modifier and Type | +Method and Description | +
|---|---|
long |
+contentLength() |
+
okhttp3.MediaType |
+contentType() |
+
okio.BufferedSource |
+source() |
+
bytes, byteStream, byteString, charStream, close, create, create, create, create, create, create, create, create, stringpublic ProgressResponseBody(okhttp3.ResponseBody responseBody, + ApiCallback callback)+
public okhttp3.MediaType contentType()+
contentType in class okhttp3.ResponseBodypublic long contentLength()+
contentLength in class okhttp3.ResponseBodypublic okio.BufferedSource source()+
source in class okhttp3.ResponseBodyCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ServerConfiguration.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ServerConfiguration.html new file mode 100644 index 000000000..e814e0c90 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ServerConfiguration.html @@ -0,0 +1,378 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class ServerConfiguration +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
String |
+description |
+
String |
+URL |
+
Map<String,ServerVariable> |
+variables |
+
| Constructor and Description | +
|---|
ServerConfiguration(String URL,
+ String description,
+ Map<String,ServerVariable> variables) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+URL()
+Format URL template using default server variables.
+ |
+
String |
+URL(Map<String,String> variables)
+Format URL template using given variables.
+ |
+
public String URL+
public String description+
public Map<String,ServerVariable> variables+
public ServerConfiguration(String URL, + String description, + Map<String,ServerVariable> variables)+
URL - A URL to the target host.description - A description of the host designated by the URL.variables - A map between a variable name and its value. The value is used for substitution in the server's URL template.public String URL(Map<String,String> variables)+
variables - A map between a variable name and its value.public String URL()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ServerVariable.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ServerVariable.html new file mode 100644 index 000000000..d557487b9 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/ServerVariable.html @@ -0,0 +1,315 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class ServerVariable +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
String |
+defaultValue |
+
String |
+description |
+
HashSet<String> |
+enumValues |
+
public String description+
public String defaultValue+
public ServerVariable(String description, + String defaultValue, + HashSet<String> enumValues)+
description - A description for the server variable.defaultValue - The default value to use for substitution.enumValues - An enumeration of string values to be used if the substitution options are from a limited set.Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/StringUtil.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/StringUtil.html new file mode 100644 index 000000000..1f56d429b --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/StringUtil.html @@ -0,0 +1,342 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class StringUtil +extends Object+
| Constructor and Description | +
|---|
StringUtil() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static boolean |
+containsIgnoreCase(String[] array,
+ String value)
+Check if the given array contains the given value (with case-insensitive comparison).
+ |
+
static String |
+join(Collection<String> list,
+ String separator)
+Join a list of strings with the given separator.
+ |
+
static String |
+join(String[] array,
+ String separator)
+Join an array of strings with the given separator.
+ |
+
public static boolean containsIgnoreCase(String[] array, + String value)+
array - The arrayvalue - The value to searchpublic static String join(String[] array, + String separator)+
+ Note: This might be replaced by utility method from commons-lang or guava someday + if one of those libraries is added as dependency. +
array - The array of stringsseparator - The separatorpublic static String join(Collection<String> list, + String separator)+
list - The list of stringsseparator - The separatorCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/ApiKeyAuth.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/ApiKeyAuth.html new file mode 100644 index 000000000..fa05c2f35 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/ApiKeyAuth.html @@ -0,0 +1,389 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class ApiKeyAuth +extends Object +implements Authentication+
| Constructor and Description | +
|---|
ApiKeyAuth(String location,
+ String paramName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Apply authentication settings to header and query params.
+ |
+
String |
+getApiKey() |
+
String |
+getApiKeyPrefix() |
+
String |
+getLocation() |
+
String |
+getParamName() |
+
void |
+setApiKey(String apiKey) |
+
void |
+setApiKeyPrefix(String apiKeyPrefix) |
+
public String getLocation()+
public String getParamName()+
public String getApiKey()+
public void setApiKey(String apiKey)+
public String getApiKeyPrefix()+
public void setApiKeyPrefix(String apiKeyPrefix)+
public void applyToParams(List<Pair> queryParams, + Map<String,String> headerParams, + Map<String,String> cookieParams, + String payload, + String method, + URI uri) + throws ApiException+
AuthenticationapplyToParams in interface AuthenticationqueryParams - List of query parametersheaderParams - Map of header parameterscookieParams - Map of cookie parameterspayload - HTTP request bodymethod - HTTP methoduri - URIApiException - if failed to update the parametersCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/Authentication.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/Authentication.html new file mode 100644 index 000000000..2a6bc1d95 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/Authentication.html @@ -0,0 +1,252 @@ + + + + + + +public interface Authentication
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Apply authentication settings to header and query params.
+ |
+
void applyToParams(List<Pair> queryParams, + Map<String,String> headerParams, + Map<String,String> cookieParams, + String payload, + String method, + URI uri) + throws ApiException+
queryParams - List of query parametersheaderParams - Map of header parameterscookieParams - Map of cookie parameterspayload - HTTP request bodymethod - HTTP methoduri - URIApiException - if failed to update the parametersCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/HttpBasicAuth.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/HttpBasicAuth.html new file mode 100644 index 000000000..b646bd8aa --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/HttpBasicAuth.html @@ -0,0 +1,358 @@ + + + + + + +public class HttpBasicAuth +extends Object +implements Authentication+
| Constructor and Description | +
|---|
HttpBasicAuth() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Apply authentication settings to header and query params.
+ |
+
String |
+getPassword() |
+
String |
+getUsername() |
+
void |
+setPassword(String password) |
+
void |
+setUsername(String username) |
+
public String getUsername()+
public void setUsername(String username)+
public String getPassword()+
public void setPassword(String password)+
public void applyToParams(List<Pair> queryParams, + Map<String,String> headerParams, + Map<String,String> cookieParams, + String payload, + String method, + URI uri) + throws ApiException+
AuthenticationapplyToParams in interface AuthenticationqueryParams - List of query parametersheaderParams - Map of header parameterscookieParams - Map of cookie parameterspayload - HTTP request bodymethod - HTTP methoduri - URIApiException - if failed to update the parametersCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/HttpBearerAuth.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/HttpBearerAuth.html new file mode 100644 index 000000000..46351f49b --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/HttpBearerAuth.html @@ -0,0 +1,369 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class HttpBearerAuth +extends Object +implements Authentication+
| Constructor and Description | +
|---|
HttpBearerAuth(String scheme) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Apply authentication settings to header and query params.
+ |
+
String |
+getBearerToken()
+Gets the token, which together with the scheme, will be sent as the value of the Authorization header.
+ |
+
void |
+setBearerToken(String bearerToken)
+Sets the token, which together with the scheme, will be sent as the value of the Authorization header.
+ |
+
void |
+setBearerToken(Supplier<String> tokenSupplier)
+Sets the supplier of tokens, which together with the scheme, will be sent as the value of the Authorization header.
+ |
+
public String getBearerToken()+
public void setBearerToken(String bearerToken)+
bearerToken - The bearer token to send in the Authorization headerpublic void setBearerToken(Supplier<String> tokenSupplier)+
tokenSupplier - The supplier of bearer tokens to send in the Authorization headerpublic void applyToParams(List<Pair> queryParams, + Map<String,String> headerParams, + Map<String,String> cookieParams, + String payload, + String method, + URI uri) + throws ApiException+
AuthenticationapplyToParams in interface AuthenticationqueryParams - List of query parametersheaderParams - Map of header parameterscookieParams - Map of cookie parameterspayload - HTTP request bodymethod - HTTP methoduri - URIApiException - if failed to update the parametersCopyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/ApiKeyAuth.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/ApiKeyAuth.html new file mode 100644 index 000000000..3fcdbacec --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/ApiKeyAuth.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/Authentication.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/Authentication.html new file mode 100644 index 000000000..8bdc8e4a5 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/Authentication.html @@ -0,0 +1,213 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Authentication |
+ApiClient.getAuthentication(String authName)
+Get authentication for the given name.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Map<String,Authentication> |
+ApiClient.getAuthentications()
+Get authentications (key: authentication name, value: authentication).
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ApiKeyAuth |
+
class |
+HttpBasicAuth |
+
class |
+HttpBearerAuth |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/HttpBasicAuth.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/HttpBasicAuth.html new file mode 100644 index 000000000..88245f5a5 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/HttpBasicAuth.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/HttpBearerAuth.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/HttpBearerAuth.html new file mode 100644 index 000000000..760fbcb8f --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/class-use/HttpBearerAuth.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-frame.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-frame.html new file mode 100644 index 000000000..43f79ccdb --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-frame.html @@ -0,0 +1,27 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Authentication | ++ |
| Class | +Description | +
|---|---|
| ApiKeyAuth | ++ |
| HttpBasicAuth | ++ |
| HttpBearerAuth | ++ |
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-tree.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-tree.html new file mode 100644 index 000000000..a6128d284 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-tree.html @@ -0,0 +1,145 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-use.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-use.html new file mode 100644 index 000000000..c61310790 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/auth/package-use.html @@ -0,0 +1,178 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.auth | ++ |
| Class and Description | +
|---|
| Authentication | +
| Class and Description | +
|---|
| Authentication | +
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiCallback.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiCallback.html new file mode 100644 index 000000000..bdeadc636 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiCallback.html @@ -0,0 +1,375 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+ApiClient.buildCall(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build HTTP call with the given options.
+ |
+
okhttp3.Request |
+ApiClient.buildRequest(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build an HTTP request with the given options.
+ |
+
<T> void |
+ApiClient.executeAsync(okhttp3.Call call,
+ ApiCallback<T> callback)
+
+ |
+
<T> void |
+ApiClient.executeAsync(okhttp3.Call call,
+ Type returnType,
+ ApiCallback<T> callback)
+Execute HTTP call asynchronously.
+ |
+
| Constructor and Description | +
|---|
ProgressRequestBody(okhttp3.RequestBody requestBody,
+ ApiCallback callback) |
+
ProgressResponseBody(okhttp3.ResponseBody responseBody,
+ ApiCallback callback) |
+
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.batchForecastDataAsyncCall(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO,
+ ApiCallback _callback)
+Build call for batchForecastDataAsync
+ |
+
okhttp3.Call |
+LocationsApi.getAllLocationsAsync(ApiCallback<Map<String,Location>> _callback)
+Get all locations instances (asynchronously)
+ |
+
okhttp3.Call |
+LocationsApi.getAllLocationsCall(ApiCallback _callback)
+Build call for getAllLocations
+ |
+
okhttp3.Call |
+CarbonAwareApi.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.
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getAverageCarbonIntensityBatchCall(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO,
+ ApiCallback _callback)
+Build call for getAverageCarbonIntensityBatch
+ |
+
okhttp3.Call |
+CarbonAwareApi.getAverageCarbonIntensityCall(String location,
+ OffsetDateTime startTime,
+ OffsetDateTime endTime,
+ ApiCallback _callback)
+Build call for getAverageCarbonIntensity
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getBestEmissionsDataForLocationsByTimeCall(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime,
+ ApiCallback _callback)
+Build call for getBestEmissionsDataForLocationsByTime
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getCurrentForecastDataCall(List<String> location,
+ OffsetDateTime dataStartAt,
+ OffsetDateTime dataEndAt,
+ Integer windowSize,
+ ApiCallback _callback)
+Build call for getCurrentForecastData
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getEmissionsDataForLocationByTimeCall(String location,
+ OffsetDateTime time,
+ OffsetDateTime toTime,
+ ApiCallback _callback)
+Build call for getEmissionsDataForLocationByTime
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getEmissionsDataForLocationsByTimeCall(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime,
+ ApiCallback _callback)
+Build call for getEmissionsDataForLocationsByTime
+ |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiClient.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiClient.html new file mode 100644 index 000000000..a716623a3 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiClient.html @@ -0,0 +1,370 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ApiClient |
+ApiClient.addDefaultCookie(String key,
+ String value)
+Add a default cookie.
+ |
+
ApiClient |
+ApiClient.addDefaultHeader(String key,
+ String value)
+Add a default header.
+ |
+
static ApiClient |
+Configuration.getDefaultApiClient()
+Get the default API client, which would be used when creating API
+ instances without providing an API client.
+ |
+
ApiClient |
+ApiClient.setBasePath(String basePath)
+Set base path
+ |
+
ApiClient |
+ApiClient.setConnectTimeout(int connectionTimeout)
+Sets the connect timeout (in milliseconds).
+ |
+
ApiClient |
+ApiClient.setDateFormat(DateFormat dateFormat)
+Setter for the field
+dateFormat. |
+
ApiClient |
+ApiClient.setDebugging(boolean debugging)
+Enable/disable debugging for this API client.
+ |
+
ApiClient |
+ApiClient.setHttpClient(okhttp3.OkHttpClient newHttpClient)
+Set HTTP client, which must never be null.
+ |
+
ApiClient |
+ApiClient.setJSON(JSON json)
+Set JSON
+ |
+
ApiClient |
+ApiClient.setKeyManagers(KeyManager[] managers)
+Configure client keys to use for authorization in an SSL session.
+ |
+
ApiClient |
+ApiClient.setLenientOnJson(boolean lenientOnJson)
+Set LenientOnJson.
+ |
+
ApiClient |
+ApiClient.setLocalDateFormat(DateTimeFormatter dateFormat)
+Set LocalDateFormat.
+ |
+
ApiClient |
+ApiClient.setOffsetDateTimeFormat(DateTimeFormatter dateFormat)
+Set OffsetDateTimeFormat.
+ |
+
ApiClient |
+ApiClient.setReadTimeout(int readTimeout)
+Sets the read timeout (in milliseconds).
+ |
+
ApiClient |
+ApiClient.setServerIndex(Integer serverIndex) |
+
ApiClient |
+ApiClient.setServers(List<ServerConfiguration> servers) |
+
ApiClient |
+ApiClient.setServerVariables(Map<String,String> serverVariables) |
+
ApiClient |
+ApiClient.setSqlDateFormat(DateFormat dateFormat)
+Set SqlDateFormat.
+ |
+
ApiClient |
+ApiClient.setSslCaCert(InputStream sslCaCert)
+Configure the CA certificate to be trusted when making https requests.
+ |
+
ApiClient |
+ApiClient.setTempFolderPath(String tempFolderPath)
+Set the temporary folder path (for downloading files)
+ |
+
ApiClient |
+ApiClient.setUserAgent(String userAgent)
+Set the User-Agent header's value (by adding to the default header map).
+ |
+
ApiClient |
+ApiClient.setVerifyingSsl(boolean verifyingSsl)
+Configure whether to verify certificate and hostname when making https requests.
+ |
+
ApiClient |
+ApiClient.setWriteTimeout(int writeTimeout)
+Sets the write timeout (in milliseconds).
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+Configuration.setDefaultApiClient(ApiClient apiClient)
+Set the default API client, which would be used when creating API
+ instances without providing an API client.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ApiClient |
+LocationsApi.getApiClient() |
+
ApiClient |
+CarbonAwareApi.getApiClient() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LocationsApi.setApiClient(ApiClient apiClient) |
+
void |
+CarbonAwareApi.setApiClient(ApiClient apiClient) |
+
| Constructor and Description | +
|---|
CarbonAwareApi(ApiClient apiClient) |
+
LocationsApi(ApiClient apiClient) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiException.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiException.html new file mode 100644 index 000000000..d40b0fe04 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiException.html @@ -0,0 +1,589 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.auth | ++ |
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ApiCallback.onFailure(ApiException e,
+ int statusCode,
+ Map<String,List<String>> responseHeaders)
+This is called when the API call fails.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+ApiClient.buildCall(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build HTTP call with the given options.
+ |
+
okhttp3.Request |
+ApiClient.buildRequest(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build an HTTP request with the given options.
+ |
+
<T> T |
+ApiClient.deserialize(okhttp3.Response response,
+ Type returnType)
+Deserialize response body to Java object, according to the return type and
+ the Content-Type response header.
+ |
+
File |
+ApiClient.downloadFileFromResponse(okhttp3.Response response)
+Download file from the given response.
+ |
+
<T> ApiResponse<T> |
+ApiClient.execute(okhttp3.Call call)
+
+ |
+
<T> ApiResponse<T> |
+ApiClient.execute(okhttp3.Call call,
+ Type returnType)
+Execute HTTP call and deserialize the HTTP response body into the given return type.
+ |
+
<T> T |
+ApiClient.handleResponse(okhttp3.Response response,
+ Type returnType)
+Handle the given response, return the deserialized object when the response is successful.
+ |
+
okhttp3.RequestBody |
+ApiClient.serialize(Object obj,
+ String contentType)
+Serialize the given Java object into request body according to the object's
+ class and the request Content-Type.
+ |
+
void |
+ApiClient.updateParamsForAuth(String[] authNames,
+ List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Update query and header parameters based on authentication settings.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ApiKeyAuth.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri) |
+
void |
+HttpBasicAuth.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri) |
+
void |
+Authentication.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Apply authentication settings to header and query params.
+ |
+
void |
+HttpBearerAuth.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri) |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<EmissionsForecastDTO> |
+CarbonAwareApi.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 |
+CarbonAwareApi.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 |
+CarbonAwareApi.batchForecastDataAsyncCall(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO,
+ ApiCallback _callback)
+Build call for batchForecastDataAsync
+ |
+
ApiResponse<List<EmissionsForecastDTO>> |
+CarbonAwareApi.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.
+ |
+
Map<String,Location> |
+LocationsApi.getAllLocations()
+Get all locations instances
+ |
+
okhttp3.Call |
+LocationsApi.getAllLocationsAsync(ApiCallback<Map<String,Location>> _callback)
+Get all locations instances (asynchronously)
+ |
+
okhttp3.Call |
+LocationsApi.getAllLocationsCall(ApiCallback _callback)
+Build call for getAllLocations
+ |
+
ApiResponse<Map<String,Location>> |
+LocationsApi.getAllLocationsWithHttpInfo()
+Get all locations instances
+ |
+
CarbonIntensityDTO |
+CarbonAwareApi.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 |
+CarbonAwareApi.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> |
+CarbonAwareApi.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 |
+CarbonAwareApi.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 |
+CarbonAwareApi.getAverageCarbonIntensityBatchCall(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO,
+ ApiCallback _callback)
+Build call for getAverageCarbonIntensityBatch
+ |
+
ApiResponse<List<CarbonIntensityDTO>> |
+CarbonAwareApi.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 |
+CarbonAwareApi.getAverageCarbonIntensityCall(String location,
+ OffsetDateTime startTime,
+ OffsetDateTime endTime,
+ ApiCallback _callback)
+Build call for getAverageCarbonIntensity
+ |
+
ApiResponse<CarbonIntensityDTO> |
+CarbonAwareApi.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> |
+CarbonAwareApi.getBestEmissionsDataForLocationsByTime(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by list of locations for a specified time period.
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getBestEmissionsDataForLocationsByTimeCall(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime,
+ ApiCallback _callback)
+Build call for getBestEmissionsDataForLocationsByTime
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getBestEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by list of locations for a specified time period.
+ |
+
List<EmissionsForecastDTO> |
+CarbonAwareApi.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 |
+CarbonAwareApi.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 |
+CarbonAwareApi.getCurrentForecastDataCall(List<String> location,
+ OffsetDateTime dataStartAt,
+ OffsetDateTime dataEndAt,
+ Integer windowSize,
+ ApiCallback _callback)
+Build call for getCurrentForecastData
+ |
+
ApiResponse<List<EmissionsForecastDTO>> |
+CarbonAwareApi.getCurrentForecastDataWithHttpInfo(List<String> location,
+ OffsetDateTime dataStartAt,
+ OffsetDateTime dataEndAt,
+ Integer windowSize)
+Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
+ |
+
List<EmissionsData> |
+CarbonAwareApi.getEmissionsDataForLocationByTime(String location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by location for a specified time period.
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getEmissionsDataForLocationByTimeCall(String location,
+ OffsetDateTime time,
+ OffsetDateTime toTime,
+ ApiCallback _callback)
+Build call for getEmissionsDataForLocationByTime
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getEmissionsDataForLocationByTimeWithHttpInfo(String location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by location for a specified time period.
+ |
+
List<EmissionsData> |
+CarbonAwareApi.getEmissionsDataForLocationsByTime(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the observed emission data by list of locations for a specified time period.
+ |
+
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.getEmissionsDataForLocationsByTimeCall(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime,
+ ApiCallback _callback)
+Build call for getEmissionsDataForLocationsByTime
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the observed emission data by list of locations for a specified time period.
+ |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiResponse.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiResponse.html new file mode 100644 index 000000000..ee1c49544 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ApiResponse.html @@ -0,0 +1,252 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
<T> ApiResponse<T> |
+ApiClient.execute(okhttp3.Call call)
+
+ |
+
<T> ApiResponse<T> |
+ApiClient.execute(okhttp3.Call call,
+ Type returnType)
+Execute HTTP call and deserialize the HTTP response body into the given return type.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ApiResponse<List<EmissionsForecastDTO>> |
+CarbonAwareApi.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.
+ |
+
ApiResponse<Map<String,Location>> |
+LocationsApi.getAllLocationsWithHttpInfo()
+Get all locations instances
+ |
+
ApiResponse<List<CarbonIntensityDTO>> |
+CarbonAwareApi.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.
+ |
+
ApiResponse<CarbonIntensityDTO> |
+CarbonAwareApi.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.
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getBestEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by list of locations for a specified time period.
+ |
+
ApiResponse<List<EmissionsForecastDTO>> |
+CarbonAwareApi.getCurrentForecastDataWithHttpInfo(List<String> location,
+ OffsetDateTime dataStartAt,
+ OffsetDateTime dataEndAt,
+ Integer windowSize)
+Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getEmissionsDataForLocationByTimeWithHttpInfo(String location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by location for a specified time period.
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the observed emission data by list of locations for a specified time period.
+ |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/Configuration.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/Configuration.html new file mode 100644 index 000000000..e5cc72185 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/Configuration.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.ByteArrayAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.ByteArrayAdapter.html new file mode 100644 index 000000000..5fb530b9c --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.ByteArrayAdapter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.DateTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.DateTypeAdapter.html new file mode 100644 index 000000000..0b023476a --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.DateTypeAdapter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.LocalDateTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.LocalDateTypeAdapter.html new file mode 100644 index 000000000..f55e4cca8 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.LocalDateTypeAdapter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.OffsetDateTimeTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.OffsetDateTimeTypeAdapter.html new file mode 100644 index 000000000..f404b20d1 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.OffsetDateTimeTypeAdapter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.SqlDateTypeAdapter.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.SqlDateTypeAdapter.html new file mode 100644 index 000000000..f5a0129f3 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.SqlDateTypeAdapter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.html new file mode 100644 index 000000000..2589bd267 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/JSON.html @@ -0,0 +1,183 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
JSON |
+ApiClient.getJSON()
+Get JSON
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ApiClient |
+ApiClient.setJSON(JSON json)
+Set JSON
+ |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/Pair.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/Pair.html new file mode 100644 index 000000000..6d4991cde --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/Pair.html @@ -0,0 +1,342 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.auth | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
List<Pair> |
+ApiClient.freeFormParameterToPairs(Object value)
+Formats the specified free-form query parameters to a list of
+Pair objects. |
+
List<Pair> |
+ApiClient.parameterToPair(String name,
+ Object value)
+Formats the specified query parameter to a list containing a single
+Pair object. |
+
List<Pair> |
+ApiClient.parameterToPairs(String collectionFormat,
+ String name,
+ Collection value)
+Formats the specified collection query parameters to a list of
+Pair objects. |
+
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+ApiClient.buildCall(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build HTTP call with the given options.
+ |
+
okhttp3.Call |
+ApiClient.buildCall(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build HTTP call with the given options.
+ |
+
okhttp3.Request |
+ApiClient.buildRequest(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build an HTTP request with the given options.
+ |
+
okhttp3.Request |
+ApiClient.buildRequest(String baseUrl,
+ String path,
+ String method,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams,
+ Object body,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ Map<String,Object> formParams,
+ String[] authNames,
+ ApiCallback callback)
+Build an HTTP request with the given options.
+ |
+
String |
+ApiClient.buildUrl(String baseUrl,
+ String path,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams)
+Build full URL by concatenating base path, the given sub path and query parameters.
+ |
+
String |
+ApiClient.buildUrl(String baseUrl,
+ String path,
+ List<Pair> queryParams,
+ List<Pair> collectionQueryParams)
+Build full URL by concatenating base path, the given sub path and query parameters.
+ |
+
void |
+ApiClient.updateParamsForAuth(String[] authNames,
+ List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Update query and header parameters based on authentication settings.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ApiKeyAuth.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri) |
+
void |
+HttpBasicAuth.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri) |
+
void |
+Authentication.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri)
+Apply authentication settings to header and query params.
+ |
+
void |
+HttpBearerAuth.applyToParams(List<Pair> queryParams,
+ Map<String,String> headerParams,
+ Map<String,String> cookieParams,
+ String payload,
+ String method,
+ URI uri) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ProgressRequestBody.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ProgressRequestBody.html new file mode 100644 index 000000000..b71a95f65 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ProgressRequestBody.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ProgressResponseBody.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ProgressResponseBody.html new file mode 100644 index 000000000..2e7c64e88 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ProgressResponseBody.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ServerConfiguration.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ServerConfiguration.html new file mode 100644 index 000000000..c28f02f9f --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ServerConfiguration.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected List<ServerConfiguration> |
+ApiClient.servers |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ServerConfiguration> |
+ApiClient.getServers() |
+
| Modifier and Type | +Method and Description | +
|---|---|
ApiClient |
+ApiClient.setServers(List<ServerConfiguration> servers) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ServerVariable.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ServerVariable.html new file mode 100644 index 000000000..a2c7f90ab --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/ServerVariable.html @@ -0,0 +1,179 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
Map<String,ServerVariable> |
+ServerConfiguration.variables |
+
| Constructor and Description | +
|---|
ServerConfiguration(String URL,
+ String description,
+ Map<String,ServerVariable> variables) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/StringUtil.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/StringUtil.html new file mode 100644 index 000000000..d148aa318 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/class-use/StringUtil.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/CarbonAwareApi.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/CarbonAwareApi.html new file mode 100644 index 000000000..762858ed7 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/CarbonAwareApi.html @@ -0,0 +1,1468 @@ + + + + + + +public class CarbonAwareApi +extends Object+
| Constructor and Description | +
|---|
CarbonAwareApi() |
+
CarbonAwareApi(ApiClient apiClient) |
+
| 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) |
+
public CarbonAwareApi()+
public CarbonAwareApi(ApiClient apiClient)+
public ApiClient getApiClient()+
public void setApiClient(ApiClient apiClient)+
public int getHostIndex()+
public void setHostIndex(int hostIndex)+
public String getCustomBaseUrl()+
public void setCustomBaseUrl(String customBaseUrl)+
public okhttp3.Call batchForecastDataAsyncCall(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO, + ApiCallback _callback) + throws ApiException+
emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| 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 | - |
public List<EmissionsForecastDTO> batchForecastDataAsync(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO) + throws ApiException+
emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public ApiResponse<List<EmissionsForecastDTO>> batchForecastDataAsyncWithHttpInfo(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO) + throws ApiException+
emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public okhttp3.Call batchForecastDataAsyncAsync(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO, + ApiCallback<List<EmissionsForecastDTO>> _callback) + throws ApiException+
emissionsForecastBatchParametersDTO - Array of requested forecasts. (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| 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 | - |
public okhttp3.Call getAverageCarbonIntensityCall(String location, + OffsetDateTime startTime, + OffsetDateTime endTime, + ApiCallback _callback) + throws ApiException+
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 progressApiException - If fail to serialize the request body object| 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 | - |
public CarbonIntensityDTO getAverageCarbonIntensity(String location, + OffsetDateTime startTime, + OffsetDateTime endTime) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public ApiResponse<CarbonIntensityDTO> getAverageCarbonIntensityWithHttpInfo(String location, + OffsetDateTime startTime, + OffsetDateTime endTime) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public okhttp3.Call getAverageCarbonIntensityAsync(String location, + OffsetDateTime startTime, + OffsetDateTime endTime, + ApiCallback<CarbonIntensityDTO> _callback) + throws ApiException+
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| 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 | - |
public okhttp3.Call getAverageCarbonIntensityBatchCall(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO, + ApiCallback _callback) + throws ApiException+
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 progressApiException - If fail to serialize the request body object| 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 | - |
public List<CarbonIntensityDTO> getAverageCarbonIntensityBatch(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO) + throws ApiException+
carbonIntensityBatchParametersDTO - Array of inputs where each contains a \"location\", \"startDate\", and \"endDate\" for which to calculate average marginal carbon intensity. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public ApiResponse<List<CarbonIntensityDTO>> getAverageCarbonIntensityBatchWithHttpInfo(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO) + throws ApiException+
carbonIntensityBatchParametersDTO - Array of inputs where each contains a \"location\", \"startDate\", and \"endDate\" for which to calculate average marginal carbon intensity. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public okhttp3.Call getAverageCarbonIntensityBatchAsync(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO, + ApiCallback<List<CarbonIntensityDTO>> _callback) + throws ApiException+
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| 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 | - |
public okhttp3.Call getBestEmissionsDataForLocationsByTimeCall(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime, + ApiCallback _callback) + throws ApiException+
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 progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public List<EmissionsData> getBestEmissionsDataForLocationsByTime(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public ApiResponse<List<EmissionsData>> getBestEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public okhttp3.Call getBestEmissionsDataForLocationsByTimeAsync(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime, + ApiCallback<List<EmissionsData>> _callback) + throws ApiException+
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public okhttp3.Call getCurrentForecastDataCall(List<String> location, + OffsetDateTime dataStartAt, + OffsetDateTime dataEndAt, + Integer windowSize, + ApiCallback _callback) + throws ApiException+
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 progressApiException - If fail to serialize the request body object| 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 | - |
public List<EmissionsForecastDTO> getCurrentForecastData(List<String> location, + OffsetDateTime dataStartAt, + OffsetDateTime dataEndAt, + Integer windowSize) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public ApiResponse<List<EmissionsForecastDTO>> getCurrentForecastDataWithHttpInfo(List<String> location, + OffsetDateTime dataStartAt, + OffsetDateTime dataEndAt, + Integer windowSize) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| 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 | - |
public okhttp3.Call getCurrentForecastDataAsync(List<String> location, + OffsetDateTime dataStartAt, + OffsetDateTime dataEndAt, + Integer windowSize, + ApiCallback<List<EmissionsForecastDTO>> _callback) + throws ApiException+
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| 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 | - |
public okhttp3.Call getEmissionsDataForLocationByTimeCall(String location, + OffsetDateTime time, + OffsetDateTime toTime, + ApiCallback _callback) + throws ApiException+
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 progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public List<EmissionsData> getEmissionsDataForLocationByTime(String location, + OffsetDateTime time, + OffsetDateTime toTime) + throws ApiException+
location - String named location. (required)time - [Optional] Start time for the data query. (optional)toTime - [Optional] End time for the data query. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public ApiResponse<List<EmissionsData>> getEmissionsDataForLocationByTimeWithHttpInfo(String location, + OffsetDateTime time, + OffsetDateTime toTime) + throws ApiException+
location - String named location. (required)time - [Optional] Start time for the data query. (optional)toTime - [Optional] End time for the data query. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public okhttp3.Call getEmissionsDataForLocationByTimeAsync(String location, + OffsetDateTime time, + OffsetDateTime toTime, + ApiCallback<List<EmissionsData>> _callback) + throws ApiException+
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public okhttp3.Call getEmissionsDataForLocationsByTimeCall(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime, + ApiCallback _callback) + throws ApiException+
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 progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public List<EmissionsData> getEmissionsDataForLocationsByTime(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public ApiResponse<List<EmissionsData>> getEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime) + throws ApiException+
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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
public okhttp3.Call getEmissionsDataForLocationsByTimeAsync(List<String> location, + OffsetDateTime time, + OffsetDateTime toTime, + ApiCallback<List<EmissionsData>> _callback) + throws ApiException+
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 finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
| 400 | Bad Request | - |
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/LocationsApi.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/LocationsApi.html new file mode 100644 index 000000000..f38d2de5e --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/LocationsApi.html @@ -0,0 +1,474 @@ + + + + + + +public class LocationsApi +extends Object+
| Constructor and Description | +
|---|
LocationsApi() |
+
LocationsApi(ApiClient apiClient) |
+
| 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) |
+
public LocationsApi()+
public LocationsApi(ApiClient apiClient)+
public ApiClient getApiClient()+
public void setApiClient(ApiClient apiClient)+
public int getHostIndex()+
public void setHostIndex(int hostIndex)+
public String getCustomBaseUrl()+
public void setCustomBaseUrl(String customBaseUrl)+
public okhttp3.Call getAllLocationsCall(ApiCallback _callback) + throws ApiException+
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
public Map<String,Location> getAllLocations() + throws ApiException+
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
public ApiResponse<Map<String,Location>> getAllLocationsWithHttpInfo() + throws ApiException+
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
public okhttp3.Call getAllLocationsAsync(ApiCallback<Map<String,Location>> _callback) + throws ApiException+
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | Success | - |
| 204 | No Content | - |
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/class-use/CarbonAwareApi.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/class-use/CarbonAwareApi.html new file mode 100644 index 000000000..9ceb6fa53 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/class-use/CarbonAwareApi.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/class-use/LocationsApi.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/class-use/LocationsApi.html new file mode 100644 index 000000000..123456030 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/class-use/LocationsApi.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-frame.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-frame.html new file mode 100644 index 000000000..8c5f6b921 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| CarbonAwareApi | ++ |
| LocationsApi | ++ |
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-tree.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-tree.html new file mode 100644 index 000000000..046e078e5 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-tree.html @@ -0,0 +1,140 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-use.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-use.html new file mode 100644 index 000000000..e7b37a4d4 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/client/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-frame.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-frame.html new file mode 100644 index 000000000..70dc08b66 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +| Interface | +Description | +
|---|---|
| ApiCallback<T> | +
+ Callback for asynchronous API call.
+ |
+
| Class | +Description | +
|---|---|
| ApiClient | +
+ ApiClient class.
+ |
+
| ApiResponse<T> | +
+ API response returned by API call.
+ |
+
| Configuration | ++ |
| JSON | ++ |
| JSON.ByteArrayAdapter | +
+ Gson TypeAdapter for Byte Array type
+ |
+
| JSON.DateTypeAdapter | +
+ Gson TypeAdapter for java.util.Date type
+ If the dateFormat is null, ISO8601Utils will be used.
+ |
+
| JSON.LocalDateTypeAdapter | +
+ Gson TypeAdapter for JSR310 LocalDate type
+ |
+
| JSON.OffsetDateTimeTypeAdapter | +
+ Gson TypeAdapter for JSR310 OffsetDateTime type
+ |
+
| JSON.SqlDateTypeAdapter | +
+ Gson TypeAdapter for java.sql.Date type
+ If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
+ (more efficient than SimpleDateFormat).
+ |
+
| Pair | ++ |
| ProgressRequestBody | ++ |
| ProgressResponseBody | ++ |
| ServerConfiguration | +
+ Representing a Server configuration.
+ |
+
| ServerVariable | +
+ Representing a Server Variable for server URL template substitution.
+ |
+
| StringUtil | ++ |
| Exception | +Description | +
|---|---|
| ApiException | +
+ ApiException class.
+ |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-tree.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-tree.html new file mode 100644 index 000000000..6a16dbad0 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-tree.html @@ -0,0 +1,178 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-use.html b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-use.html new file mode 100644 index 000000000..c64f38775 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/foundation/greensoftware/carbonaware/webapi/package-use.html @@ -0,0 +1,252 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.auth | ++ |
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| Class and Description | +
|---|
| ApiCallback
+ Callback for asynchronous API call.
+ |
+
| ApiClient
+ ApiClient class.
+ |
+
| ApiException
+ ApiException class.
+ |
+
| ApiResponse
+ API response returned by API call.
+ |
+
| JSON | +
| Pair | +
| ServerConfiguration
+ Representing a Server configuration.
+ |
+
| ServerVariable
+ Representing a Server Variable for server URL template substitution.
+ |
+
| Class and Description | +
|---|
| ApiException
+ ApiException class.
+ |
+
| Pair | +
| Class and Description | +
|---|
| ApiCallback
+ Callback for asynchronous API call.
+ |
+
| ApiClient
+ ApiClient class.
+ |
+
| ApiException
+ ApiException class.
+ |
+
| ApiResponse
+ API response returned by API call.
+ |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/help-doc.html b/casdk-docs/static/client-apidocs/1.0.0/java/help-doc.html new file mode 100644 index 000000000..d77182779 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/index-all.html b/casdk-docs/static/client-apidocs/1.0.0/java/index-all.html new file mode 100644 index 000000000..31a981a18 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/index-all.html @@ -0,0 +1,1770 @@ + + + + + + +Pair objects.data.dateFormat.headers.keyManagers.status code.Pair object.Pair objects.dateFormat.Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/index.html b/casdk-docs/static/client-apidocs/1.0.0/java/index.html new file mode 100644 index 000000000..efddc8b61 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/index.html @@ -0,0 +1,76 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public abstract class AbstractOpenApiSchema +extends Object+
| Constructor and Description | +
|---|
AbstractOpenApiSchema(String schemaType,
+ Boolean isNullable) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
Object |
+getActualInstance()
+Get the actual instance
+ |
+
Object |
+getActualInstanceRecursively()
+Get the instant recursively when the schemas defined in oneOf/anyof happen to be oneOf/anyOf schema as well
+ |
+
abstract Map<String,Class<?>> |
+getSchemas()
+Get the list of oneOf/anyOf composed schemas allowed to be stored in this object
+ |
+
String |
+getSchemaType()
+Get the schema type (e.g.
+ |
+
int |
+hashCode() |
+
Boolean |
+isNullable()
+Is nullable
+ |
+
void |
+setActualInstance(Object instance)
+Set the actual instance
+ |
+
String |
+toString() |
+
public abstract Map<String,Class<?>> getSchemas()+
public Object getActualInstance()+
public void setActualInstance(Object instance)+
instance - the actual instance of the schema/objectpublic Object getActualInstanceRecursively()+
public String getSchemaType()+
public Boolean isNullable()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..83c1e98a4 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +public static class CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory +extends Object +implements com.google.gson.TypeAdapterFactory+
| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityBatchParametersDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityBatchParametersDTO.html new file mode 100644 index 000000000..4e7a496b9 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityBatchParametersDTO.html @@ -0,0 +1,649 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class CarbonIntensityBatchParametersDTO +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_END_TIME |
+
static String |
+SERIALIZED_NAME_LOCATION |
+
static String |
+SERIALIZED_NAME_START_TIME |
+
| Constructor and Description | +
|---|
CarbonIntensityBatchParametersDTO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
CarbonIntensityBatchParametersDTO |
+endTime(OffsetDateTime endTime) |
+
boolean |
+equals(Object o) |
+
static CarbonIntensityBatchParametersDTO |
+fromJson(String jsonString)
+Create an instance of CarbonIntensityBatchParametersDTO given an JSON string
+ |
+
OffsetDateTime |
+getEndTime()
+The time at which the workflow we are measuring carbon intensity for ended
+ |
+
String |
+getLocation()
+The location name where workflow is run
+ |
+
OffsetDateTime |
+getStartTime()
+The time at which the workflow we are measuring carbon intensity for started
+ |
+
int |
+hashCode() |
+
CarbonIntensityBatchParametersDTO |
+location(String location) |
+
void |
+setEndTime(OffsetDateTime endTime) |
+
void |
+setLocation(String location) |
+
void |
+setStartTime(OffsetDateTime startTime) |
+
CarbonIntensityBatchParametersDTO |
+startTime(OffsetDateTime startTime) |
+
String |
+toJson()
+Convert an instance of CarbonIntensityBatchParametersDTO to an JSON string
+ |
+
String |
+toString() |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
public static final String SERIALIZED_NAME_LOCATION+
public static final String SERIALIZED_NAME_START_TIME+
public static final String SERIALIZED_NAME_END_TIME+
public CarbonIntensityBatchParametersDTO()+
public CarbonIntensityBatchParametersDTO location(@Nullable + String location)+
@Nullable +public String getLocation()+
public CarbonIntensityBatchParametersDTO startTime(@Nullable + OffsetDateTime startTime)+
@Nullable +public OffsetDateTime getStartTime()+
public void setStartTime(@Nullable + OffsetDateTime startTime)+
public CarbonIntensityBatchParametersDTO endTime(@Nullable + OffsetDateTime endTime)+
@Nullable +public OffsetDateTime getEndTime()+
public void setEndTime(@Nullable + OffsetDateTime endTime)+
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to CarbonIntensityBatchParametersDTOpublic static CarbonIntensityBatchParametersDTO fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to CarbonIntensityBatchParametersDTOpublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..1d420b2f4 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +public static class CarbonIntensityDTO.CustomTypeAdapterFactory +extends Object +implements com.google.gson.TypeAdapterFactory+
| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityDTO.html new file mode 100644 index 000000000..b396a6f69 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/CarbonIntensityDTO.html @@ -0,0 +1,715 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class CarbonIntensityDTO +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+CarbonIntensityDTO.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_CARBON_INTENSITY |
+
static String |
+SERIALIZED_NAME_END_TIME |
+
static String |
+SERIALIZED_NAME_LOCATION |
+
static String |
+SERIALIZED_NAME_START_TIME |
+
| Constructor and Description | +
|---|
CarbonIntensityDTO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
CarbonIntensityDTO |
+carbonIntensity(Double carbonIntensity) |
+
CarbonIntensityDTO |
+endTime(OffsetDateTime endTime) |
+
boolean |
+equals(Object o) |
+
static CarbonIntensityDTO |
+fromJson(String jsonString)
+Create an instance of CarbonIntensityDTO given an JSON string
+ |
+
Double |
+getCarbonIntensity()
+Value of the marginal carbon intensity in grams per kilowatt-hour.
+ |
+
OffsetDateTime |
+getEndTime()
+the time at which the workflow we are measuring carbon intensity for ended
+ |
+
String |
+getLocation()
+the location name where workflow is run
+ |
+
OffsetDateTime |
+getStartTime()
+the time at which the workflow we are measuring carbon intensity for started
+ |
+
int |
+hashCode() |
+
CarbonIntensityDTO |
+location(String location) |
+
void |
+setCarbonIntensity(Double carbonIntensity) |
+
void |
+setEndTime(OffsetDateTime endTime) |
+
void |
+setLocation(String location) |
+
void |
+setStartTime(OffsetDateTime startTime) |
+
CarbonIntensityDTO |
+startTime(OffsetDateTime startTime) |
+
String |
+toJson()
+Convert an instance of CarbonIntensityDTO to an JSON string
+ |
+
String |
+toString() |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
public static final String SERIALIZED_NAME_LOCATION+
public static final String SERIALIZED_NAME_START_TIME+
public static final String SERIALIZED_NAME_END_TIME+
public static final String SERIALIZED_NAME_CARBON_INTENSITY+
public CarbonIntensityDTO location(@Nullable + String location)+
@Nullable +public String getLocation()+
public CarbonIntensityDTO startTime(@Nullable + OffsetDateTime startTime)+
@Nullable +public OffsetDateTime getStartTime()+
public void setStartTime(@Nullable + OffsetDateTime startTime)+
public CarbonIntensityDTO endTime(@Nullable + OffsetDateTime endTime)+
@Nullable +public OffsetDateTime getEndTime()+
public void setEndTime(@Nullable + OffsetDateTime endTime)+
public CarbonIntensityDTO carbonIntensity(@Nullable + Double carbonIntensity)+
@Nullable +public Double getCarbonIntensity()+
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to CarbonIntensityDTOpublic static CarbonIntensityDTO fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to CarbonIntensityDTOpublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsData.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsData.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..0c68155e3 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsData.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +public static class EmissionsData.CustomTypeAdapterFactory +extends Object +implements com.google.gson.TypeAdapterFactory+
| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsData.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsData.html new file mode 100644 index 000000000..6df1c6869 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsData.html @@ -0,0 +1,715 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class EmissionsData +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+EmissionsData.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_DURATION |
+
static String |
+SERIALIZED_NAME_LOCATION |
+
static String |
+SERIALIZED_NAME_RATING |
+
static String |
+SERIALIZED_NAME_TIME |
+
| Constructor and Description | +
|---|
EmissionsData() |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsData |
+duration(String duration) |
+
boolean |
+equals(Object o) |
+
static EmissionsData |
+fromJson(String jsonString)
+Create an instance of EmissionsData given an JSON string
+ |
+
String |
+getDuration()
+Get duration
+ |
+
String |
+getLocation()
+Get location
+ |
+
Double |
+getRating()
+Get rating
+ |
+
OffsetDateTime |
+getTime()
+Get time
+ |
+
int |
+hashCode() |
+
EmissionsData |
+location(String location) |
+
EmissionsData |
+rating(Double rating) |
+
void |
+setDuration(String duration) |
+
void |
+setLocation(String location) |
+
void |
+setRating(Double rating) |
+
void |
+setTime(OffsetDateTime time) |
+
EmissionsData |
+time(OffsetDateTime time) |
+
String |
+toJson()
+Convert an instance of EmissionsData to an JSON string
+ |
+
String |
+toString() |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
public static final String SERIALIZED_NAME_LOCATION+
public static final String SERIALIZED_NAME_TIME+
public static final String SERIALIZED_NAME_RATING+
public static final String SERIALIZED_NAME_DURATION+
public EmissionsData location(@Nullable + String location)+
public EmissionsData time(@Nullable + OffsetDateTime time)+
@Nullable +public OffsetDateTime getTime()+
public void setTime(@Nullable + OffsetDateTime time)+
public EmissionsData rating(@Nullable + Double rating)+
public EmissionsData duration(@Nullable + String duration)+
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to EmissionsDatapublic static EmissionsData fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to EmissionsDatapublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsDataDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsDataDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..486efc871 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsDataDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +public static class EmissionsDataDTO.CustomTypeAdapterFactory +extends Object +implements com.google.gson.TypeAdapterFactory+
| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsDataDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsDataDTO.html new file mode 100644 index 000000000..599549100 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsDataDTO.html @@ -0,0 +1,715 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class EmissionsDataDTO +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+EmissionsDataDTO.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_DURATION |
+
static String |
+SERIALIZED_NAME_LOCATION |
+
static String |
+SERIALIZED_NAME_TIMESTAMP |
+
static String |
+SERIALIZED_NAME_VALUE |
+
| Constructor and Description | +
|---|
EmissionsDataDTO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsDataDTO |
+duration(Integer duration) |
+
boolean |
+equals(Object o) |
+
static EmissionsDataDTO |
+fromJson(String jsonString)
+Create an instance of EmissionsDataDTO given an JSON string
+ |
+
Integer |
+getDuration()
+Get duration
+ |
+
String |
+getLocation()
+Get location
+ |
+
OffsetDateTime |
+getTimestamp()
+Get timestamp
+ |
+
Double |
+getValue()
+Get value
+ |
+
int |
+hashCode() |
+
EmissionsDataDTO |
+location(String location) |
+
void |
+setDuration(Integer duration) |
+
void |
+setLocation(String location) |
+
void |
+setTimestamp(OffsetDateTime timestamp) |
+
void |
+setValue(Double value) |
+
EmissionsDataDTO |
+timestamp(OffsetDateTime timestamp) |
+
String |
+toJson()
+Convert an instance of EmissionsDataDTO to an JSON string
+ |
+
String |
+toString() |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
EmissionsDataDTO |
+value(Double value) |
+
public static final String SERIALIZED_NAME_LOCATION+
public static final String SERIALIZED_NAME_TIMESTAMP+
public static final String SERIALIZED_NAME_DURATION+
public static final String SERIALIZED_NAME_VALUE+
public EmissionsDataDTO location(@Nullable + String location)+
public EmissionsDataDTO timestamp(@Nullable + OffsetDateTime timestamp)+
@Nullable +public OffsetDateTime getTimestamp()+
public void setTimestamp(@Nullable + OffsetDateTime timestamp)+
public EmissionsDataDTO duration(@Nullable + Integer duration)+
public EmissionsDataDTO value(@Nullable + Double value)+
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to EmissionsDataDTOpublic static EmissionsDataDTO fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to EmissionsDataDTOpublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..fa77c6a27 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +public static class EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory +extends Object +implements com.google.gson.TypeAdapterFactory+
| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastBatchParametersDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastBatchParametersDTO.html new file mode 100644 index 000000000..9956853e2 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastBatchParametersDTO.html @@ -0,0 +1,781 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class EmissionsForecastBatchParametersDTO +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_DATA_END_AT |
+
static String |
+SERIALIZED_NAME_DATA_START_AT |
+
static String |
+SERIALIZED_NAME_LOCATION |
+
static String |
+SERIALIZED_NAME_REQUESTED_AT |
+
static String |
+SERIALIZED_NAME_WINDOW_SIZE |
+
| Constructor and Description | +
|---|
EmissionsForecastBatchParametersDTO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsForecastBatchParametersDTO |
+dataEndAt(OffsetDateTime dataEndAt) |
+
EmissionsForecastBatchParametersDTO |
+dataStartAt(OffsetDateTime dataStartAt) |
+
boolean |
+equals(Object o) |
+
static EmissionsForecastBatchParametersDTO |
+fromJson(String jsonString)
+Create an instance of EmissionsForecastBatchParametersDTO given an JSON string
+ |
+
OffsetDateTime |
+getDataEndAt()
+End time boundary of forecasted data points.
+ |
+
OffsetDateTime |
+getDataStartAt()
+Start time boundary of forecasted data points.Ignores current forecast data points before this time.
+ |
+
String |
+getLocation()
+The location of the forecast
+ |
+
OffsetDateTime |
+getRequestedAt()
+For historical forecast requests, this value is the timestamp used to access the most recently generated forecast as of that time.
+ |
+
Integer |
+getWindowSize()
+The estimated duration (in minutes) of the workload.
+ |
+
int |
+hashCode() |
+
EmissionsForecastBatchParametersDTO |
+location(String location) |
+
EmissionsForecastBatchParametersDTO |
+requestedAt(OffsetDateTime requestedAt) |
+
void |
+setDataEndAt(OffsetDateTime dataEndAt) |
+
void |
+setDataStartAt(OffsetDateTime dataStartAt) |
+
void |
+setLocation(String location) |
+
void |
+setRequestedAt(OffsetDateTime requestedAt) |
+
void |
+setWindowSize(Integer windowSize) |
+
String |
+toJson()
+Convert an instance of EmissionsForecastBatchParametersDTO to an JSON string
+ |
+
String |
+toString() |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
EmissionsForecastBatchParametersDTO |
+windowSize(Integer windowSize) |
+
public static final String SERIALIZED_NAME_REQUESTED_AT+
public static final String SERIALIZED_NAME_LOCATION+
public static final String SERIALIZED_NAME_DATA_START_AT+
public static final String SERIALIZED_NAME_DATA_END_AT+
public static final String SERIALIZED_NAME_WINDOW_SIZE+
public EmissionsForecastBatchParametersDTO()+
public EmissionsForecastBatchParametersDTO requestedAt(@Nullable + OffsetDateTime requestedAt)+
@Nullable +public OffsetDateTime getRequestedAt()+
public void setRequestedAt(@Nullable + OffsetDateTime requestedAt)+
public EmissionsForecastBatchParametersDTO location(@Nullable + String location)+
@Nullable +public String getLocation()+
public EmissionsForecastBatchParametersDTO dataStartAt(@Nullable + OffsetDateTime dataStartAt)+
@Nullable +public OffsetDateTime getDataStartAt()+
public void setDataStartAt(@Nullable + OffsetDateTime dataStartAt)+
public EmissionsForecastBatchParametersDTO dataEndAt(@Nullable + OffsetDateTime dataEndAt)+
@Nullable +public OffsetDateTime getDataEndAt()+
public void setDataEndAt(@Nullable + OffsetDateTime dataEndAt)+
public EmissionsForecastBatchParametersDTO windowSize(@Nullable + Integer windowSize)+
@Nullable +public Integer getWindowSize()+
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to EmissionsForecastBatchParametersDTOpublic static EmissionsForecastBatchParametersDTO fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to EmissionsForecastBatchParametersDTOpublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..d5864960c --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +public static class EmissionsForecastDTO.CustomTypeAdapterFactory +extends Object +implements com.google.gson.TypeAdapterFactory+
| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastDTO.html new file mode 100644 index 000000000..25c513dda --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/EmissionsForecastDTO.html @@ -0,0 +1,1005 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class EmissionsForecastDTO +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+EmissionsForecastDTO.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_DATA_END_AT |
+
static String |
+SERIALIZED_NAME_DATA_START_AT |
+
static String |
+SERIALIZED_NAME_FORECAST_DATA |
+
static String |
+SERIALIZED_NAME_GENERATED_AT |
+
static String |
+SERIALIZED_NAME_LOCATION |
+
static String |
+SERIALIZED_NAME_OPTIMAL_DATA_POINTS |
+
static String |
+SERIALIZED_NAME_REQUESTED_AT |
+
static String |
+SERIALIZED_NAME_WINDOW_SIZE |
+
| Constructor and Description | +
|---|
EmissionsForecastDTO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsForecastDTO |
+addForecastDataItem(EmissionsDataDTO forecastDataItem) |
+
EmissionsForecastDTO |
+addOptimalDataPointsItem(EmissionsDataDTO optimalDataPointsItem) |
+
EmissionsForecastDTO |
+dataEndAt(OffsetDateTime dataEndAt) |
+
EmissionsForecastDTO |
+dataStartAt(OffsetDateTime dataStartAt) |
+
boolean |
+equals(Object o) |
+
EmissionsForecastDTO |
+forecastData(List<EmissionsDataDTO> forecastData) |
+
static EmissionsForecastDTO |
+fromJson(String jsonString)
+Create an instance of EmissionsForecastDTO given an JSON string
+ |
+
EmissionsForecastDTO |
+generatedAt(OffsetDateTime generatedAt) |
+
OffsetDateTime |
+getDataEndAt()
+End time boundary of forecasted data points.
+ |
+
OffsetDateTime |
+getDataStartAt()
+Start time boundary of forecasted data points.
+ |
+
List<EmissionsDataDTO> |
+getForecastData()
+The forecasted data points transformed and filtered to reflect the specified time and window parameters.
+ |
+
OffsetDateTime |
+getGeneratedAt()
+Timestamp when the forecast was generated.
+ |
+
String |
+getLocation()
+The location of the forecast
+ |
+
List<EmissionsDataDTO> |
+getOptimalDataPoints()
+The optimal forecasted data point within the 'forecastData' array.
+ |
+
OffsetDateTime |
+getRequestedAt()
+For current requests, this value is the timestamp the request for forecast data was made.
+ |
+
Integer |
+getWindowSize()
+The estimated duration (in minutes) of the workload.
+ |
+
int |
+hashCode() |
+
EmissionsForecastDTO |
+location(String location) |
+
EmissionsForecastDTO |
+optimalDataPoints(List<EmissionsDataDTO> optimalDataPoints) |
+
EmissionsForecastDTO |
+requestedAt(OffsetDateTime requestedAt) |
+
void |
+setDataEndAt(OffsetDateTime dataEndAt) |
+
void |
+setDataStartAt(OffsetDateTime dataStartAt) |
+
void |
+setForecastData(List<EmissionsDataDTO> forecastData) |
+
void |
+setGeneratedAt(OffsetDateTime generatedAt) |
+
void |
+setLocation(String location) |
+
void |
+setOptimalDataPoints(List<EmissionsDataDTO> optimalDataPoints) |
+
void |
+setRequestedAt(OffsetDateTime requestedAt) |
+
void |
+setWindowSize(Integer windowSize) |
+
String |
+toJson()
+Convert an instance of EmissionsForecastDTO to an JSON string
+ |
+
String |
+toString() |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
EmissionsForecastDTO |
+windowSize(Integer windowSize) |
+
public static final String SERIALIZED_NAME_GENERATED_AT+
public static final String SERIALIZED_NAME_REQUESTED_AT+
public static final String SERIALIZED_NAME_LOCATION+
public static final String SERIALIZED_NAME_DATA_START_AT+
public static final String SERIALIZED_NAME_DATA_END_AT+
public static final String SERIALIZED_NAME_WINDOW_SIZE+
public static final String SERIALIZED_NAME_OPTIMAL_DATA_POINTS+
public static final String SERIALIZED_NAME_FORECAST_DATA+
public EmissionsForecastDTO generatedAt(@Nullable + OffsetDateTime generatedAt)+
@Nullable +public OffsetDateTime getGeneratedAt()+
public void setGeneratedAt(@Nullable + OffsetDateTime generatedAt)+
public EmissionsForecastDTO requestedAt(@Nullable + OffsetDateTime requestedAt)+
@Nullable +public OffsetDateTime getRequestedAt()+
public void setRequestedAt(@Nullable + OffsetDateTime requestedAt)+
public EmissionsForecastDTO location(@Nullable + String location)+
@Nullable +public String getLocation()+
public EmissionsForecastDTO dataStartAt(@Nullable + OffsetDateTime dataStartAt)+
@Nullable +public OffsetDateTime getDataStartAt()+
public void setDataStartAt(@Nullable + OffsetDateTime dataStartAt)+
public EmissionsForecastDTO dataEndAt(@Nullable + OffsetDateTime dataEndAt)+
@Nullable +public OffsetDateTime getDataEndAt()+
public void setDataEndAt(@Nullable + OffsetDateTime dataEndAt)+
public EmissionsForecastDTO windowSize(@Nullable + Integer windowSize)+
@Nullable +public Integer getWindowSize()+
public EmissionsForecastDTO optimalDataPoints(@Nullable + List<EmissionsDataDTO> optimalDataPoints)+
public EmissionsForecastDTO addOptimalDataPointsItem(EmissionsDataDTO optimalDataPointsItem)+
@Nullable +public List<EmissionsDataDTO> getOptimalDataPoints()+
public void setOptimalDataPoints(@Nullable + List<EmissionsDataDTO> optimalDataPoints)+
public EmissionsForecastDTO forecastData(@Nullable + List<EmissionsDataDTO> forecastData)+
public EmissionsForecastDTO addForecastDataItem(EmissionsDataDTO forecastDataItem)+
@Nullable +public List<EmissionsDataDTO> getForecastData()+
public void setForecastData(@Nullable + List<EmissionsDataDTO> forecastData)+
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to EmissionsForecastDTOpublic static EmissionsForecastDTO fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to EmissionsForecastDTOpublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/Location.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/Location.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..77ea08944 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/Location.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/Location.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/Location.html new file mode 100644 index 000000000..c97993975 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/Location.html @@ -0,0 +1,649 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class Location +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+Location.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_LATITUDE |
+
static String |
+SERIALIZED_NAME_LONGITUDE |
+
static String |
+SERIALIZED_NAME_NAME |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
static Location |
+fromJson(String jsonString)
+Create an instance of Location given an JSON string
+ |
+
Double |
+getLatitude()
+Get latitude
+ |
+
Double |
+getLongitude()
+Get longitude
+ |
+
String |
+getName()
+Get name
+ |
+
int |
+hashCode() |
+
Location |
+latitude(Double latitude) |
+
Location |
+longitude(Double longitude) |
+
Location |
+name(String name) |
+
void |
+setLatitude(Double latitude) |
+
void |
+setLongitude(Double longitude) |
+
void |
+setName(String name) |
+
String |
+toJson()
+Convert an instance of Location to an JSON string
+ |
+
String |
+toString() |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
public static final String SERIALIZED_NAME_LATITUDE+
public static final String SERIALIZED_NAME_LONGITUDE+
public static final String SERIALIZED_NAME_NAME+
@Nullable +public Double getLongitude()+
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to Locationpublic static Location fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to Locationpublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/ValidationProblemDetails.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/ValidationProblemDetails.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..6b92bd3f3 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/ValidationProblemDetails.CustomTypeAdapterFactory.html @@ -0,0 +1,288 @@ + + + + + + +public static class ValidationProblemDetails.CustomTypeAdapterFactory +extends Object +implements com.google.gson.TypeAdapterFactory+
| Constructor and Description | +
|---|
CustomTypeAdapterFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> com.google.gson.TypeAdapter<T> |
+create(com.google.gson.Gson gson,
+ com.google.gson.reflect.TypeToken<T> type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/ValidationProblemDetails.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/ValidationProblemDetails.html new file mode 100644 index 000000000..577945302 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/ValidationProblemDetails.html @@ -0,0 +1,930 @@ + + + + + + +@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", + date="2024-12-10T13:04:03.426567630Z[Etc/UTC]", + comments="Generator version: 7.10.0") +public class ValidationProblemDetails +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+ValidationProblemDetails.CustomTypeAdapterFactory |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HashSet<String> |
+openapiFields |
+
static HashSet<String> |
+openapiRequiredFields |
+
static String |
+SERIALIZED_NAME_DETAIL |
+
static String |
+SERIALIZED_NAME_ERRORS |
+
static String |
+SERIALIZED_NAME_INSTANCE |
+
static String |
+SERIALIZED_NAME_STATUS |
+
static String |
+SERIALIZED_NAME_TITLE |
+
static String |
+SERIALIZED_NAME_TYPE |
+
| Constructor and Description | +
|---|
ValidationProblemDetails() |
+
| Modifier and Type | +Method and Description | +
|---|---|
ValidationProblemDetails |
+detail(String detail) |
+
boolean |
+equals(Object o) |
+
ValidationProblemDetails |
+errors(Map<String,List<String>> errors) |
+
static ValidationProblemDetails |
+fromJson(String jsonString)
+Create an instance of ValidationProblemDetails given an JSON string
+ |
+
Map<String,Object> |
+getAdditionalProperties()
+Return the additional (undeclared) property.
+ |
+
Object |
+getAdditionalProperty(String key)
+Return the additional (undeclared) property with the specified name.
+ |
+
String |
+getDetail()
+Get detail
+ |
+
Map<String,List<String>> |
+getErrors()
+Get errors
+ |
+
String |
+getInstance()
+Get instance
+ |
+
Integer |
+getStatus()
+Get status
+ |
+
String |
+getTitle()
+Get title
+ |
+
String |
+getType()
+Get type
+ |
+
int |
+hashCode() |
+
ValidationProblemDetails |
+instance(String instance) |
+
ValidationProblemDetails |
+putAdditionalProperty(String key,
+ Object value)
+Set the additional (undeclared) property with the specified name and value.
+ |
+
ValidationProblemDetails |
+putErrorsItem(String key,
+ List<String> errorsItem) |
+
void |
+setDetail(String detail) |
+
void |
+setErrors(Map<String,List<String>> errors) |
+
void |
+setInstance(String instance) |
+
void |
+setStatus(Integer status) |
+
void |
+setTitle(String title) |
+
void |
+setType(String type) |
+
ValidationProblemDetails |
+status(Integer status) |
+
ValidationProblemDetails |
+title(String title) |
+
String |
+toJson()
+Convert an instance of ValidationProblemDetails to an JSON string
+ |
+
String |
+toString() |
+
ValidationProblemDetails |
+type(String type) |
+
static void |
+validateJsonElement(com.google.gson.JsonElement jsonElement)
+Validates the JSON Element and throws an exception if issues found
+ |
+
public static final String SERIALIZED_NAME_TYPE+
public static final String SERIALIZED_NAME_TITLE+
public static final String SERIALIZED_NAME_STATUS+
public static final String SERIALIZED_NAME_DETAIL+
public static final String SERIALIZED_NAME_INSTANCE+
public static final String SERIALIZED_NAME_ERRORS+
public ValidationProblemDetails()+
public ValidationProblemDetails type(@Nullable + String type)+
public ValidationProblemDetails title(@Nullable + String title)+
public ValidationProblemDetails status(@Nullable + Integer status)+
public ValidationProblemDetails detail(@Nullable + String detail)+
public ValidationProblemDetails instance(@Nullable + String instance)+
public ValidationProblemDetails putErrorsItem(String key, + List<String> errorsItem)+
@Nullable +public Map<String,List<String>> getErrors()+
public ValidationProblemDetails putAdditionalProperty(String key, + Object value)+
key - name of the propertyvalue - value of the propertypublic Map<String,Object> getAdditionalProperties()+
public Object getAdditionalProperty(String key)+
key - name of the propertypublic static void validateJsonElement(com.google.gson.JsonElement jsonElement) + throws IOException+
jsonElement - JSON ElementIOException - if the JSON Element is invalid with respect to ValidationProblemDetailspublic static ValidationProblemDetails fromJson(String jsonString) + throws IOException+
jsonString - JSON stringIOException - if the JSON string is invalid with respect to ValidationProblemDetailspublic String toJson()+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/AbstractOpenApiSchema.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/AbstractOpenApiSchema.html new file mode 100644 index 000000000..f61c22f00 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/AbstractOpenApiSchema.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..077601d58 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityBatchParametersDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityBatchParametersDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityBatchParametersDTO.html new file mode 100644 index 000000000..089a4e691 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityBatchParametersDTO.html @@ -0,0 +1,224 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
List<CarbonIntensityDTO> |
+CarbonAwareApi.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 |
+CarbonAwareApi.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 |
+CarbonAwareApi.getAverageCarbonIntensityBatchCall(List<CarbonIntensityBatchParametersDTO> carbonIntensityBatchParametersDTO,
+ ApiCallback _callback)
+Build call for getAverageCarbonIntensityBatch
+ |
+
ApiResponse<List<CarbonIntensityDTO>> |
+CarbonAwareApi.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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CarbonIntensityBatchParametersDTO |
+CarbonIntensityBatchParametersDTO.endTime(OffsetDateTime endTime) |
+
static CarbonIntensityBatchParametersDTO |
+CarbonIntensityBatchParametersDTO.fromJson(String jsonString)
+Create an instance of CarbonIntensityBatchParametersDTO given an JSON string
+ |
+
CarbonIntensityBatchParametersDTO |
+CarbonIntensityBatchParametersDTO.location(String location) |
+
CarbonIntensityBatchParametersDTO |
+CarbonIntensityBatchParametersDTO.startTime(OffsetDateTime startTime) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..585bb1dec --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityDTO.html new file mode 100644 index 000000000..f26d0475c --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/CarbonIntensityDTO.html @@ -0,0 +1,264 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
CarbonIntensityDTO |
+CarbonAwareApi.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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<CarbonIntensityDTO> |
+CarbonAwareApi.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.
+ |
+
ApiResponse<List<CarbonIntensityDTO>> |
+CarbonAwareApi.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.
+ |
+
ApiResponse<CarbonIntensityDTO> |
+CarbonAwareApi.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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+CarbonAwareApi.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.
+ |
+
okhttp3.Call |
+CarbonAwareApi.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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CarbonIntensityDTO |
+CarbonIntensityDTO.carbonIntensity(Double carbonIntensity) |
+
CarbonIntensityDTO |
+CarbonIntensityDTO.endTime(OffsetDateTime endTime) |
+
static CarbonIntensityDTO |
+CarbonIntensityDTO.fromJson(String jsonString)
+Create an instance of CarbonIntensityDTO given an JSON string
+ |
+
CarbonIntensityDTO |
+CarbonIntensityDTO.location(String location) |
+
CarbonIntensityDTO |
+CarbonIntensityDTO.startTime(OffsetDateTime startTime) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsData.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsData.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..14ef146c1 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsData.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsData.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsData.html new file mode 100644 index 000000000..51c197eb7 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsData.html @@ -0,0 +1,286 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
List<EmissionsData> |
+CarbonAwareApi.getBestEmissionsDataForLocationsByTime(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by list of locations for a specified time period.
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getBestEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by list of locations for a specified time period.
+ |
+
List<EmissionsData> |
+CarbonAwareApi.getEmissionsDataForLocationByTime(String location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by location for a specified time period.
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getEmissionsDataForLocationByTimeWithHttpInfo(String location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the best emission data by location for a specified time period.
+ |
+
List<EmissionsData> |
+CarbonAwareApi.getEmissionsDataForLocationsByTime(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the observed emission data by list of locations for a specified time period.
+ |
+
ApiResponse<List<EmissionsData>> |
+CarbonAwareApi.getEmissionsDataForLocationsByTimeWithHttpInfo(List<String> location,
+ OffsetDateTime time,
+ OffsetDateTime toTime)
+Calculate the observed emission data by list of locations for a specified time period.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.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 |
+CarbonAwareApi.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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsData |
+EmissionsData.duration(String duration) |
+
static EmissionsData |
+EmissionsData.fromJson(String jsonString)
+Create an instance of EmissionsData given an JSON string
+ |
+
EmissionsData |
+EmissionsData.location(String location) |
+
EmissionsData |
+EmissionsData.rating(Double rating) |
+
EmissionsData |
+EmissionsData.time(OffsetDateTime time) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsDataDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsDataDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..5da66256b --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsDataDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsDataDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsDataDTO.html new file mode 100644 index 000000000..9816190ed --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsDataDTO.html @@ -0,0 +1,247 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsDataDTO |
+EmissionsDataDTO.duration(Integer duration) |
+
static EmissionsDataDTO |
+EmissionsDataDTO.fromJson(String jsonString)
+Create an instance of EmissionsDataDTO given an JSON string
+ |
+
EmissionsDataDTO |
+EmissionsDataDTO.location(String location) |
+
EmissionsDataDTO |
+EmissionsDataDTO.timestamp(OffsetDateTime timestamp) |
+
EmissionsDataDTO |
+EmissionsDataDTO.value(Double value) |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<EmissionsDataDTO> |
+EmissionsForecastDTO.getForecastData()
+The forecasted data points transformed and filtered to reflect the specified time and window parameters.
+ |
+
List<EmissionsDataDTO> |
+EmissionsForecastDTO.getOptimalDataPoints()
+The optimal forecasted data point within the 'forecastData' array.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsForecastDTO |
+EmissionsForecastDTO.addForecastDataItem(EmissionsDataDTO forecastDataItem) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.addOptimalDataPointsItem(EmissionsDataDTO optimalDataPointsItem) |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsForecastDTO |
+EmissionsForecastDTO.forecastData(List<EmissionsDataDTO> forecastData) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.optimalDataPoints(List<EmissionsDataDTO> optimalDataPoints) |
+
void |
+EmissionsForecastDTO.setForecastData(List<EmissionsDataDTO> forecastData) |
+
void |
+EmissionsForecastDTO.setOptimalDataPoints(List<EmissionsDataDTO> optimalDataPoints) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..7219d5bc8 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastBatchParametersDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastBatchParametersDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastBatchParametersDTO.html new file mode 100644 index 000000000..d78db596f --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastBatchParametersDTO.html @@ -0,0 +1,232 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
List<EmissionsForecastDTO> |
+CarbonAwareApi.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 |
+CarbonAwareApi.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 |
+CarbonAwareApi.batchForecastDataAsyncCall(List<EmissionsForecastBatchParametersDTO> emissionsForecastBatchParametersDTO,
+ ApiCallback _callback)
+Build call for batchForecastDataAsync
+ |
+
ApiResponse<List<EmissionsForecastDTO>> |
+CarbonAwareApi.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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsForecastBatchParametersDTO |
+EmissionsForecastBatchParametersDTO.dataEndAt(OffsetDateTime dataEndAt) |
+
EmissionsForecastBatchParametersDTO |
+EmissionsForecastBatchParametersDTO.dataStartAt(OffsetDateTime dataStartAt) |
+
static EmissionsForecastBatchParametersDTO |
+EmissionsForecastBatchParametersDTO.fromJson(String jsonString)
+Create an instance of EmissionsForecastBatchParametersDTO given an JSON string
+ |
+
EmissionsForecastBatchParametersDTO |
+EmissionsForecastBatchParametersDTO.location(String location) |
+
EmissionsForecastBatchParametersDTO |
+EmissionsForecastBatchParametersDTO.requestedAt(OffsetDateTime requestedAt) |
+
EmissionsForecastBatchParametersDTO |
+EmissionsForecastBatchParametersDTO.windowSize(Integer windowSize) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastDTO.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastDTO.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..e753762a0 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastDTO.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastDTO.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastDTO.html new file mode 100644 index 000000000..e09354946 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/EmissionsForecastDTO.html @@ -0,0 +1,282 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
List<EmissionsForecastDTO> |
+CarbonAwareApi.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.
+ |
+
ApiResponse<List<EmissionsForecastDTO>> |
+CarbonAwareApi.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.
+ |
+
List<EmissionsForecastDTO> |
+CarbonAwareApi.getCurrentForecastData(List<String> location,
+ OffsetDateTime dataStartAt,
+ OffsetDateTime dataEndAt,
+ Integer windowSize)
+Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
+ |
+
ApiResponse<List<EmissionsForecastDTO>> |
+CarbonAwareApi.getCurrentForecastDataWithHttpInfo(List<String> location,
+ OffsetDateTime dataStartAt,
+ OffsetDateTime dataEndAt,
+ Integer windowSize)
+Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+CarbonAwareApi.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 |
+CarbonAwareApi.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.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
EmissionsForecastDTO |
+EmissionsForecastDTO.addForecastDataItem(EmissionsDataDTO forecastDataItem) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.addOptimalDataPointsItem(EmissionsDataDTO optimalDataPointsItem) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.dataEndAt(OffsetDateTime dataEndAt) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.dataStartAt(OffsetDateTime dataStartAt) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.forecastData(List<EmissionsDataDTO> forecastData) |
+
static EmissionsForecastDTO |
+EmissionsForecastDTO.fromJson(String jsonString)
+Create an instance of EmissionsForecastDTO given an JSON string
+ |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.generatedAt(OffsetDateTime generatedAt) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.location(String location) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.optimalDataPoints(List<EmissionsDataDTO> optimalDataPoints) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.requestedAt(OffsetDateTime requestedAt) |
+
EmissionsForecastDTO |
+EmissionsForecastDTO.windowSize(Integer windowSize) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/Location.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/Location.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..2449f77c4 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/Location.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/Location.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/Location.html new file mode 100644 index 000000000..24ee0a0ae --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/Location.html @@ -0,0 +1,225 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Map<String,Location> |
+LocationsApi.getAllLocations()
+Get all locations instances
+ |
+
ApiResponse<Map<String,Location>> |
+LocationsApi.getAllLocationsWithHttpInfo()
+Get all locations instances
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
okhttp3.Call |
+LocationsApi.getAllLocationsAsync(ApiCallback<Map<String,Location>> _callback)
+Get all locations instances (asynchronously)
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Location |
+Location.fromJson(String jsonString)
+Create an instance of Location given an JSON string
+ |
+
Location |
+Location.latitude(Double latitude) |
+
Location |
+Location.longitude(Double longitude) |
+
Location |
+Location.name(String name) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/ValidationProblemDetails.CustomTypeAdapterFactory.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/ValidationProblemDetails.CustomTypeAdapterFactory.html new file mode 100644 index 000000000..dd29ebdf8 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/ValidationProblemDetails.CustomTypeAdapterFactory.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/ValidationProblemDetails.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/ValidationProblemDetails.html new file mode 100644 index 000000000..012bc571a --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/class-use/ValidationProblemDetails.html @@ -0,0 +1,204 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.openapitools.client.model | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ValidationProblemDetails |
+ValidationProblemDetails.detail(String detail) |
+
ValidationProblemDetails |
+ValidationProblemDetails.errors(Map<String,List<String>> errors) |
+
static ValidationProblemDetails |
+ValidationProblemDetails.fromJson(String jsonString)
+Create an instance of ValidationProblemDetails given an JSON string
+ |
+
ValidationProblemDetails |
+ValidationProblemDetails.instance(String instance) |
+
ValidationProblemDetails |
+ValidationProblemDetails.putAdditionalProperty(String key,
+ Object value)
+Set the additional (undeclared) property with the specified name and value.
+ |
+
ValidationProblemDetails |
+ValidationProblemDetails.putErrorsItem(String key,
+ List<String> errorsItem) |
+
ValidationProblemDetails |
+ValidationProblemDetails.status(Integer status) |
+
ValidationProblemDetails |
+ValidationProblemDetails.title(String title) |
+
ValidationProblemDetails |
+ValidationProblemDetails.type(String type) |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-frame.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-frame.html new file mode 100644 index 000000000..515a5e040 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-frame.html @@ -0,0 +1,37 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-tree.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-tree.html new file mode 100644 index 000000000..7c894b2a7 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-use.html b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-use.html new file mode 100644 index 000000000..419049eaa --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/org/openapitools/client/model/package-use.html @@ -0,0 +1,242 @@ + + + + + + +| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
| Class and Description | +
|---|
| CarbonIntensityBatchParametersDTO
+ CarbonIntensityBatchParametersDTO
+ |
+
| CarbonIntensityDTO
+ CarbonIntensityDTO
+ |
+
| EmissionsData
+ EmissionsData
+ |
+
| EmissionsForecastBatchParametersDTO
+ EmissionsForecastBatchParametersDTO
+ |
+
| EmissionsForecastDTO
+ EmissionsForecastDTO
+ |
+
| Location
+ Location
+ |
+
| Class and Description | +
|---|
| CarbonIntensityBatchParametersDTO
+ CarbonIntensityBatchParametersDTO
+ |
+
| CarbonIntensityDTO
+ CarbonIntensityDTO
+ |
+
| EmissionsData
+ EmissionsData
+ |
+
| EmissionsDataDTO
+ EmissionsDataDTO
+ |
+
| EmissionsForecastBatchParametersDTO
+ EmissionsForecastBatchParametersDTO
+ |
+
| EmissionsForecastDTO
+ EmissionsForecastDTO
+ |
+
| Location
+ Location
+ |
+
| ValidationProblemDetails
+ ValidationProblemDetails
+ |
+
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/overview-frame.html b/casdk-docs/static/client-apidocs/1.0.0/java/overview-frame.html new file mode 100644 index 000000000..bf0bfee84 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/overview-frame.html @@ -0,0 +1,25 @@ + + + + + + ++ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/overview-summary.html b/casdk-docs/static/client-apidocs/1.0.0/java/overview-summary.html new file mode 100644 index 000000000..a90dfc988 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/overview-summary.html @@ -0,0 +1,152 @@ + + + + + + +
| Package | +Description | +
|---|---|
| foundation.greensoftware.carbonaware.webapi | ++ |
| foundation.greensoftware.carbonaware.webapi.auth | ++ |
| foundation.greensoftware.carbonaware.webapi.client | ++ |
| org.openapitools.client.model | ++ |
Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/overview-tree.html b/casdk-docs/static/client-apidocs/1.0.0/java/overview-tree.html new file mode 100644 index 000000000..87627ce44 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/overview-tree.html @@ -0,0 +1,204 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/package-list b/casdk-docs/static/client-apidocs/1.0.0/java/package-list new file mode 100644 index 000000000..a4ef7bd61 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/package-list @@ -0,0 +1,4 @@ +foundation.greensoftware.carbonaware.webapi +foundation.greensoftware.carbonaware.webapi.auth +foundation.greensoftware.carbonaware.webapi.client +org.openapitools.client.model diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/script.js b/casdk-docs/static/client-apidocs/1.0.0/java/script.js new file mode 100644 index 000000000..b34635693 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/serialized-form.html b/casdk-docs/static/client-apidocs/1.0.0/java/serialized-form.html new file mode 100644 index 000000000..f53934b0b --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/serialized-form.html @@ -0,0 +1,162 @@ + + + + + + +Copyright © 2024. All rights reserved.
+ + diff --git a/casdk-docs/static/client-apidocs/1.0.0/java/stylesheet.css b/casdk-docs/static/client-apidocs/1.0.0/java/stylesheet.css new file mode 100644 index 000000000..98055b22d --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/java/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/casdk-docs/static/client-apidocs/1.0.0/npm/assets/hierarchy.js b/casdk-docs/static/client-apidocs/1.0.0/npm/assets/hierarchy.js new file mode 100644 index 000000000..fb85f0adc --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/npm/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg==" \ No newline at end of file diff --git a/casdk-docs/static/client-apidocs/1.0.0/npm/assets/highlight.css b/casdk-docs/static/client-apidocs/1.0.0/npm/assets/highlight.css new file mode 100644 index 000000000..8282fb3e7 --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/npm/assets/highlight.css @@ -0,0 +1,50 @@ +:root { + --light-hl-0: #001080; + --dark-hl-0: #9CDCFE; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #098658; + --dark-hl-2: #B5CEA8; + --light-hl-3: #0070C1; + --dark-hl-3: #4FC1FF; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +pre, code { background: var(--code-background); } diff --git a/casdk-docs/static/client-apidocs/1.0.0/npm/assets/icons.js b/casdk-docs/static/client-apidocs/1.0.0/npm/assets/icons.js new file mode 100644 index 000000000..58882d76d --- /dev/null +++ b/casdk-docs/static/client-apidocs/1.0.0/npm/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `Optionalconfiguration: ConfigurationThis 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.
+OptionalemissionsForecastBatchParametersDTO: EmissionsForecastBatchParametersDTO[]Array of requested forecasts.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.
+The location name where workflow is run
+The time at which the workflow we are measuring carbon intensity for started
+The time at which the workflow we are measuring carbon intensity for ended
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+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.
+OptionalcarbonIntensityBatchParametersDTO: CarbonIntensityBatchParametersDTO[]Array of inputs where each contains a "location", "startDate", and "endDate" for which to calculate average marginal carbon intensity.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String array of named locations
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+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.
+String array of named locations
+OptionaldataStartAt: stringStart time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data.
+OptionaldataEndAt: stringEnd time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data.
+OptionalwindowSize: numberThe estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String named location.
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String array of named locations
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+Optionalaccessparameter for oauth2 security
+Optionalapiparameter for apiKey security
+Optionalbasebase options for axios calls
+Optionalbaseoverride base path
+OptionalformThe FormData constructor that will be used to create multipart form data +requests. You can inject this here so that execution environments that +do not support the FormData class can still run the generated client.
+The FormData constructor that will be used to create multipart form data +requests. You can inject this here so that execution environments that +do not support the FormData class can still run the generated client.
+Optionalpasswordparameter for basic security
+Optionalserveroverride server index
+Optionalusernameparameter for basic security
+Check if the given MIME is a JSON MIME. +JSON MIME examples: +application/json +application/json; charset=UTF8 +APPLICATION/JSON +application/vnd.company+json
+MIME (Multipurpose Internet Mail Extensions)
+True if the given MIME is JSON, false otherwise.
+LocationsApi - object-oriented interface
+Optionalconfiguration: ConfigurationCarbonAwareApi - axios parameter creator
+Optionalconfiguration: ConfigurationThis 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.
+This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.
+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.
+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.
+CarbonAwareApi - factory interface
+Optionalconfiguration: ConfigurationOptionalbasePath: stringOptionalaxios: AxiosInstanceThis 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.
+OptionalemissionsForecastBatchParametersDTO: EmissionsForecastBatchParametersDTO[]Array of requested forecasts.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.
+The location name where workflow is run
+The time at which the workflow we are measuring carbon intensity for started
+The time at which the workflow we are measuring carbon intensity for ended
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+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.
+OptionalcarbonIntensityBatchParametersDTO: CarbonIntensityBatchParametersDTO[]Array of inputs where each contains a "location", "startDate", and "endDate" for which to calculate average marginal carbon intensity.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String array of named locations
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+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.
+String array of named locations
+OptionaldataStartAt: stringStart time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data.
+OptionaldataEndAt: stringEnd time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data.
+OptionalwindowSize: numberThe estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String named location.
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String array of named locations
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+CarbonAwareApi - functional programming interface
+Optionalconfiguration: ConfigurationThis 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.
+OptionalemissionsForecastBatchParametersDTO: EmissionsForecastBatchParametersDTO[]Array of requested forecasts.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.
+The location name where workflow is run
+The time at which the workflow we are measuring carbon intensity for started
+The time at which the workflow we are measuring carbon intensity for ended
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+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.
+OptionalcarbonIntensityBatchParametersDTO: CarbonIntensityBatchParametersDTO[]Array of inputs where each contains a "location", "startDate", and "endDate" for which to calculate average marginal carbon intensity.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String array of named locations
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+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.
+String array of named locations
+OptionaldataStartAt: stringStart time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data.
+OptionaldataEndAt: stringEnd time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data.
+OptionalwindowSize: numberThe estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String named location.
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+String array of named locations
+Optionaltime: string[Optional] Start time for the data query.
+OptionaltoTime: string[Optional] End time for the data query.
+Optionaloptions: RawAxiosRequestConfigOverride http request option.
+LocationsApi - axios parameter creator
+Optionalconfiguration: ConfigurationLocationsApi - factory interface
+Optionalconfiguration: ConfigurationOptionalbasePath: stringOptionalaxios: AxiosInstanceLocationsApi - functional programming interface
+Optionalconfiguration: ConfigurationOptionaloptions: RawAxiosRequestConfigOverride http request option.
+This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
+Environment
+Language level
+Module system
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
To build and compile the typescript sources to javascript use:
+npm install
npm run build
+First build the package then run npm publish
navigate to the folder of your consuming project and run one of the following commands.
+published:
+npm install @YaSuenag/casdk-client@1.0.0 --save
+unPublished (not recommended):
+npm install PATH_TO_GENERATED_PACKAGE --save
+OptionalendThe time at which the workflow we are measuring carbon intensity for ended
+OptionallocationThe location name where workflow is run
+OptionalstartThe time at which the workflow we are measuring carbon intensity for started
+OptionalcarbonValue of the marginal carbon intensity in grams per kilowatt-hour.
+Optionalendthe time at which the workflow we are measuring carbon intensity for ended
+Optionallocationthe location name where workflow is run
+Optionalstartthe time at which the workflow we are measuring carbon intensity for started
+CarbonAware.WebAPI +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+The version of the OpenAPI document: 1.0.0
+NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). +https://openapi-generator.tech +Do not edit the class manually.
+OptionalaccessOptionalapiOptionalbaseOptionalbaseOptionalformOptionalpasswordOptionalserverOptionalusernameOptionaldataEnd time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data.
+OptionaldataStart time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data.
+OptionallocationThe location of the forecast
+OptionalrequestedFor historical forecast requests, this value is the timestamp used to access the most recently generated forecast as of that time.
+OptionalwindowThe estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.
+OptionaldataEnd time boundary of forecasted data points. Ignores forecast data points after this time. Defaults to the latest time in the forecast data.
+OptionaldataStart time boundary of forecasted data points. Ignores forecast data points before this time. Defaults to the earliest time in the forecast data.
+OptionalforecastThe forecasted data points transformed and filtered to reflect the specified time and window parameters. Points are ordered chronologically; Empty array if all data points were filtered out. E.G. dataStartAt and dataEndAt times outside the forecast period; windowSize greater than total duration of forecast data;
+OptionalgeneratedTimestamp when the forecast was generated.
+OptionallocationThe location of the forecast
+OptionaloptimalThe optimal forecasted data point within the 'forecastData' array. Null if 'forecastData' array is empty.
+OptionalrequestedFor current requests, this value is the timestamp the request for forecast data was made. For historical forecast requests, this value is the timestamp used to access the most recently generated forecast as of that time.
+OptionalwindowThe estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.
+
CarbonAwareApi - object-oriented interface
+Export
CarbonAwareApi
+