Package com.bmuschko.gradle.docker.tasks.network

Class DockerCreateNetwork

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable<Task>

public class DockerCreateNetwork
extends AbstractDockerRemoteApiTask

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerCreateNetwork.Ipam

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

Named.Namer

Field Summary

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
DockerCreateNetwork(ObjectFactory objects)

Method Summary

Modifier and Type	Method	Description
final DockerCreateNetwork.Ipam	getIpam()	The IP address management (IPAM) for managing IP address space on a network.
final Property<String>	getNetworkId()	The ID of the network created.
final RegularFileProperty	getNetworkIdFile()	The file that contains the network ID created by this task.
final Property<String>	getNetworkName()	The name of the network to be created.
void	runRemoteCommand()

Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

getApiVersion, getCertPath, getDockerClient, getDockerClientService, getNextHandler, getRegistryAuthLocator, getUrl, onComplete, onError, onNext, start

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

Constructor Details

DockerCreateNetwork

@Inject
public DockerCreateNetwork(ObjectFactory objects)

Method Details

getNetworkName

@Input
public final Property<String> getNetworkName()

The name of the network to be created.

Since:

6.4.0

getIpam

public final DockerCreateNetwork.Ipam getIpam()

The IP address management (IPAM) for managing IP address space on a network.

Since:

8.0.0

getNetworkIdFile

@OutputFile
public final RegularFileProperty getNetworkIdFile()

The file that contains the network ID created by this task. Defaults to "$buildDir/.docker/$taskpath-networkId.txt". If path contains ':' it will be replaced by '_'.

getNetworkId

@Internal
public final Property<String> getNetworkId()

The ID of the network created. The value of this property requires the task action to be executed.

runRemoteCommand

public void runRemoteCommand()

Specified by:

runRemoteCommand in class AbstractDockerRemoteApiTask