org.sonar.api.batch.postjob

Interface PostJobDescriptor

All Known Implementing Classes:

DefaultPostJobDescriptor

@Beta
public interface PostJobDescriptor

Describe what a PostJob is doing. Information may be used by the platform to log interesting information or perform some optimization. See PostJob.describe(PostJobDescriptor)

Since:

5.2

Method Summary

Methods

Modifier and Type	Method and Description
PostJobDescriptor	disabledInIssues() Should this PostJob be disabled in issues mode.
PostJobDescriptor	name(String postJobName) Displayable name of the PostJob.
PostJobDescriptor	requireProperties(String... propertyKeys) List properties this PostJob depends on.
PostJobDescriptor	requireProperty(String... propertyKey) Property this PostJob depends on.

Method Detail

name

PostJobDescriptor name(String postJobName)

Displayable name of the PostJob. Will be displayed in logs.

requireProperty

PostJobDescriptor requireProperty(String... propertyKey)

Property this PostJob depends on. Used by the platform to skip execution of the PostJob when property is not set.

requireProperties

PostJobDescriptor requireProperties(String... propertyKeys)

List properties this PostJob depends on. Used by the platform to skip execution of the PostJob when property is not set.

disabledInIssues

PostJobDescriptor disabledInIssues()

Should this PostJob be disabled in issues mode. Default is to run all PostJobs in preview mode.