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

Class SetRemovalTimeToHistoricProcessInstancesDto

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

  • Field Details

  • Constructor Details

    • SetRemovalTimeToHistoricProcessInstancesDto

      public SetRemovalTimeToHistoricProcessInstancesDto()

  • Method Details

    • absoluteRemovalTime

      public SetRemovalTimeToHistoricProcessInstancesDto absoluteRemovalTime(OffsetDateTime absoluteRemovalTime)

    • getAbsoluteRemovalTime

      @Nullable public OffsetDateTime getAbsoluteRemovalTime()
      The date for which the instances shall be removed. Value may not be `null`. **Note:** Cannot be set in conjunction with `clearedRemovalTime` or `calculatedRemovalTime`.
      Returns:
      absoluteRemovalTime

    • getAbsoluteRemovalTime_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getAbsoluteRemovalTime_JsonNullable()

    • setAbsoluteRemovalTime_JsonNullable

      public void setAbsoluteRemovalTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> absoluteRemovalTime)

    • setAbsoluteRemovalTime

      public void setAbsoluteRemovalTime(OffsetDateTime absoluteRemovalTime)

    • clearedRemovalTime

      public SetRemovalTimeToHistoricProcessInstancesDto clearedRemovalTime(Boolean clearedRemovalTime)

    • getClearedRemovalTime

      @Nullable public Boolean getClearedRemovalTime()
      Sets the removal time to `null`. Value may only be `true`, as `false` is the default behavior. **Note:** Cannot be set in conjunction with `absoluteRemovalTime` or `calculatedRemovalTime`.
      Returns:
      clearedRemovalTime

    • getClearedRemovalTime_JsonNullable

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

    • setClearedRemovalTime_JsonNullable

      public void setClearedRemovalTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> clearedRemovalTime)

    • setClearedRemovalTime

      public void setClearedRemovalTime(Boolean clearedRemovalTime)

    • calculatedRemovalTime

      public SetRemovalTimeToHistoricProcessInstancesDto calculatedRemovalTime(Boolean calculatedRemovalTime)

    • getCalculatedRemovalTime

      @Nullable public Boolean getCalculatedRemovalTime()
      The removal time is calculated based on the engine's configuration settings. Value may only be `true`, as `false` is the default behavior. **Note:** Cannot be set in conjunction with `absoluteRemovalTime` or `clearedRemovalTime`.
      Returns:
      calculatedRemovalTime

    • getCalculatedRemovalTime_JsonNullable

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

    • setCalculatedRemovalTime_JsonNullable

      public void setCalculatedRemovalTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> calculatedRemovalTime)

    • setCalculatedRemovalTime

      public void setCalculatedRemovalTime(Boolean calculatedRemovalTime)

    • historicProcessInstanceIds

      public SetRemovalTimeToHistoricProcessInstancesDto historicProcessInstanceIds(List<String> historicProcessInstanceIds)

    • addHistoricProcessInstanceIdsItem

      public SetRemovalTimeToHistoricProcessInstancesDto addHistoricProcessInstanceIdsItem(String historicProcessInstanceIdsItem)

    • getHistoricProcessInstanceIds

      @Nullable public List<String> getHistoricProcessInstanceIds()
      The id of the process instance.
      Returns:
      historicProcessInstanceIds

    • getHistoricProcessInstanceIds_JsonNullable

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

    • setHistoricProcessInstanceIds_JsonNullable

      public void setHistoricProcessInstanceIds_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> historicProcessInstanceIds)

    • setHistoricProcessInstanceIds

      public void setHistoricProcessInstanceIds(List<String> historicProcessInstanceIds)

    • historicProcessInstanceQuery

      public SetRemovalTimeToHistoricProcessInstancesDto historicProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)

    • getHistoricProcessInstanceQuery

      @Nullable public HistoricProcessInstanceQueryDto getHistoricProcessInstanceQuery()
      Get historicProcessInstanceQuery
      Returns:
      historicProcessInstanceQuery

    • setHistoricProcessInstanceQuery

      public void setHistoricProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)

    • hierarchical

      public SetRemovalTimeToHistoricProcessInstancesDto hierarchical(Boolean hierarchical)

    • getHierarchical

      @Nullable public Boolean getHierarchical()
      Sets the removal time to all historic process instances in the hierarchy. Value may only be `true`, as `false` is the default behavior.
      Returns:
      hierarchical

    • getHierarchical_JsonNullable

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

    • setHierarchical_JsonNullable

      public void setHierarchical_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> hierarchical)

    • setHierarchical

      public void setHierarchical(Boolean hierarchical)

    • updateInChunks

      public SetRemovalTimeToHistoricProcessInstancesDto updateInChunks(Boolean updateInChunks)

    • getUpdateInChunks

      @Nullable public Boolean getUpdateInChunks()
      Handles removal time updates in chunks, taking into account the defined size in `removalTimeUpdateChunkSize` in the process engine configuration. The size of the chunks can also be overridden per call with the `updateChunkSize` parameter. Enabling this option can lead to multiple executions of the resulting jobs, preventing the database transaction from timing out by limiting the number of rows to update. Value may only be `true`, as `false` is the default behavior.
      Returns:
      updateInChunks

    • getUpdateInChunks_JsonNullable

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

    • setUpdateInChunks_JsonNullable

      public void setUpdateInChunks_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> updateInChunks)

    • setUpdateInChunks

      public void setUpdateInChunks(Boolean updateInChunks)

    • updateChunkSize

      public SetRemovalTimeToHistoricProcessInstancesDto updateChunkSize(Integer updateChunkSize)

    • getUpdateChunkSize

      @Nullable public Integer getUpdateChunkSize()
      Defines the size of the chunks in which removal time updates are processed. The value must be a positive integer between `1` and `500`. This only has an effect if `updateInChunks` is set to `true`. If undefined, the operation uses the `removalTimeUpdateChunkSize` defined in the process engine configuration.
      Returns:
      updateChunkSize

    • getUpdateChunkSize_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Integer> getUpdateChunkSize_JsonNullable()

    • setUpdateChunkSize_JsonNullable

      public void setUpdateChunkSize_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> updateChunkSize)

    • setUpdateChunkSize

      public void setUpdateChunkSize(Integer updateChunkSize)

    • 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