Package org.camunda.community.rest.client.dto

Class JobDefinitionsSuspensionStateDto

java.lang.Object
org.camunda.community.rest.client.dto.JobDefinitionsSuspensionStateDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class JobDefinitionsSuspensionStateDto extends Object
JobDefinitionsSuspensionStateDto

  • Field Details

  • Constructor Details

    • JobDefinitionsSuspensionStateDto

      public JobDefinitionsSuspensionStateDto()

  • Method Details

    • includeJobs

      public JobDefinitionsSuspensionStateDto includeJobs(Boolean includeJobs)

    • getIncludeJobs

      @Nullable public Boolean getIncludeJobs()
      A `Boolean` value which indicates whether to activate or suspend also all jobs of the referenced job definitions. When the value is set to `true`, all jobs of the provided job definitions will be activated or suspended and when the value is set to `false`, the suspension state of all jobs of the provided job definitions will not be updated.
      Returns:
      includeJobs

    • getIncludeJobs_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getIncludeJobs_JsonNullable()

    • setIncludeJobs_JsonNullable

      public void setIncludeJobs_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> includeJobs)

    • setIncludeJobs

      public void setIncludeJobs(Boolean includeJobs)

    • executionDate

      public JobDefinitionsSuspensionStateDto executionDate(String executionDate)

    • getExecutionDate

      @Nullable public String getExecutionDate()
      The date on which the referenced job definitions will be activated or suspended. If null, the suspension state of the given job definitions is updated immediately. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM- dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
      Returns:
      executionDate

    • getExecutionDate_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getExecutionDate_JsonNullable()

    • setExecutionDate_JsonNullable

      public void setExecutionDate_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> executionDate)

    • setExecutionDate

      public void setExecutionDate(String executionDate)

    • suspended

      public JobDefinitionsSuspensionStateDto suspended(Boolean suspended)

    • getSuspended

      @Nullable public Boolean getSuspended()
      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.
      Returns:
      suspended

    • getSuspended_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getSuspended_JsonNullable()

    • setSuspended_JsonNullable

      public void setSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> suspended)

    • setSuspended

      public void setSuspended(Boolean suspended)

    • processDefinitionId

      public JobDefinitionsSuspensionStateDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The process definition id of the job definitions to activate or suspend.
      Returns:
      processDefinitionId

    • getProcessDefinitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionId_JsonNullable()

    • setProcessDefinitionId_JsonNullable

      public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId)

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processDefinitionKey

      public JobDefinitionsSuspensionStateDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The process definition key of the job definitions to activate or suspend.
      Returns:
      processDefinitionKey

    • getProcessDefinitionKey_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionKey_JsonNullable()

    • setProcessDefinitionKey_JsonNullable

      public void setProcessDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionKey)

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processDefinitionTenantId

      public JobDefinitionsSuspensionStateDto processDefinitionTenantId(String processDefinitionTenantId)

    • getProcessDefinitionTenantId

      @Nullable public String getProcessDefinitionTenantId()
      Only activate or suspend job definitions of a process definition which belongs to a tenant with the given id. Note that this parameter will only be considered in combination with `processDefinitionKey`.
      Returns:
      processDefinitionTenantId

    • getProcessDefinitionTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionTenantId_JsonNullable()

    • setProcessDefinitionTenantId_JsonNullable

      public void setProcessDefinitionTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionTenantId)

    • setProcessDefinitionTenantId

      public void setProcessDefinitionTenantId(String processDefinitionTenantId)

    • processDefinitionWithoutTenantId

      public JobDefinitionsSuspensionStateDto processDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)

    • getProcessDefinitionWithoutTenantId

      @Nullable public Boolean getProcessDefinitionWithoutTenantId()
      Only activate or suspend job definitions of a process definition which belongs to no tenant. Value may only be `true`, as `false` is the default behavior. Note that this parameter will only be considered in combination with `processDefinitionKey`.
      Returns:
      processDefinitionWithoutTenantId

    • getProcessDefinitionWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getProcessDefinitionWithoutTenantId_JsonNullable()

    • setProcessDefinitionWithoutTenantId_JsonNullable

      public void setProcessDefinitionWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> processDefinitionWithoutTenantId)

    • setProcessDefinitionWithoutTenantId

      public void setProcessDefinitionWithoutTenantId(Boolean processDefinitionWithoutTenantId)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string