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

net.nemerosa.ontrack.dsl.AbstractProjectResource

All Implemented Interfaces and Traits:: ProjectEntity

@DSL
abstract class AbstractProjectResource
extends AbstractResource

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

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`config(groovy.lang.Closure closure)`
	`java.lang.Object`	`delete()` Deletes this entity
	`java.lang.Object`	`getDecoration(java.lang.String type)` Gets the first decoration for this entity and a given decoration qualified name.
	`java.util.List<?>`	`getDecorations()` List of decorations for this entity.
	`java.util.List<?>`	`getDecorations(java.lang.String type)` Gets the decoration for this entity and a given decoration qualified name.
	`java.lang.String`	`getDescription()`
	`int`	`getId()`
	`java.lang.String`	`getJenkinsJobDecoration()` Jenkins job decoration (state of the job)
	`java.util.Map<java.lang.String, ?>`	`getMessageDecoration()` Message decoration.
	`java.lang.String`	`getName()`
	`java.lang.Object`	`getProperty(java.lang.String type, boolean required)`
	`java.lang.Object`	`property(java.lang.String type, java.lang.Object data)`
	`java.lang.Object`	`property(java.lang.String type)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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
  - AbstractProjectResource(Ontrack ontrack, java.lang.Object node)
- Method Detail
  - @DSLMethod("Configures this entity.") @java.lang.Override java.lang.Object config(groovy.lang.Closure closure)
  - @DSLMethod("Deletes this entity.") java.lang.Object delete()
    
    Deletes this entity
  - @DSLMethod("Gets the data for the first decoration of a given type. If no decoration is available, returns null.") java.lang.Object getDecoration(java.lang.String type)
    
    Gets the first decoration for this entity and a given decoration qualified name. Returns null if not defined or the JSON data is defined.
  - @DSLMethod("Returns the list of decorations for this entity. Each item has a `decorationType` type name and `data` as JSON.") java.util.List<?> getDecorations()
    
    List of decorations for this entity. Each item in the list has a:
    - decorationType - qualified name of the decoration
    - data - JSON data of the decoration
  - @DSLMethod(value = "Returns the list of decoration data (JSON) for a given decoration type.", id = "decorations-type") java.util.List<?> getDecorations(java.lang.String type)
    
    Gets the decoration for this entity and a given decoration qualified name.
  - @DSLMethod("Returns any description attached to this entity.") java.lang.String getDescription()
  - @DSLMethod("Returns the numeric ID of this entity.") int getId()
  - @DSLMethod("Gets the Jenkins decoration for this entity.") java.lang.String getJenkinsJobDecoration()
    
    Jenkins job decoration (state of the job)
  - @DSLMethod("Gets any message for this entity") java.util.Map<java.lang.String, ?> getMessageDecoration()
    
    Message decoration. Defines a type and a text
  - @DSLMethod("Returns the name of this entity.") java.lang.String getName()
  - @DSLMethod(id = "property-get") @java.lang.Override java.lang.Object getProperty(java.lang.String type, boolean required)
  - @DSLMethod("Sets the value for a property of this entity. Prefer using dedicated DSL methods.") @java.lang.Override java.lang.Object property(java.lang.String type, java.lang.Object data)
  - @DSLMethod(id = "property-get-required") @java.lang.Override java.lang.Object property(java.lang.String type)

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractProjectResource

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

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

Method Detail

@DSLMethod("Configures this entity.") @java.lang.Override java.lang.Object config(groovy.lang.Closure closure)

@DSLMethod("Deletes this entity.") java.lang.Object delete()

@DSLMethod("Gets the data for the first decoration of a given type. If no decoration is available, returns null.") java.lang.Object getDecoration(java.lang.String type)

@DSLMethod("Returns the list of decorations for this entity. Each item has a `decorationType` type name and `data` as JSON.") java.util.List<?> getDecorations()

@DSLMethod(value = "Returns the list of decoration data (JSON) for a given decoration type.", id = "decorations-type") java.util.List<?> getDecorations(java.lang.String type)

@DSLMethod("Returns any description attached to this entity.") java.lang.String getDescription()

@DSLMethod("Returns the numeric ID of this entity.") int getId()

@DSLMethod("Gets the Jenkins decoration for this entity.") java.lang.String getJenkinsJobDecoration()

@DSLMethod("Gets any message for this entity") java.util.Map<java.lang.String, ?> getMessageDecoration()

@DSLMethod("Returns the name of this entity.") java.lang.String getName()

@DSLMethod(id = "property-get") @java.lang.Override java.lang.Object getProperty(java.lang.String type, boolean required)

@DSLMethod("Sets the value for a property of this entity. Prefer using dedicated DSL methods.") @java.lang.Override java.lang.Object property(java.lang.String type, java.lang.Object data)

@DSLMethod(id = "property-get-required") @java.lang.Override java.lang.Object property(java.lang.String type)