Class DurableProcessMetaData

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.processes.QSupplementalProcessMetaData
com.kingsrook.qqq.backend.core.jobs.DurableProcessMetaData
public class DurableProcessMetaData extends QSupplementalProcessMetaData
Per-process durable-job settings (supplemental process meta data "durable"). Optional: with none, the kernel decides eligibility by the kind of process (core bulk processes and partitionable streamed ETL are eligible), and an app can make any process eligible by name in DurableJobsMetaData.

  • Field Details

  • Constructor Details

    • DurableProcessMetaData

      public DurableProcessMetaData()

  • Method Details

    • of

      public static DurableProcessMetaData of(QProcessMetaData process)
      The durable settings on a process, or null.

    • getType

      public String getType()
      Description copied from class: QSupplementalProcessMetaData
      Getter for type
      Specified by:
      getType in class QSupplementalProcessMetaData

    • validate

      public void validate(QInstance qInstance, QProcessMetaData process, QInstanceValidator validator)
      Overrides:
      validate in class QSupplementalProcessMetaData

    • withEffect

      public DurableProcessMetaData withEffect(JobEffectDeclaration effect)
      Declare a side effect one of the process's steps causes.

    • getEffect

      public JobEffectDeclaration getEffect(String name)
      The declared effect with this name, or null.

    • getEligible

      public Boolean getEligible()
      Getter for eligible: whether the process may run as a durable job (null means the kernel default for its kind).

    • withEligible

      public DurableProcessMetaData withEligible(Boolean eligible)
      Fluent setter for eligible

    • getAlwaysDurable

      public Boolean getAlwaysDurable()
      Getter for alwaysDurable: the process is too large to run synchronously; it always runs as a job.

    • withAlwaysDurable

      public DurableProcessMetaData withAlwaysDurable(Boolean alwaysDurable)
      Fluent setter for alwaysDurable

    • getDurableThresholdRows

      public Integer getDurableThresholdRows()
      Getter for durableThresholdRows: rows above which it runs as a job (null means the instance default).

    • withDurableThresholdRows

      public DurableProcessMetaData withDurableThresholdRows(Integer durableThresholdRows)
      Fluent setter for durableThresholdRows

    • getChunkSize

      public Integer getChunkSize()
      Getter for chunkSize: rows per chunk (null means the instance default).

    • withChunkSize

      public DurableProcessMetaData withChunkSize(Integer chunkSize)
      Fluent setter for chunkSize

    • getIdempotency

      public JobIdempotency getIdempotency()
      Getter for idempotency: how safe re-running a chunk is (null means chosen by the kernel).

    • withIdempotency

      public DurableProcessMetaData withIdempotency(JobIdempotency idempotency)
      Fluent setter for idempotency

    • getSemantics

      public JobSemantics getSemantics()
      Getter for semantics: CHUNKED or ATOMIC (null means CHUNKED).

    • withSemantics

      public DurableProcessMetaData withSemantics(JobSemantics semantics)
      Fluent setter for semantics

    • getMaxParallelChunks

      public Integer getMaxParallelChunks()
      Getter for maxParallelChunks: chunks of one job that may run at once (more needs chunkParallelSafe).

    • withMaxParallelChunks

      public DurableProcessMetaData withMaxParallelChunks(Integer maxParallelChunks)
      Fluent setter for maxParallelChunks

    • getChunkParallelSafe

      public Boolean getChunkParallelSafe()
      Getter for chunkParallelSafe: chunks of one job may run in parallel.

    • withChunkParallelSafe

      public DurableProcessMetaData withChunkParallelSafe(Boolean chunkParallelSafe)
      Fluent setter for chunkParallelSafe

    • getMaxConcurrentJobs

      public Integer getMaxConcurrentJobs()
      Getter for maxConcurrentJobs: running jobs of this process at once (null means the instance default).

    • withMaxConcurrentJobs

      public DurableProcessMetaData withMaxConcurrentJobs(Integer maxConcurrentJobs)
      Fluent setter for maxConcurrentJobs

    • getEffects

      public List<JobEffectDeclaration> getEffects()
      Getter for effects: the side effects its steps cause outside the job's database (section 2.13)

    • withEffects

      public DurableProcessMetaData withEffects(List<JobEffectDeclaration> effects)
      Fluent setter for effects