Class EmulatorScenario

java.lang.Object
io.github.gregwhitaker.awsemulator.emulator.EmulatorScenario
All Implemented Interfaces:
org.gradle.api.Named

public class EmulatorScenario extends Object implements org.gradle.api.Named
A named development dataset, defined using the plugin's typed resource tasks.
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer
  • Constructor Summary

    Constructors
    Constructor
    Description
    EmulatorScenario(String name, org.gradle.api.model.ObjectFactory objects)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    cleanup(org.gradle.api.tasks.TaskProvider<? extends AbstractAwsResourceTask>... tasks)
    Explicit cleanup tasks, in declaration order before resource-set cleanup.
     
    org.gradle.api.provider.Property<ScenarioResetScope>
    Reset scope: RUNTIME restarts the emulator; RESOURCES executes declared cleanup before reseeding.
    org.gradle.api.provider.Property<String>
    Runtime whose development instance receives this scenario.
    final void
    provision(org.gradle.api.tasks.TaskProvider<? extends AbstractAwsResourceTask>... tasks)
    Resources to create before loading any fixtures.
    final void
    resources(org.gradle.api.provider.Provider<? extends EmulatorResourceSet>... sets)
    Applies reusable definitions to the development instance before this scenario's explicit tasks.
    final void
    seed(org.gradle.api.tasks.TaskProvider<? extends AbstractAwsResourceTask>... tasks)
    Fixture tasks to execute in declaration order after all provisioning succeeds.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • EmulatorScenario

      @Inject public EmulatorScenario(String name, org.gradle.api.model.ObjectFactory objects)
  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in interface org.gradle.api.Named
    • getRuntimeName

      public org.gradle.api.provider.Property<String> getRuntimeName()
      Runtime whose development instance receives this scenario. Defaults to default.
    • getResetScope

      public org.gradle.api.provider.Property<ScenarioResetScope> getResetScope()
      Reset scope: RUNTIME restarts the emulator; RESOURCES executes declared cleanup before reseeding.
    • resources

      @SafeVarargs public final void resources(org.gradle.api.provider.Provider<? extends EmulatorResourceSet>... sets)
      Applies reusable definitions to the development instance before this scenario's explicit tasks.
    • provision

      @SafeVarargs public final void provision(org.gradle.api.tasks.TaskProvider<? extends AbstractAwsResourceTask>... tasks)
      Resources to create before loading any fixtures. Use dependsOn for dependencies between resources.
    • seed

      @SafeVarargs public final void seed(org.gradle.api.tasks.TaskProvider<? extends AbstractAwsResourceTask>... tasks)
      Fixture tasks to execute in declaration order after all provisioning succeeds.
    • cleanup

      @SafeVarargs public final void cleanup(org.gradle.api.tasks.TaskProvider<? extends AbstractAwsResourceTask>... tasks)
      Explicit cleanup tasks, in declaration order before resource-set cleanup. Never run by seed alone.