TaskLocalVariableApi (Camunda BPM Javadocs 7.14.20-ee)

java.lang.Object
- org.openapitools.client.api.TaskLocalVariableApi

public class TaskLocalVariableApi
extends Object

Constructor Summary

Constructors
Constructor and Description

TaskLocalVariableApi()

TaskLocalVariableApi(ApiClient apiClient)

Constructors
Constructor and Description
`TaskLocalVariableApi()`
`TaskLocalVariableApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteTaskLocalVariable(String id, String varName)` Removes a local variable from a task by id.
`okhttp3.Call`	`deleteTaskLocalVariableAsync(String id, String varName, ApiCallback<Void> _callback)` (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)` Removes a local variable from a task by id.
`ApiClient`	`getApiClient()`
`VariableValueDto`	`getTaskLocalVariable(String id, String varName, Boolean deserializeValue)` Retrieves a variable from the context of a given task by id.
`okhttp3.Call`	`getTaskLocalVariableAsync(String id, String varName, Boolean deserializeValue, ApiCallback<VariableValueDto> _callback)` (asynchronously) Retrieves a variable from the context of a given task by id.
`File`	`getTaskLocalVariableBinary(String id, String varName)` Retrieves a binary variable from the context of a given task by id.
`okhttp3.Call`	`getTaskLocalVariableBinaryAsync(String id, String varName, ApiCallback<File> _callback)` (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)` 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)` Retrieves all variables of a given task by id.
`okhttp3.Call`	`getTaskLocalVariablesAsync(String id, Boolean deserializeValues, ApiCallback<Map<String,VariableValueDto>> _callback)` (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)` Retrieves all variables of a given task by id.
`ApiResponse<VariableValueDto>`	`getTaskLocalVariableWithHttpInfo(String id, String varName, Boolean deserializeValue)` Retrieves a variable from the context of a given task by id.
`void`	`modifyTaskLocalVariables(String id, PatchVariablesDto patchVariablesDto)` Updates or deletes the variables in the context of a task.
`okhttp3.Call`	`modifyTaskLocalVariablesAsync(String id, PatchVariablesDto patchVariablesDto, ApiCallback<Void> _callback)` (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)` Updates or deletes the variables in the context of a task.
`void`	`putTaskLocalVariable(String id, String varName, VariableValueDto variableValueDto)` Sets a variable in the context of a given task.
`okhttp3.Call`	`putTaskLocalVariableAsync(String id, String varName, VariableValueDto variableValueDto, ApiCallback<Void> _callback)` (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)` Sets a variable in the context of a given task.
`void`	`setApiClient(ApiClient apiClient)`
`void`	`setBinaryTaskLocalVariable(String id, String varName, File data, String valueType)` 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)` (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)` Sets the serialized value for a binary variable or the binary value for a file variable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TaskLocalVariableApi
```
public TaskLocalVariableApi()
```
  - TaskLocalVariableApi
```
public TaskLocalVariableApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - deleteTaskLocalVariableCall
```
public okhttp3.Call deleteTaskLocalVariableCall(String id,
                                                String varName,
                                                ApiCallback _callback)
                                         throws ApiException
```
    Build call for deleteTaskLocalVariable
    
    Parameters:
    
    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 progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - deleteTaskLocalVariable
```
public void deleteTaskLocalVariable(String id,
                                    String varName)
                             throws ApiException
```
    Removes a local variable from a task by id.
    
    Parameters:
    
    id - The id of the task to delete the variable from. (required)
    
    varName - The name of the variable to be removed. (required)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteTaskLocalVariableWithHttpInfo
```
public ApiResponse<Void> deleteTaskLocalVariableWithHttpInfo(String id,
                                                             String varName)
                                                      throws ApiException
