gradle-plugin/io.spine.embedcode.gradle/InstallEmbedCodeTask

InstallEmbedCodeTask

@DisableCachingByDefault(because = "Release assets come from external URLs that may change")

abstract class InstallEmbedCodeTask : DefaultTask

Downloads and prepares the Embed Code executable selected for the host.

Release assets are authenticated before their first installation. Before a local installation is reused, its digest is calculated and compared with the digest stored during that verified installation; this does not require a network request. If the installation is missing, modified, or its metadata no longer matches the configured release source, the retained asset is authenticated again before use.

Constructors

InstallEmbedCodeTask

constructor()

Properties

open var actions: List<Action<in Task?>?>?

open val ant: AntBuilder?

@get:Input

abstract val architecture: Property<String>

The architecture used to select a release asset.

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

assetChecksumFile

@get:LocalState

abstract val assetChecksumFile: RegularFileProperty

Records the verified digest of the downloaded release asset.

cachedAssetFile

@get:LocalState

abstract val cachedAssetFile: RegularFileProperty

Stores the downloaded release asset used to recreate the executable.

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

downloadBaseUrl

@get:Input

abstract val downloadBaseUrl: Property<String>

The base URL of the Embed Code releases.

open var enabled: Boolean

executableChecksumFile

@get:LocalState

abstract val executableChecksumFile: RegularFileProperty

Records the digest used to authenticate the prepared executable on reuse.

@get:OutputFile

abstract val executableFile: RegularFileProperty

The installed executable used by Embed Code execution tasks.

open val extensions: ExtensionContainer?

open val finalizedBy: TaskDependency?

@get:Internal

abstract val githubToken: Property<String>

An optional token used for GitHub release metadata requests.

open var group: @Nullable String?

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal?

installationDirectory

@get:Internal

abstract val installationDirectory: DirectoryProperty

The directory containing executables and their integrity metadata.

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

open val mustRunAfter: TaskDependency?

open val name: String?

@get:Input

abstract val offline: Property<Boolean>

Whether Gradle is running without network access.

open val onlyIf: Spec<in TaskInternal?>?

operatingSystem

@get:Input

abstract val operatingSystem: Property<String>

The operating system used to select a release asset.

open val outputs: TaskOutputsInternal?

open val path: String?

open val project: Project?

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

@get:Input

@get:Optional

abstract val sha256: Property<String>

An optional user-provided SHA-256 digest of the release asset.

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

sourceIdentityFile

@get:LocalState

abstract val sourceIdentityFile: RegularFileProperty

Records the selected release source and asset identity.

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

open val taskIdentity: TaskIdentity<*>?

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

open val timeout: Property<Duration?>?

@get:Input

abstract val version: Property<String>

The exact Embed Code release tag used verbatim.

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

open operator fun compareTo(otherTask: Task?): Int

open fun configure(closure: Closure<*>?): Task?

open fun dependsOn(vararg paths: Any?): Task?

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

open fun finalizedBy(vararg paths: Any?): Task?

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

Downloads, extracts when necessary, and marks the executable runnable.

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

open fun property(propertyName: String?): Any?

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

open fun setDependsOn(dependsOn: Iterable<*>?)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

open fun usesService(service: Provider<out BuildService<*>?>?)