Branch (ontrack-dsl feature-600-run-info-903c531 API)

net.nemerosa.ontrack.dsl.Branch

Inherited fields
Fields inherited from class	Fields
`class AbstractResource`	`node, ontrack`

Constructor Summary

Constructors
Constructor and description
`Branch (Ontrack ontrack, java.lang.Object node)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Build`	`build(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)`
	`Build`	`build(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)`
	`java.lang.Object`	`call(groovy.lang.Closure closure)`
	`java.lang.Object`	`disable()`
	`java.lang.String`	`download(java.lang.String path)` Download file from the branch SCM
	`java.lang.Object`	`enable()`
	`java.util.List<Build>`	`filter(java.lang.String filterType, java.util.Map<java.lang.String, ?> filterConfig)`
	`BranchProperties`	`getConfig()`
	`TemplateInstance`	`getInstance()` Gets the template instance parameters
	`java.util.List<Build>`	`getLastPromotedBuilds()`
	`java.lang.String`	`getProject()`
	`java.util.List<PromotionLevel>`	`getPromotionLevels()` Gets the list of promotion levels for this branch
	`java.lang.String`	`getType()`
	`java.util.List<ValidationStamp>`	`getValidationStamps()` Gets the list of validation stamps for this branch
	`Branch`	`instance(java.lang.String sourceName, java.util.Map<java.lang.String, java.lang.String> params)`
	`java.util.List<Build>`	`intervalFilter(java.util.Map<java.lang.String, ?> filterConfig)`
	`boolean`	`isDisabled()`
	`java.lang.Object`	`link(java.lang.String templateName, boolean manual = true, java.util.Map<java.lang.String, java.lang.String> parameters)`
	`PromotionLevel`	`promotionLevel(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)`
	`PromotionLevel`	`promotionLevel(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)`
	`java.util.List<Build>`	`standardFilter(java.util.Map<java.lang.String, ?> filterConfig)`
	`java.lang.Object`	`sync()`
	`java.lang.Object`	`syncInstance()` Sync this branch template instance with its template.
	`java.lang.Object`	`template(groovy.lang.Closure closure)`
	`java.lang.Object`	`unlink()`
	`ValidationStamp`	`validationStamp(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)`
	`ValidationStamp`	`validationStamp(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractProjectResource`	`config, delete, getDecoration, getDecorations, getDecorations, getDescription, getId, getJenkinsJobDecoration, getMessageDecoration, getName, getProperty, property, property`
