Package de.gesellix.gradle.docker.tasks

Class DockerBuildTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
de.gesellix.gradle.docker.tasks.GenericDockerTask
de.gesellix.gradle.docker.tasks.DockerBuildTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public class DockerBuildTask extends GenericDockerTask

  • Nested Class Summary

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

    org.gradle.api.Named.Namer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Duration
    buildTimeout
     

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    DockerBuildTask(org.gradle.api.model.ObjectFactory objectFactory, org.gradle.workers.WorkerExecutor workerExecutor)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    build()
     
    InputStream
    createBuildContextFromDirectory()
     
    org.gradle.api.provider.MapProperty<String,de.gesellix.docker.authentication.AuthConfig>
    getAuthConfigs()
    A map of registry URL name to AuthConfig.
    org.gradle.api.provider.Property<InputStream>
    getBuildContext()
     
    org.gradle.api.file.DirectoryProperty
    getBuildContextDirectory()
     
    org.gradle.api.provider.MapProperty<String,Object>
    getBuildOptions()
     
    org.gradle.api.provider.MapProperty<String,Object>
    getBuildParams()
     
    Duration
    getBuildTimeout()
     
    org.gradle.api.provider.Property<Boolean>
    getEnableBuildLog()
     
    String
    getImageId()
     
    org.gradle.api.provider.Property<String>
    getImageName()
     
    String
    getNormalizedImageName()
     

    Methods inherited from class de.gesellix.gradle.docker.tasks.GenericDockerTask

    getAuthConfig, getCertPath, getDockerClient, getDockerHost, getEncodedAuthConfig, getProxy

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Field Details

    • buildTimeout

      public Duration buildTimeout

  • Constructor Details

    • DockerBuildTask

      @Inject public DockerBuildTask(org.gradle.api.model.ObjectFactory objectFactory, org.gradle.workers.WorkerExecutor workerExecutor)

  • Method Details

    • getImageName

      @Input @Optional public org.gradle.api.provider.Property<String> getImageName()

    • getBuildContextDirectory

      @InputDirectory @Optional public org.gradle.api.file.DirectoryProperty getBuildContextDirectory()

    • getBuildContext

      @Input @Optional public org.gradle.api.provider.Property<InputStream> getBuildContext()

    • getBuildParams

      @Input @Optional public org.gradle.api.provider.MapProperty<String,Object> getBuildParams()

    • getBuildOptions

      @Input @Optional public org.gradle.api.provider.MapProperty<String,Object> getBuildOptions()

    • getAuthConfigs

      @Input @Optional public org.gradle.api.provider.MapProperty<String,de.gesellix.docker.authentication.AuthConfig> getAuthConfigs()
      A map of registry URL name to AuthConfig. Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a https:// prefix and a /v1/ suffix even though Docker will prefer to use the v2 registry API. See https://docs.docker.com/engine/api/v1.40/#operation/ImageBuild for reference.

    • getEnableBuildLog

      @Input @Optional public org.gradle.api.provider.Property<Boolean> getEnableBuildLog()

    • getImageId

      @Internal public String getImageId()

    • getBuildTimeout

      @Internal public Duration getBuildTimeout()

    • build

      public String build()

    • getNormalizedImageName

      @Internal public String getNormalizedImageName()

    • createBuildContextFromDirectory

      public InputStream createBuildContextFromDirectory()