IpdJobRegistry (Atlassian Diagnostics - IPD API 6.2.0 API)

public interface IpdJobRegistry

IPD job registry that will schedule IpdJobs. Registered jobs are triggered on a regular interval.

Since:: 5.0.0

Method Summary

Modifier and Type

Method

Description

void

register(IpdJobRegistration jobRegistration)

Register single job with options.

void

register(IpdJob job, String key)

Register single job.

void

shutdown()

Unregisters all jobs.

default void

unregister(IpdJob job)

Unregisters a single job.

void

unregister(Class<? extends IpdJob> jobClass)

Unregisters a single job by its class.

Method Details
- register
  
  void register(@Nonnull IpdJob job, @Nonnull String key)
  
  Register single job. Only a single job can be registered for a single job class name.
  Overrides existing job if it was registered before.
  
  Parameters:
  
  job - job to register
  
  key - unique key for the job, should be dot-separated string e.g. database.connection.latency
- unregister
  
  default void unregister(@Nonnull IpdJob job)
  
  Unregisters a single job.
- unregister
  
  void unregister(@Nonnull Class<? extends IpdJob> jobClass)
  
  Unregisters a single job by its class.
- register
  
  void register(@Nonnull IpdJobRegistration jobRegistration)
  
  Register single job with options. Only a single job can be registered for a single job class name.
  Overrides existing job if it was registered before.
- shutdown
  
  void shutdown()
  
  Unregisters all jobs.