camunda_client/models/
fetch_external_task_topic_dto.rs

1/*
2 * Camunda BPM REST API
3 *
4 * OpenApi Spec for Camunda BPM REST API.
5 *
6 * The version of the OpenAPI document: 7.13.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
12pub struct FetchExternalTaskTopicDto {
13    /// **Mandatory.** The topic's name.
14    #[serde(rename = "topicName")]
15    pub topic_name: String,
16    /// **Mandatory.** The duration to lock the external tasks for in milliseconds.
17    #[serde(rename = "lockDuration")]
18    pub lock_duration: Option<i64>,
19    /// A JSON array of `String` values that represent variable names. For each result task belonging to this topic, the given variables are returned as well if they are accessible from the external task's execution. If not provided - all variables will be fetched.
20    #[serde(rename = "variables", skip_serializing_if = "Option::is_none")]
21    pub variables: Option<Vec<String>>,
22    /// If `true` only local variables will be fetched.
23    #[serde(rename = "localVariables", skip_serializing_if = "Option::is_none")]
24    pub local_variables: Option<bool>,
25    /// A `String` value which enables the filtering of tasks based on process instance business key.
26    #[serde(rename = "businessKey", skip_serializing_if = "Option::is_none")]
27    pub business_key: Option<String>,
28    /// Filter tasks based on process definition id.
29    #[serde(
30        rename = "processDefinitionId",
31        skip_serializing_if = "Option::is_none"
32    )]
33    pub process_definition_id: Option<String>,
34    /// Filter tasks based on process definition ids.
35    #[serde(
36        rename = "processDefinitionIdIn",
37        skip_serializing_if = "Option::is_none"
38    )]
39    pub process_definition_id_in: Option<Vec<String>>,
40    /// Filter tasks based on process definition key.
41    #[serde(
42        rename = "processDefinitionKey",
43        skip_serializing_if = "Option::is_none"
44    )]
45    pub process_definition_key: Option<String>,
46    /// Filter tasks based on process definition keys.
47    #[serde(
48        rename = "processDefinitionKeyIn",
49        skip_serializing_if = "Option::is_none"
50    )]
51    pub process_definition_key_in: Option<Vec<String>>,
52    /// Filter tasks based on process definition version tag.
53    #[serde(
54        rename = "processDefinitionVersionTag",
55        skip_serializing_if = "Option::is_none"
56    )]
57    pub process_definition_version_tag: Option<String>,
58    /// Filter tasks without tenant id.
59    #[serde(rename = "withoutTenantId", skip_serializing_if = "Option::is_none")]
60    pub without_tenant_id: Option<bool>,
61    /// Filter tasks based on tenant ids.
62    #[serde(rename = "tenantIdIn", skip_serializing_if = "Option::is_none")]
63    pub tenant_id_in: Option<Vec<String>>,
64    /// A `JSON` object used for filtering tasks based on process instance variable values. A property name of the object represents a process variable name, while the property value represents the process variable value to filter tasks by.
65    #[serde(rename = "processVariables", skip_serializing_if = "Option::is_none")]
66    pub process_variables: Option<::std::collections::HashMap<String, serde_json::Value>>,
67    /// Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `false`).  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.
68    #[serde(rename = "deserializeValues", skip_serializing_if = "Option::is_none")]
69    pub deserialize_values: Option<bool>,
70}
71
72impl FetchExternalTaskTopicDto {
73    pub fn new(topic_name: String, lock_duration: Option<i64>) -> FetchExternalTaskTopicDto {
74        FetchExternalTaskTopicDto {
75            topic_name,
76            lock_duration,
77            variables: None,
78            local_variables: None,
79            business_key: None,
80            process_definition_id: None,
81            process_definition_id_in: None,
82            process_definition_key: None,
83            process_definition_key_in: None,
84            process_definition_version_tag: None,
85            without_tenant_id: None,
86            tenant_id_in: None,
87            process_variables: None,
88            deserialize_values: Some(true),
89        }
90    }
91}
camunda_client/models/fetch_external_task_topic_dto.rs

camunda_client/models/
fetch_external_task_topic_dto.rs