`class AbstractResource`	`getNode, getPage, link, list, optionalLink, query, toString`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - Branch(Ontrack ontrack, java.lang.Object node)
- Method Detail
  - @DSLMethod(value = "Creates a build for the branch", count = 3) Build build(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)
  - @DSLMethod(value = "Creates a build for the branch and configures it using a closure. See <>.", count = 4, id = "build-closure") Build build(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)
  - @DSLMethod("Configures the branch using a closure.") java.lang.Object call(groovy.lang.Closure closure)
  - @DSLMethod("Disables the branch") java.lang.Object disable()
  - @DSLMethod java.lang.String download(java.lang.String path)
    
    Download file from the branch SCM
  - @DSLMethod("Enables the branch") java.lang.Object enable()
  - @DSLMethod("Runs any filter and returns the list of corresponding builds.") java.util.List<Build> filter(java.lang.String filterType, java.util.Map<java.lang.String, ?> filterConfig)
  - @DSLMethod("Access to the branch properties") BranchProperties getConfig()
  - @DSLMethod TemplateInstance getInstance()
    
    Gets the template instance parameters
  - @DSLMethod("Returns the last promoted builds.") java.util.List<Build> getLastPromotedBuilds()
  - @DSLMethod("Returns the name of the project the branch belongs to.") java.lang.String getProject()
  - @DSLMethod("Gets the list of promotion levels for this branch.") java.util.List<PromotionLevel> getPromotionLevels()
    
    Gets the list of promotion levels for this branch
  - @DSLMethod java.lang.String getType()
  - @DSLMethod("Gets the list of validation stamps for this branch.") java.util.List<ValidationStamp> getValidationStamps()
    
    Gets the list of validation stamps for this branch
  - @DSLMethod("Creates or updates a new branch from this branch template. See <>.") Branch instance(java.lang.String sourceName, java.util.Map<java.lang.String, java.lang.String> params)
  - java.util.List<Build> intervalFilter(java.util.Map<java.lang.String, ?> filterConfig)
  - @DSLMethod("Gets the disabled state of the branch") boolean isDisabled()
  - @DSLMethod(count = 3) java.lang.Object link(java.lang.String templateName, boolean manual = true, java.util.Map<java.lang.String, java.lang.String> parameters)
  - @DSLMethod(value = "Creates a promotion level for this branch.", count = 3) PromotionLevel promotionLevel(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)
  - @DSLMethod(value = "Creates a promotion level for this branch and configures it using a closure.", count = 4, id = "promotionLevel-closure") PromotionLevel promotionLevel(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)
  - @DSLMethod("Returns a list of builds for the branch, filtered according to given criteria.") java.util.List<Build> standardFilter(java.util.Map<java.lang.String, ?> filterConfig)
  - @DSLMethod("Synchronizes the branch template with its associated instances. Will fail if this branch is not a template.") java.lang.Object sync()
  - @DSLMethod("Synchronises the branch instance with its associated template. Will fail if this branch is not a template instance.") java.lang.Object syncInstance()
    
    Sync this branch template instance with its template.
  - @DSLMethod("Configure the branch as a template definition - see <>.") java.lang.Object template(groovy.lang.Closure closure)
  - @DSLMethod java.lang.Object unlink()
  - @DSLMethod(value = "Creates a validation stamp for this branch.", count = 3) ValidationStamp validationStamp(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)
  - @DSLMethod(value = "Creates a validation stamp for this branch and configures it using a closure.", count = 4, id = "validationStamp-closure") ValidationStamp validationStamp(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Branch

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Branch(Ontrack ontrack, java.lang.Object node)

Method Detail

@DSLMethod(value = "Creates a build for the branch", count = 3) Build build(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)

@DSLMethod(value = "Creates a build for the branch and configures it using a closure. See <>.", count = 4, id = "build-closure") Build build(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)

@DSLMethod("Configures the branch using a closure.") java.lang.Object call(groovy.lang.Closure closure)

@DSLMethod("Disables the branch") java.lang.Object disable()

@DSLMethod java.lang.String download(java.lang.String path)

@DSLMethod("Enables the branch") java.lang.Object enable()

@DSLMethod("Runs any filter and returns the list of corresponding builds.") java.util.List<Build> filter(java.lang.String filterType, java.util.Map<java.lang.String, ?> filterConfig)

@DSLMethod("Access to the branch properties") BranchProperties getConfig()

@DSLMethod TemplateInstance getInstance()

@DSLMethod("Returns the last promoted builds.") java.util.List<Build> getLastPromotedBuilds()

@DSLMethod("Returns the name of the project the branch belongs to.") java.lang.String getProject()

@DSLMethod("Gets the list of promotion levels for this branch.") java.util.List<PromotionLevel> getPromotionLevels()

@DSLMethod java.lang.String getType()

@DSLMethod("Gets the list of validation stamps for this branch.") java.util.List<ValidationStamp> getValidationStamps()

@DSLMethod("Creates or updates a new branch from this branch template. See <>.") Branch instance(java.lang.String sourceName, java.util.Map<java.lang.String, java.lang.String> params)

java.util.List<Build> intervalFilter(java.util.Map<java.lang.String, ?> filterConfig)

@DSLMethod("Gets the disabled state of the branch") boolean isDisabled()

@DSLMethod(count = 3) java.lang.Object link(java.lang.String templateName, boolean manual = true, java.util.Map<java.lang.String, java.lang.String> parameters)

@DSLMethod(value = "Creates a promotion level for this branch.", count = 3) PromotionLevel promotionLevel(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)

@DSLMethod(value = "Creates a promotion level for this branch and configures it using a closure.", count = 4, id = "promotionLevel-closure") PromotionLevel promotionLevel(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)

@DSLMethod("Returns a list of builds for the branch, filtered according to given criteria.") java.util.List<Build> standardFilter(java.util.Map<java.lang.String, ?> filterConfig)

@DSLMethod("Synchronizes the branch template with its associated instances. Will fail if this branch is not a template.") java.lang.Object sync()

@DSLMethod("Synchronises the branch instance with its associated template. Will fail if this branch is not a template instance.") java.lang.Object syncInstance()

@DSLMethod("Configure the branch as a template definition - see <>.") java.lang.Object template(groovy.lang.Closure closure)

@DSLMethod java.lang.Object unlink()

@DSLMethod(value = "Creates a validation stamp for this branch.", count = 3) ValidationStamp validationStamp(java.lang.String name, java.lang.String description = '', boolean getIfExists = false)

@DSLMethod(value = "Creates a validation stamp for this branch and configures it using a closure.", count = 4, id = "validationStamp-closure") ValidationStamp validationStamp(java.lang.String name, java.lang.String description = '', boolean getIfExists = false, groovy.lang.Closure closure)