public class TaskLocalVariableApi extends Object
Constructor and Description |
---|
TaskLocalVariableApi() |
TaskLocalVariableApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
void |
deleteTaskLocalVariable(String id,
String varName)
Delete Local Task Variable
Removes a local variable from a task by id.
|
okhttp3.Call |
deleteTaskLocalVariableAsync(String id,
String varName,
ApiCallback<Void> _callback)
Delete Local Task Variable (asynchronously)
Removes a local variable from a task by id.
|
okhttp3.Call |
deleteTaskLocalVariableCall(String id,
String varName,
ApiCallback _callback)
Build call for deleteTaskLocalVariable
|
ApiResponse<Void> |
deleteTaskLocalVariableWithHttpInfo(String id,
String varName)
Delete Local Task Variable
Removes a local variable from a task by id.
|
ApiClient |
getApiClient() |
VariableValueDto |
getTaskLocalVariable(String id,
String varName,
Boolean deserializeValue)
Get Local Task Variable
Retrieves a variable from the context of a given task by id.
|
okhttp3.Call |
getTaskLocalVariableAsync(String id,
String varName,
Boolean deserializeValue,
ApiCallback<VariableValueDto> _callback)
Get Local Task Variable (asynchronously)
Retrieves a variable from the context of a given task by id.
|
File |
getTaskLocalVariableBinary(String id,
String varName)
Get Local Task Variable (Binary)
Retrieves a binary variable from the context of a given task by id.
|
okhttp3.Call |
getTaskLocalVariableBinaryAsync(String id,
String varName,
ApiCallback<File> _callback)
Get Local Task Variable (Binary) (asynchronously)
Retrieves a binary variable from the context of a given task by id.
|
okhttp3.Call |
getTaskLocalVariableBinaryCall(String id,
String varName,
ApiCallback _callback)
Build call for getTaskLocalVariableBinary
|
ApiResponse<File> |
getTaskLocalVariableBinaryWithHttpInfo(String id,
String varName)
Get Local Task Variable (Binary)
Retrieves a binary variable from the context of a given task by id.
|
okhttp3.Call |
getTaskLocalVariableCall(String id,
String varName,
Boolean deserializeValue,
ApiCallback _callback)
Build call for getTaskLocalVariable
|
Map<String,VariableValueDto> |
getTaskLocalVariables(String id,
Boolean deserializeValues)
Get Local Task Variables
Retrieves all variables of a given task by id.
|
okhttp3.Call |
getTaskLocalVariablesAsync(String id,
Boolean deserializeValues,
ApiCallback<Map<String,VariableValueDto>> _callback)
Get Local Task Variables (asynchronously)
Retrieves all variables of a given task by id.
|
okhttp3.Call |
getTaskLocalVariablesCall(String id,
Boolean deserializeValues,
ApiCallback _callback)
Build call for getTaskLocalVariables
|
ApiResponse<Map<String,VariableValueDto>> |
getTaskLocalVariablesWithHttpInfo(String id,
Boolean deserializeValues)
Get Local Task Variables
Retrieves all variables of a given task by id.
|
ApiResponse<VariableValueDto> |
getTaskLocalVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
Get Local Task Variable
Retrieves a variable from the context of a given task by id.
|
void |
modifyTaskLocalVariables(String id,
PatchVariablesDto patchVariablesDto)
Update/Delete Local Task Variables
Updates or deletes the variables in the context of a task.
|
okhttp3.Call |
modifyTaskLocalVariablesAsync(String id,
PatchVariablesDto patchVariablesDto,
ApiCallback<Void> _callback)
Update/Delete Local Task Variables (asynchronously)
Updates or deletes the variables in the context of a task.
|
okhttp3.Call |
modifyTaskLocalVariablesCall(String id,
PatchVariablesDto patchVariablesDto,
ApiCallback _callback)
Build call for modifyTaskLocalVariables
|
ApiResponse<Void> |
modifyTaskLocalVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Update/Delete Local Task Variables
Updates or deletes the variables in the context of a task.
|
void |
putTaskLocalVariable(String id,
String varName,
VariableValueDto variableValueDto)
Update Local Task Variable
Sets a variable in the context of a given task.
|
okhttp3.Call |
putTaskLocalVariableAsync(String id,
String varName,
VariableValueDto variableValueDto,
ApiCallback<Void> _callback)
Update Local Task Variable (asynchronously)
Sets a variable in the context of a given task.
|
okhttp3.Call |
putTaskLocalVariableCall(String id,
String varName,
VariableValueDto variableValueDto,
ApiCallback _callback)
Build call for putTaskLocalVariable
|
ApiResponse<Void> |
putTaskLocalVariableWithHttpInfo(String id,
String varName,
VariableValueDto variableValueDto)
Update Local Task Variable
Sets a variable in the context of a given task.
|
void |
setApiClient(ApiClient apiClient) |
void |
setBinaryTaskLocalVariable(String id,
String varName,
File data,
String valueType)
Update Local Task Variable (Binary)
Sets the serialized value for a binary variable or the binary value for a file variable.
|
okhttp3.Call |
setBinaryTaskLocalVariableAsync(String id,
String varName,
File data,
String valueType,
ApiCallback<Void> _callback)
Update Local Task Variable (Binary) (asynchronously)
Sets the serialized value for a binary variable or the binary value for a file variable.
|
okhttp3.Call |
setBinaryTaskLocalVariableCall(String id,
String varName,
File data,
String valueType,
ApiCallback _callback)
Build call for setBinaryTaskLocalVariable
|
ApiResponse<Void> |
setBinaryTaskLocalVariableWithHttpInfo(String id,
String varName,
File data,
String valueType)
Update Local Task Variable (Binary)
Sets the serialized value for a binary variable or the binary value for a file variable.
|
public TaskLocalVariableApi()
public TaskLocalVariableApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call deleteTaskLocalVariableCall(String id, String varName, ApiCallback _callback) throws ApiException
id
- The id of the task to delete the variable from. (required)varName
- The name of the variable to be removed. (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic void deleteTaskLocalVariable(String id, String varName) throws ApiException
id
- The id of the task to delete the variable from. (required)varName
- The name of the variable to be removed. (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteTaskLocalVariableWithHttpInfo(String id, String varName) throws ApiException
id
- The id of the task to delete the variable from. (required)varName
- The name of the variable to be removed. (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call deleteTaskLocalVariableAsync(String id, String varName, ApiCallback<Void> _callback) throws ApiException
id
- The id of the task to delete the variable from. (required)varName
- The name of the variable to be removed. (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 objectpublic okhttp3.Call getTaskLocalVariableCall(String id, String varName, Boolean deserializeValue, ApiCallback _callback) throws ApiException
id
- The id of the task to retrieve the variable from. (required)varName
- The name of the variable to get (required)deserializeValue
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic VariableValueDto getTaskLocalVariable(String id, String varName, Boolean deserializeValue) throws ApiException
id
- The id of the task to retrieve the variable from. (required)varName
- The name of the variable to get (required)deserializeValue
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<VariableValueDto> getTaskLocalVariableWithHttpInfo(String id, String varName, Boolean deserializeValue) throws ApiException
id
- The id of the task to retrieve the variable from. (required)varName
- The name of the variable to get (required)deserializeValue
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getTaskLocalVariableAsync(String id, String varName, Boolean deserializeValue, ApiCallback<VariableValueDto> _callback) throws ApiException
id
- The id of the task to retrieve the variable from. (required)varName
- The name of the variable to get (required)deserializeValue
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getTaskLocalVariableBinaryCall(String id, String varName, ApiCallback _callback) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic File getTaskLocalVariableBinary(String id, String varName) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<File> getTaskLocalVariableBinaryWithHttpInfo(String id, String varName) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getTaskLocalVariableBinaryAsync(String id, String varName, ApiCallback<File> _callback) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (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 objectpublic okhttp3.Call getTaskLocalVariablesCall(String id, Boolean deserializeValues, ApiCallback _callback) throws ApiException
id
- The id of the task to retrieve the variables from. (required)deserializeValues
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic Map<String,VariableValueDto> getTaskLocalVariables(String id, Boolean deserializeValues) throws ApiException
id
- The id of the task to retrieve the variables from. (required)deserializeValues
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Map<String,VariableValueDto>> getTaskLocalVariablesWithHttpInfo(String id, Boolean deserializeValues) throws ApiException
id
- The id of the task to retrieve the variables from. (required)deserializeValues
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getTaskLocalVariablesAsync(String id, Boolean deserializeValues, ApiCallback<Map<String,VariableValueDto>> _callback) throws ApiException
id
- The id of the task to retrieve the variables from. (required)deserializeValues
- Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call modifyTaskLocalVariablesCall(String id, PatchVariablesDto patchVariablesDto, ApiCallback _callback) throws ApiException
id
- The id of the task to set variables for. (required)patchVariablesDto
- (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic void modifyTaskLocalVariables(String id, PatchVariablesDto patchVariablesDto) throws ApiException
id
- The id of the task to set variables for. (required)patchVariablesDto
- (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> modifyTaskLocalVariablesWithHttpInfo(String id, PatchVariablesDto patchVariablesDto) throws ApiException
id
- The id of the task to set variables for. (required)patchVariablesDto
- (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call modifyTaskLocalVariablesAsync(String id, PatchVariablesDto patchVariablesDto, ApiCallback<Void> _callback) throws ApiException
id
- The id of the task to set variables for. (required)patchVariablesDto
- (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 objectpublic okhttp3.Call putTaskLocalVariableCall(String id, String varName, VariableValueDto variableValueDto, ApiCallback _callback) throws ApiException
id
- The id of the task to set the variable for. (required)varName
- The name of the variable to set. (required)variableValueDto
- (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic void putTaskLocalVariable(String id, String varName, VariableValueDto variableValueDto) throws ApiException
id
- The id of the task to set the variable for. (required)varName
- The name of the variable to set. (required)variableValueDto
- (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> putTaskLocalVariableWithHttpInfo(String id, String varName, VariableValueDto variableValueDto) throws ApiException
id
- The id of the task to set the variable for. (required)varName
- The name of the variable to set. (required)variableValueDto
- (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call putTaskLocalVariableAsync(String id, String varName, VariableValueDto variableValueDto, ApiCallback<Void> _callback) throws ApiException
id
- The id of the task to set the variable for. (required)varName
- The name of the variable to set. (required)variableValueDto
- (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 objectpublic okhttp3.Call setBinaryTaskLocalVariableCall(String id, String varName, File data, String valueType, ApiCallback _callback) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (required)data
- The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)valueType
- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectpublic void setBinaryTaskLocalVariable(String id, String varName, File data, String valueType) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (required)data
- The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)valueType
- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> setBinaryTaskLocalVariableWithHttpInfo(String id, String varName, File data, String valueType) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (required)data
- The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)valueType
- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call setBinaryTaskLocalVariableAsync(String id, String varName, File data, String valueType, ApiCallback<Void> _callback) throws ApiException
id
- The id of the task to retrieve the variable for. (required)varName
- The name of the variable to retrieve. (required)data
- The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)valueType
- The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (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 objectCopyright © 2022. All rights reserved.