```
    Removes a local variable from a task by id.
    
    Parameters:
    
    id - The id of the task to delete the variable from. (required)
    
    varName - The name of the variable to be removed. (required)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteTaskLocalVariableAsync
```
public okhttp3.Call deleteTaskLocalVariableAsync(String id,
                                                 String varName,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException
```
    (asynchronously) Removes a local variable from a task by id.
    
    Parameters:
    
    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 finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - getTaskLocalVariableCall
```
public okhttp3.Call getTaskLocalVariableCall(String id,
                                             String varName,
                                             Boolean deserializeValue,
                                             ApiCallback _callback)
                                      throws ApiException
```
    Build call for getTaskLocalVariable
    
    Parameters:
    
    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 progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getTaskLocalVariable
```
public VariableValueDto getTaskLocalVariable(String id,
                                             String varName,
                                             Boolean deserializeValue)
                                      throws ApiException
```
    Retrieves a variable from the context of a given task by id.
    
    Parameters:
    
    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)
    
    Returns:
    
    VariableValueDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getTaskLocalVariableWithHttpInfo
```
public ApiResponse<VariableValueDto> getTaskLocalVariableWithHttpInfo(String id,
                                                                      String varName,
                                                                      Boolean deserializeValue)
                                                               throws ApiException
```
    Retrieves a variable from the context of a given task by id.
    
    Parameters:
    
    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)
    
    Returns:
    
    ApiResponse<VariableValueDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getTaskLocalVariableAsync
```
public okhttp3.Call getTaskLocalVariableAsync(String id,
                                              String varName,
                                              Boolean deserializeValue,
                                              ApiCallback<VariableValueDto> _callback)
                                       throws ApiException
```
    (asynchronously) Retrieves a variable from the context of a given task by id.
    
    Parameters:
    
    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 finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - getTaskLocalVariableBinaryCall
```
public okhttp3.Call getTaskLocalVariableBinaryCall(String id,
                                                   String varName,
                                                   ApiCallback _callback)
                                            throws ApiException
```
    Build call for getTaskLocalVariableBinary
    
    Parameters:
    
    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 progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getTaskLocalVariableBinary
```
public File getTaskLocalVariableBinary(String id,
                                       String varName)
                                throws ApiException
```
    Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file variables.
    
    Parameters:
    
    id - The id of the task to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    Returns:
    
    File
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getTaskLocalVariableBinaryWithHttpInfo
```
public ApiResponse<File> getTaskLocalVariableBinaryWithHttpInfo(String id,
                                                                String varName)
                                                         throws ApiException
```
    Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file variables.
    
    Parameters:
    
    id - The id of the task to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    Returns:
    
    ApiResponse<File>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getTaskLocalVariableBinaryAsync
```
public okhttp3.Call getTaskLocalVariableBinaryAsync(String id,
                                                    String varName,
                                                    ApiCallback<File> _callback)
                                             throws ApiException
```
    (asynchronously) Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file variables.
    
    Parameters:
    
    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 finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - getTaskLocalVariablesCall
```
public okhttp3.Call getTaskLocalVariablesCall(String id,
                                              Boolean deserializeValues,
                                              ApiCallback _callback)
                                       throws ApiException
```
    Build call for getTaskLocalVariables
    
    Parameters:
    
    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 progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getTaskLocalVariables
```
public Map<String,VariableValueDto> getTaskLocalVariables(String id,
                                                          Boolean deserializeValues)
                                                   throws ApiException
```
    Retrieves all variables of a given task by id.
    
    Parameters:
    
    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)
    
    Returns:
    
    Map<String, VariableValueDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getTaskLocalVariablesWithHttpInfo
```
public ApiResponse<Map<String,VariableValueDto>> getTaskLocalVariablesWithHttpInfo(String id,
                                                                                   Boolean deserializeValues)
                                                                            throws ApiException
```
    Retrieves all variables of a given task by id.
    
    Parameters:
    
    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)
    
    Returns:
    
    ApiResponse<Map<String, VariableValueDto>>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getTaskLocalVariablesAsync
```
public okhttp3.Call getTaskLocalVariablesAsync(String id,
                                               Boolean deserializeValues,
                                               ApiCallback<Map<String,VariableValueDto>> _callback)
                                        throws ApiException
```
    (asynchronously) Retrieves all variables of a given task by id.
    
    Parameters:
    
    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 finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - modifyTaskLocalVariablesCall
```
public okhttp3.Call modifyTaskLocalVariablesCall(String id,
                                                 PatchVariablesDto patchVariablesDto,
                                                 ApiCallback _callback)
                                          throws ApiException
```
    Build call for modifyTaskLocalVariables
    
    Parameters:
    
    id - The id of the task to set variables for. (required)
    
    patchVariablesDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - modifyTaskLocalVariables
```
public void modifyTaskLocalVariables(String id,
                                     PatchVariablesDto patchVariablesDto)
                              throws ApiException
```
    Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
    
    Parameters:
    
    id - The id of the task to set variables for. (required)
    
    patchVariablesDto - (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyTaskLocalVariablesWithHttpInfo
```
public ApiResponse<Void> modifyTaskLocalVariablesWithHttpInfo(String id,
                                                              PatchVariablesDto patchVariablesDto)
                                                       throws ApiException
```
    Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
    
    Parameters:
    
    id - The id of the task to set variables for. (required)
    
    patchVariablesDto - (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyTaskLocalVariablesAsync
```
public okhttp3.Call modifyTaskLocalVariablesAsync(String id,
                                                  PatchVariablesDto patchVariablesDto,
                                                  ApiCallback<Void> _callback)
                                           throws ApiException
```
    (asynchronously) Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
    
    Parameters:
    
    id - The id of the task to set variables for. (required)
    
    patchVariablesDto - (optional)
    
    _callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - putTaskLocalVariableCall
```
public okhttp3.Call putTaskLocalVariableCall(String id,
                                             String varName,
                                             VariableValueDto variableValueDto,
                                             ApiCallback _callback)
                                      throws ApiException
```
    Build call for putTaskLocalVariable
    
    Parameters:
    
    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 progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - putTaskLocalVariable
```
public void putTaskLocalVariable(String id,
                                 String varName,
                                 VariableValueDto variableValueDto)
                          throws ApiException
```
    Sets a variable in the context of a given task.
    
    Parameters:
    
    id - The id of the task to set the variable for. (required)
    
    varName - The name of the variable to set. (required)
    
    variableValueDto - (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - putTaskLocalVariableWithHttpInfo
```
public ApiResponse<Void> putTaskLocalVariableWithHttpInfo(String id,
                                                          String varName,
                                                          VariableValueDto variableValueDto)
                                                   throws ApiException
```
    Sets a variable in the context of a given task.
    
    Parameters:
    
    id - The id of the task to set the variable for. (required)
    
    varName - The name of the variable to set. (required)
    
    variableValueDto - (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - putTaskLocalVariableAsync
```
public okhttp3.Call putTaskLocalVariableAsync(String id,
                                              String varName,
                                              VariableValueDto variableValueDto,
                                              ApiCallback<Void> _callback)
                                       throws ApiException
```
    (asynchronously) Sets a variable in the context of a given task.
    
    Parameters:
    
    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 finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object
  - setBinaryTaskLocalVariableCall
```
public okhttp3.Call setBinaryTaskLocalVariableCall(String id,
                                                   String varName,
                                                   File data,
                                                   String valueType,
                                                   ApiCallback _callback)
                                            throws ApiException
```
    Build call for setBinaryTaskLocalVariable
    
    Parameters:
    
    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 progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - setBinaryTaskLocalVariable
```
public void setBinaryTaskLocalVariable(String id,
                                       String varName,
                                       File data,
                                       String valueType)
                                throws ApiException
```
    Sets the serialized value for a binary variable or the binary value for a file variable.
    
    Parameters:
    
    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)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setBinaryTaskLocalVariableWithHttpInfo
```
public ApiResponse<Void> setBinaryTaskLocalVariableWithHttpInfo(String id,
                                                                String varName,
                                                                File data,
                                                                String valueType)
                                                         throws ApiException
```
    Sets the serialized value for a binary variable or the binary value for a file variable.
    
    Parameters:
    
    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)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setBinaryTaskLocalVariableAsync
```
public okhttp3.Call setBinaryTaskLocalVariableAsync(String id,
                                                    String varName,
                                                    File data,
                                                    String valueType,
                                                    ApiCallback<Void> _callback)
                                             throws ApiException
```
    (asynchronously) Sets the serialized value for a binary variable or the binary value for a file variable.
    
    Parameters:
    
    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 finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object

Class TaskLocalVariableApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaskLocalVariableApi

TaskLocalVariableApi

Method Detail

getApiClient

setApiClient

deleteTaskLocalVariableCall

deleteTaskLocalVariable

deleteTaskLocalVariableWithHttpInfo

deleteTaskLocalVariableAsync

getTaskLocalVariableCall

getTaskLocalVariable

getTaskLocalVariableWithHttpInfo

getTaskLocalVariableAsync

getTaskLocalVariableBinaryCall

getTaskLocalVariableBinary

getTaskLocalVariableBinaryWithHttpInfo

getTaskLocalVariableBinaryAsync

getTaskLocalVariablesCall

getTaskLocalVariables

getTaskLocalVariablesWithHttpInfo

getTaskLocalVariablesAsync

modifyTaskLocalVariablesCall

modifyTaskLocalVariables

modifyTaskLocalVariablesWithHttpInfo

modifyTaskLocalVariablesAsync

putTaskLocalVariableCall

putTaskLocalVariable

putTaskLocalVariableWithHttpInfo

putTaskLocalVariableAsync

setBinaryTaskLocalVariableCall

setBinaryTaskLocalVariable

setBinaryTaskLocalVariableWithHttpInfo

setBinaryTaskLocalVariableAsync