All Implemented Interfaces:: com.cognifide.gradle.aem.common.instance.provision.Step


public final class CustomStep
 extends AbstractStep

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<String>`	`id`
`private final Property<String>`	`description`
`private Property<String>`	`version`
`private Function1<Condition, Boolean>`	`conditionCallback`
`private final Property<Boolean>`	`continueOnFail`
`private final Property<Boolean>`	`rerunOnFail`
`private final Retry`	`actionRetry`
`private final Retry`	`conditionRetry`
`private final Property<Boolean>`	`awaitUp`
`private Boolean`	`awaitOptionally`
`private Boolean`	`awaitRequired`
`private Function1<AwaitUpAction, Unit>`	`awaitUpOptions`
`private final Provisioner`	`provisioner`
`private final String`	`label`

Constructor Summary

Constructors
Constructor	Description
`CustomStep(Provisioner provisioner)`

Method Summary

Modifier and Type	Method	Description
`Unit`	`validate()`
`final Unit`	`init(Function0<Unit> callback)`
`Unit`	`init()`
`final Unit`	`action(Function1<Instance, Unit> callback)`
`Unit`	`action(Instance instance)`
`final Unit`	`sync(Function1<InstanceSync, Unit> callback)`
`Property<String>`	`getId()`	Short unique ID of step.
`Property<String>`	`getDescription()`	Nice name of step describing purpose.
`Property<String>`	`getVersion()`	Implementation version.
`final Function1<Condition, Boolean>`	`getConditionCallback()`
`Property<Boolean>`	`getContinueOnFail()`	Controls logging error to console instead of breaking build with exception so that next step might be performed.
`Property<Boolean>`	`getRerunOnFail()`	Controls if step should be performed again when previously failed.
`Retry`	`getActionRetry()`	Allows to redo step action after delay if exception is thrown.
`Retry`	`getConditionRetry()`	Allows to redo step condition after delay if exception is thrown.
`Property<Boolean>`	`getAwaitUp()`	Controls is after running step on all instances, checking for up instances need to be done.
`final Boolean`	`getAwaitOptionally()`
`final Boolean`	`getAwaitRequired()`
`final Function1<AwaitUpAction, Unit>`	`getAwaitUpOptions()`
`final Provisioner`	`getProvisioner()`
`String`	`getLabel()`
`Unit`	`setVersion(Property<String> version)`	Implementation version.
`final Unit`	`setConditionCallback(Function1<Condition, Boolean> conditionCallback)`
`final Unit`	`setAwaitOptionally(Boolean awaitOptionally)`
`final Unit`	`setAwaitRequired(Boolean awaitRequired)`
`final Unit`	`setAwaitUpOptions(Function1<AwaitUpAction, Unit> awaitUpOptions)`

Methods inherited from class com.cognifide.gradle.aem.common.instance.provision.step.CustomStep
awaitIf, awaitUp, awaitUp, condition, isPerformable, toString, version
Methods inherited from class com.cognifide.gradle.aem.common.instance.provision.Step
equals, hashCode
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CustomStep
```
CustomStep(Provisioner provisioner)
```

Method Detail

validate
```
 Unit validate()
```

init

 final Unit init(Function0<Unit> callback)

init
```
 Unit init()
```

action

 final Unit action(Function1<Instance, Unit> callback)

action
```
 Unit action(Instance instance)
```

sync

 final Unit sync(Function1<InstanceSync, Unit> callback)

getId
```
 Property<String> getId()
```
Short unique ID of step.

getDescription
```
 Property<String> getDescription()
```
Nice name of step describing purpose.

getVersion
```
 Property<String> getVersion()
```
Implementation version.

getConditionCallback

 final Function1<Condition, Boolean> getConditionCallback()

getContinueOnFail
```
 Property<Boolean> getContinueOnFail()
```
Controls logging error to console instead of breaking build with exception so that next step might be performed.

getRerunOnFail
```
 Property<Boolean> getRerunOnFail()
```
Controls if step should be performed again when previously failed.

getActionRetry
```
 Retry getActionRetry()
```
Allows to redo step action after delay if exception is thrown.

getConditionRetry
```
 Retry getConditionRetry()
```
Allows to redo step condition after delay if exception is thrown.

getAwaitUp
```
 Property<Boolean> getAwaitUp()
```
Controls is after running step on all instances, checking for up instances need to be done.

getAwaitOptionally
```
 final Boolean getAwaitOptionally()
```

getAwaitRequired
```
 final Boolean getAwaitRequired()
```

getAwaitUpOptions

 final Function1<AwaitUpAction, Unit> getAwaitUpOptions()

getProvisioner
```
 final Provisioner getProvisioner()
```

getLabel
```
 String getLabel()
```

setVersion

 Unit setVersion(Property<String> version)

Implementation version.

setConditionCallback

 final Unit setConditionCallback(Function1<Condition, Boolean> conditionCallback)

setAwaitOptionally

 final Unit setAwaitOptionally(Boolean awaitOptionally)

setAwaitRequired

 final Unit setAwaitRequired(Boolean awaitRequired)

setAwaitUpOptions

 final Unit setAwaitUpOptions(Function1<AwaitUpAction, Unit> awaitUpOptions)

Class CustomStep

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.cognifide.gradle.aem.common.instance.provision.step.CustomStep

Methods inherited from class com.cognifide.gradle.aem.common.instance.provision.Step

Methods inherited from class java.lang.Object

Constructor Detail

CustomStep

Method Detail

validate

init

init

action

action

sync

getId

getDescription

getVersion

getConditionCallback

getContinueOnFail

getRerunOnFail

getActionRetry

getConditionRetry

getAwaitUp

getAwaitOptionally

getAwaitRequired

getAwaitUpOptions

getProvisioner

getLabel

setVersion

setConditionCallback

setAwaitOptionally

setAwaitRequired

setAwaitUpOptions