org.camunda.community.rest.client.dto.ProcessInstanceSuspensionStateDto Maven / Gradle / Ivy
The newest version!
/*
* Camunda Platform REST API
* OpenApi Spec for Camunda Platform REST API.
*
* The version of the OpenAPI document: 7.21.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.camunda.community.rest.client.dto;
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.camunda.community.rest.client.dto.HistoricProcessInstanceQueryDto;
import org.camunda.community.rest.client.dto.ProcessInstanceQueryDto;
import org.openapitools.jackson.nullable.JsonNullable;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.openapitools.jackson.nullable.JsonNullable;
import java.util.NoSuchElementException;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.StringJoiner;
/**
* ProcessInstanceSuspensionStateDto
*/
@JsonPropertyOrder({
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_SUSPENDED,
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_PROCESS_DEFINITION_ID,
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_PROCESS_DEFINITION_KEY,
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_PROCESS_DEFINITION_TENANT_ID,
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_PROCESS_DEFINITION_WITHOUT_TENANT_ID,
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_PROCESS_INSTANCE_IDS,
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_PROCESS_INSTANCE_QUERY,
ProcessInstanceSuspensionStateDto.JSON_PROPERTY_HISTORIC_PROCESS_INSTANCE_QUERY
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-06-27T13:50:23.655629899Z[Etc/UTC]")
public class ProcessInstanceSuspensionStateDto {
public static final String JSON_PROPERTY_SUSPENDED = "suspended";
private JsonNullable suspended = JsonNullable.undefined();
public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID = "processDefinitionId";
private JsonNullable processDefinitionId = JsonNullable.undefined();
public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY = "processDefinitionKey";
private JsonNullable processDefinitionKey = JsonNullable.undefined();
public static final String JSON_PROPERTY_PROCESS_DEFINITION_TENANT_ID = "processDefinitionTenantId";
private JsonNullable processDefinitionTenantId = JsonNullable.undefined();
public static final String JSON_PROPERTY_PROCESS_DEFINITION_WITHOUT_TENANT_ID = "processDefinitionWithoutTenantId";
private JsonNullable processDefinitionWithoutTenantId = JsonNullable.undefined();
public static final String JSON_PROPERTY_PROCESS_INSTANCE_IDS = "processInstanceIds";
private JsonNullable> processInstanceIds = JsonNullable.>undefined();
public static final String JSON_PROPERTY_PROCESS_INSTANCE_QUERY = "processInstanceQuery";
private ProcessInstanceQueryDto processInstanceQuery;
public static final String JSON_PROPERTY_HISTORIC_PROCESS_INSTANCE_QUERY = "historicProcessInstanceQuery";
private HistoricProcessInstanceQueryDto historicProcessInstanceQuery;
public ProcessInstanceSuspensionStateDto() {
}
public ProcessInstanceSuspensionStateDto suspended(Boolean suspended) {
this.suspended = JsonNullable.of(suspended);
return this;
}
/**
* A Boolean value which indicates whether to activate or suspend a given instance (e.g. process instance, job, job definition, or batch). When the value is set to true, the given instance will be suspended and when the value is set to false, the given instance will be activated.
* @return suspended
**/
@javax.annotation.Nullable
@JsonIgnore
public Boolean getSuspended() {
return suspended.orElse(null);
}
@JsonProperty(JSON_PROPERTY_SUSPENDED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getSuspended_JsonNullable() {
return suspended;
}
@JsonProperty(JSON_PROPERTY_SUSPENDED)
public void setSuspended_JsonNullable(JsonNullable suspended) {
this.suspended = suspended;
}
public void setSuspended(Boolean suspended) {
this.suspended = JsonNullable.of(suspended);
}
public ProcessInstanceSuspensionStateDto processDefinitionId(String processDefinitionId) {
this.processDefinitionId = JsonNullable.of(processDefinitionId);
return this;
}
/**
* The process definition id of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`.
* @return processDefinitionId
**/
@javax.annotation.Nullable
@JsonIgnore
public String getProcessDefinitionId() {
return processDefinitionId.orElse(null);
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getProcessDefinitionId_JsonNullable() {
return processDefinitionId;
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_ID)
public void setProcessDefinitionId_JsonNullable(JsonNullable processDefinitionId) {
this.processDefinitionId = processDefinitionId;
}
public void setProcessDefinitionId(String processDefinitionId) {
this.processDefinitionId = JsonNullable.of(processDefinitionId);
}
public ProcessInstanceSuspensionStateDto processDefinitionKey(String processDefinitionKey) {
this.processDefinitionKey = JsonNullable.of(processDefinitionKey);
return this;
}
/**
* The process definition key of the process instances to activate or suspend. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionTenantId`, and `processDefinitionWithoutTenantId`.
* @return processDefinitionKey
**/
@javax.annotation.Nullable
@JsonIgnore
public String getProcessDefinitionKey() {
return processDefinitionKey.orElse(null);
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_KEY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getProcessDefinitionKey_JsonNullable() {
return processDefinitionKey;
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_KEY)
public void setProcessDefinitionKey_JsonNullable(JsonNullable processDefinitionKey) {
this.processDefinitionKey = processDefinitionKey;
}
public void setProcessDefinitionKey(String processDefinitionKey) {
this.processDefinitionKey = JsonNullable.of(processDefinitionKey);
}
public ProcessInstanceSuspensionStateDto processDefinitionTenantId(String processDefinitionTenantId) {
this.processDefinitionTenantId = JsonNullable.of(processDefinitionTenantId);
return this;
}
/**
* Only activate or suspend process instances of a process definition which belongs to a tenant with the given id. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionWithoutTenantId`.
* @return processDefinitionTenantId
**/
@javax.annotation.Nullable
@JsonIgnore
public String getProcessDefinitionTenantId() {
return processDefinitionTenantId.orElse(null);
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_TENANT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getProcessDefinitionTenantId_JsonNullable() {
return processDefinitionTenantId;
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_TENANT_ID)
public void setProcessDefinitionTenantId_JsonNullable(JsonNullable processDefinitionTenantId) {
this.processDefinitionTenantId = processDefinitionTenantId;
}
public void setProcessDefinitionTenantId(String processDefinitionTenantId) {
this.processDefinitionTenantId = JsonNullable.of(processDefinitionTenantId);
}
public ProcessInstanceSuspensionStateDto processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId) {
this.processDefinitionWithoutTenantId = JsonNullable.of(processDefinitionWithoutTenantId);
return this;
}
/**
* Only activate or suspend process instances of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior. **Note**: This parameter can be used only with combination of `suspended`, `processDefinitionKey`, and `processDefinitionTenantId`.
* @return processDefinitionWithoutTenantId
**/
@javax.annotation.Nullable
@JsonIgnore
public Boolean getProcessDefinitionWithoutTenantId() {
return processDefinitionWithoutTenantId.orElse(null);
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_WITHOUT_TENANT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable getProcessDefinitionWithoutTenantId_JsonNullable() {
return processDefinitionWithoutTenantId;
}
@JsonProperty(JSON_PROPERTY_PROCESS_DEFINITION_WITHOUT_TENANT_ID)
public void setProcessDefinitionWithoutTenantId_JsonNullable(JsonNullable processDefinitionWithoutTenantId) {
this.processDefinitionWithoutTenantId = processDefinitionWithoutTenantId;
}
public void setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId) {
this.processDefinitionWithoutTenantId = JsonNullable.of(processDefinitionWithoutTenantId);
}
public ProcessInstanceSuspensionStateDto processInstanceIds(List processInstanceIds) {
this.processInstanceIds = JsonNullable.>of(processInstanceIds);
return this;
}
public ProcessInstanceSuspensionStateDto addProcessInstanceIdsItem(String processInstanceIdsItem) {
if (this.processInstanceIds == null || !this.processInstanceIds.isPresent()) {
this.processInstanceIds = JsonNullable.>of(new ArrayList<>());
}
try {
this.processInstanceIds.get().add(processInstanceIdsItem);
} catch (java.util.NoSuchElementException e) {
// this can never happen, as we make sure above that the value is present
}
return this;
}
/**
* A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation. **Note**: This parameter can be used only with combination of `suspended`, `processInstanceQuery`, and `historicProcessInstanceQuery`.
* @return processInstanceIds
**/
@javax.annotation.Nullable
@JsonIgnore
public List getProcessInstanceIds() {
return processInstanceIds.orElse(null);
}
@JsonProperty(JSON_PROPERTY_PROCESS_INSTANCE_IDS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public JsonNullable> getProcessInstanceIds_JsonNullable() {
return processInstanceIds;
}
@JsonProperty(JSON_PROPERTY_PROCESS_INSTANCE_IDS)
public void setProcessInstanceIds_JsonNullable(JsonNullable> processInstanceIds) {
this.processInstanceIds = processInstanceIds;
}
public void setProcessInstanceIds(List processInstanceIds) {
this.processInstanceIds = JsonNullable.>of(processInstanceIds);
}
public ProcessInstanceSuspensionStateDto processInstanceQuery(ProcessInstanceQueryDto processInstanceQuery) {
this.processInstanceQuery = processInstanceQuery;
return this;
}
/**
* Get processInstanceQuery
* @return processInstanceQuery
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_PROCESS_INSTANCE_QUERY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ProcessInstanceQueryDto getProcessInstanceQuery() {
return processInstanceQuery;
}
@JsonProperty(JSON_PROPERTY_PROCESS_INSTANCE_QUERY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setProcessInstanceQuery(ProcessInstanceQueryDto processInstanceQuery) {
this.processInstanceQuery = processInstanceQuery;
}
public ProcessInstanceSuspensionStateDto historicProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery) {
this.historicProcessInstanceQuery = historicProcessInstanceQuery;
return this;
}
/**
* Get historicProcessInstanceQuery
* @return historicProcessInstanceQuery
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_HISTORIC_PROCESS_INSTANCE_QUERY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public HistoricProcessInstanceQueryDto getHistoricProcessInstanceQuery() {
return historicProcessInstanceQuery;
}
@JsonProperty(JSON_PROPERTY_HISTORIC_PROCESS_INSTANCE_QUERY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setHistoricProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery) {
this.historicProcessInstanceQuery = historicProcessInstanceQuery;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto = (ProcessInstanceSuspensionStateDto) o;
return equalsNullable(this.suspended, processInstanceSuspensionStateDto.suspended) &&
equalsNullable(this.processDefinitionId, processInstanceSuspensionStateDto.processDefinitionId) &&
equalsNullable(this.processDefinitionKey, processInstanceSuspensionStateDto.processDefinitionKey) &&
equalsNullable(this.processDefinitionTenantId, processInstanceSuspensionStateDto.processDefinitionTenantId) &&
equalsNullable(this.processDefinitionWithoutTenantId, processInstanceSuspensionStateDto.processDefinitionWithoutTenantId) &&
equalsNullable(this.processInstanceIds, processInstanceSuspensionStateDto.processInstanceIds) &&
Objects.equals(this.processInstanceQuery, processInstanceSuspensionStateDto.processInstanceQuery) &&
Objects.equals(this.historicProcessInstanceQuery, processInstanceSuspensionStateDto.historicProcessInstanceQuery);
}
private static boolean equalsNullable(JsonNullable a, JsonNullable b) {
return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get()));
}
@Override
public int hashCode() {
return Objects.hash(hashCodeNullable(suspended), hashCodeNullable(processDefinitionId), hashCodeNullable(processDefinitionKey), hashCodeNullable(processDefinitionTenantId), hashCodeNullable(processDefinitionWithoutTenantId), hashCodeNullable(processInstanceIds), processInstanceQuery, historicProcessInstanceQuery);
}
private static int hashCodeNullable(JsonNullable a) {
if (a == null) {
return 1;
}
return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ProcessInstanceSuspensionStateDto {\n");
sb.append(" suspended: ").append(toIndentedString(suspended)).append("\n");
sb.append(" processDefinitionId: ").append(toIndentedString(processDefinitionId)).append("\n");
sb.append(" processDefinitionKey: ").append(toIndentedString(processDefinitionKey)).append("\n");
sb.append(" processDefinitionTenantId: ").append(toIndentedString(processDefinitionTenantId)).append("\n");
sb.append(" processDefinitionWithoutTenantId: ").append(toIndentedString(processDefinitionWithoutTenantId)).append("\n");
sb.append(" processInstanceIds: ").append(toIndentedString(processInstanceIds)).append("\n");
sb.append(" processInstanceQuery: ").append(toIndentedString(processInstanceQuery)).append("\n");
sb.append(" historicProcessInstanceQuery: ").append(toIndentedString(historicProcessInstanceQuery)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
/**
* Convert the instance into URL query string.
*
* @return URL query string
*/
public String toUrlQueryString() {
return toUrlQueryString(null);
}
/**
* Convert the instance into URL query string.
*
* @param prefix prefix of the query string
* @return URL query string
*/
public String toUrlQueryString(String prefix) {
String suffix = "";
String containerSuffix = "";
String containerPrefix = "";
if (prefix == null) {
// style=form, explode=true, e.g. /pet?name=cat&type=manx
prefix = "";
} else {
// deepObject style e.g. /pet?id[name]=cat&id[type]=manx
prefix = prefix + "[";
suffix = "]";
containerSuffix = "]";
containerPrefix = "[";
}
StringJoiner joiner = new StringJoiner("&");
// add `suspended` to the URL query string
if (getSuspended() != null) {
try {
joiner.add(String.format("%ssuspended%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getSuspended()), "UTF-8").replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}
// add `processDefinitionId` to the URL query string
if (getProcessDefinitionId() != null) {
try {
joiner.add(String.format("%sprocessDefinitionId%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getProcessDefinitionId()), "UTF-8").replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}
// add `processDefinitionKey` to the URL query string
if (getProcessDefinitionKey() != null) {
try {
joiner.add(String.format("%sprocessDefinitionKey%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getProcessDefinitionKey()), "UTF-8").replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}
// add `processDefinitionTenantId` to the URL query string
if (getProcessDefinitionTenantId() != null) {
try {
joiner.add(String.format("%sprocessDefinitionTenantId%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getProcessDefinitionTenantId()), "UTF-8").replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}
// add `processDefinitionWithoutTenantId` to the URL query string
if (getProcessDefinitionWithoutTenantId() != null) {
try {
joiner.add(String.format("%sprocessDefinitionWithoutTenantId%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getProcessDefinitionWithoutTenantId()), "UTF-8").replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}
// add `processInstanceIds` to the URL query string
if (getProcessInstanceIds() != null) {
for (int i = 0; i < getProcessInstanceIds().size(); i++) {
try {
joiner.add(String.format("%sprocessInstanceIds%s%s=%s", prefix, suffix,
"".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix),
URLEncoder.encode(String.valueOf(getProcessInstanceIds().get(i)), "UTF-8").replaceAll("\\+", "%20")));
} catch (UnsupportedEncodingException e) {
// Should never happen, UTF-8 is always supported
throw new RuntimeException(e);
}
}
}
// add `processInstanceQuery` to the URL query string
if (getProcessInstanceQuery() != null) {
joiner.add(getProcessInstanceQuery().toUrlQueryString(prefix + "processInstanceQuery" + suffix));
}
// add `historicProcessInstanceQuery` to the URL query string
if (getHistoricProcessInstanceQuery() != null) {
joiner.add(getHistoricProcessInstanceQuery().toUrlQueryString(prefix + "historicProcessInstanceQuery" + suffix));
}
return joiner.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy