Package com.nirima.jenkins.plugins.docker

Class DockerTemplateBase

java.lang.Object
com.nirima.jenkins.plugins.docker.DockerTemplateBase
All Implemented Interfaces:
Describable<DockerTemplateBase>, Serializable
Direct Known Subclasses:
DockerSimpleTemplate
public class DockerTemplateBase extends Object implements Describable<DockerTemplateBase>, Serializable
Base for docker templates - does not include Jenkins items like labels.
See Also:

  • Field Details

    • hostname

      @CheckForNull public String hostname

    • dnsHosts

      @CheckForNull public String[] dnsHosts

    • dnsSearch

      @CheckForNull public String[] dnsSearch

    • network

      @CheckForNull public String network

    • volumes

      @Deprecated @CheckForNull public String[] volumes
      Deprecated.
      use mounts

    • mounts

      @CheckForNull public String[] mounts
      Every String is mount specification

    • volumesFrom

      @Deprecated @CheckForNull public String volumesFrom
      Deprecated.
      use volumesFrom2

    • volumesFrom2

      @CheckForNull public String[] volumesFrom2
      Every String is volumeFrom specification

    • devices

      @CheckForNull public String[] devices
      Every String is a device to be mapped

    • environment

      @CheckForNull public String[] environment

    • bindPorts

      @CheckForNull public String bindPorts

    • bindAllPorts

      public boolean bindAllPorts

    • memoryLimit

      @CheckForNull public Integer memoryLimit

    • memorySwap

      @CheckForNull public Integer memorySwap

    • cgroupParent

      @CheckForNull public String cgroupParent

    • cpus

      @CheckForNull public String cpus

    • cpuPeriod

      @CheckForNull public Long cpuPeriod

    • cpuQuota

      @CheckForNull public Long cpuQuota

    • cpuShares

      @CheckForNull public Integer cpuShares

    • shmSize

      @CheckForNull public Integer shmSize

    • privileged

      public boolean privileged

    • tty

      public boolean tty

  • Constructor Details

  • Method Details

    • readResolve

      protected Object readResolve()

    • getImage

      @NonNull public String getImage()

    • getPullCredentialsId

      @CheckForNull public String getPullCredentialsId()

    • setPullCredentialsId

      @DataBoundSetter public void setPullCredentialsId(String pullCredentialsId)

    • getDockerCommand

      @CheckForNull public String getDockerCommand()

    • setDockerCommand

      @DataBoundSetter public void setDockerCommand(String dockerCommand)

    • getHostname

      @CheckForNull public String getHostname()

    • setHostname

      @DataBoundSetter public void setHostname(String hostname)

    • getUser

      @CheckForNull public String getUser()

    • setUser

      @DataBoundSetter public void setUser(String user)

    • getExtraGroups

      @CheckForNull public List<String> getExtraGroups()

    • setExtraGroups

      public void setExtraGroups(List<String> extraGroups)

    • setExtraGroupsString

      @DataBoundSetter public void setExtraGroupsString(String extraGroupsString)

    • getExtraGroupsString

      @NonNull public String getExtraGroupsString()

    • getDnsHosts

      @CheckForNull public String[] getDnsHosts()

    • getDnsString

      @NonNull public String getDnsString()

    • setDnsHosts

      public void setDnsHosts(String[] dnsHosts)

    • setDnsString

      @DataBoundSetter public void setDnsString(String dnsString)

    • getDnsSearch

      @CheckForNull public String[] getDnsSearch()

    • getDnsSearchString

      @NonNull public String getDnsSearchString()

    • setDnsSearch

      public void setDnsSearch(String[] dnsSearch)

    • setDnsSearchString

      @DataBoundSetter public void setDnsSearchString(String dnsSearchString)

    • getNetwork

      @CheckForNull public String getNetwork()

    • setNetwork

      @DataBoundSetter public void setNetwork(String network)

    • getMounts

      @CheckForNull public String[] getMounts()

    • setMounts

      public void setMounts(String[] mounts)

    • getMountsString

      @NonNull public String getMountsString()

    • setMountsString

      @DataBoundSetter public void setMountsString(String mountsString)

    • getVolumesFromString

      @NonNull public String getVolumesFromString()

    • setVolumesFromString

      @DataBoundSetter public void setVolumesFromString(String volumesFromString)

    • getDevices

      @CheckForNull public String[] getDevices()

    • getDevicesString

      @NonNull public String getDevicesString()

    • setDevices

      public void setDevices(String[] devices)

    • setDevicesString

      @DataBoundSetter public void setDevicesString(String devicesString)

    • getEnvironment

      @CheckForNull public String[] getEnvironment()

    • getEnvironmentsString

      @NonNull public String getEnvironmentsString()

    • setEnvironment

      public void setEnvironment(String[] environment)

    • setEnvironmentsString

      @DataBoundSetter public void setEnvironmentsString(String environmentsString)

    • getBindPorts

      @CheckForNull public String getBindPorts()

    • setBindPorts

      @DataBoundSetter public void setBindPorts(String bindPorts)

    • isBindAllPorts

      public boolean isBindAllPorts()

    • setBindAllPorts

      @DataBoundSetter public void setBindAllPorts(boolean bindAllPorts)

    • getMemoryLimit

      @CheckForNull public Integer getMemoryLimit()

    • setMemoryLimit

      @DataBoundSetter public void setMemoryLimit(Integer memoryLimit)

    • getMemorySwap

      @CheckForNull public Integer getMemorySwap()

    • setMemorySwap

      @DataBoundSetter public void setMemorySwap(Integer memorySwap)

    • getCgroupParent

      @CheckForNull public String getCgroupParent()

    • setCgroupParent

      @DataBoundSetter public void setCgroupParent(String cgroupParent)

    • getCpus

      @CheckForNull public String getCpus()

    • setCpus

      @DataBoundSetter public void setCpus(String cpus)

    • getCpuPeriod

      @CheckForNull public Long getCpuPeriod()

    • setCpuPeriod

      @DataBoundSetter public void setCpuPeriod(Long cpuPeriod)

    • getCpuQuota

      @CheckForNull public Long getCpuQuota()

    • setCpuQuota

      @DataBoundSetter public void setCpuQuota(Long cpuQuota)

    • getCpuShares

      @CheckForNull public Integer getCpuShares()

    • setCpuShares

      @DataBoundSetter public void setCpuShares(Integer cpuShares)

    • getShmSize

      @CheckForNull public Integer getShmSize()

    • setShmSize

      @DataBoundSetter public void setShmSize(Integer shmSize)

    • isPrivileged

      public boolean isPrivileged()

    • setPrivileged

      @DataBoundSetter public void setPrivileged(boolean privileged)

    • isTty

      public boolean isTty()

    • setTty

      @DataBoundSetter public void setTty(boolean tty)

    • getMacAddress

      @CheckForNull public String getMacAddress()

    • setMacAddress

      @DataBoundSetter public void setMacAddress(String macAddress)

    • getExtraHosts

      @CheckForNull public List<String> getExtraHosts()

    • getExtraHostsString

      @NonNull public String getExtraHostsString()

    • setExtraHosts

      public void setExtraHosts(List<String> extraHosts)

    • setExtraHostsString

      @DataBoundSetter public void setExtraHostsString(String extraHostsString)

    • getSecurityOpts

      @CheckForNull public List<String> getSecurityOpts()

    • getSecurityOptsString

      @NonNull public String getSecurityOptsString()

    • setSecurityOpts

      public void setSecurityOpts(List<String> securityOpts)

    • setSecurityOptsString

      @DataBoundSetter public void setSecurityOptsString(String securityOpts)

    • getCapabilitiesToAdd

      @CheckForNull public List<String> getCapabilitiesToAdd()

    • getCapabilitiesToAddString

      @NonNull public String getCapabilitiesToAddString()

    • setCapabilitiesToAdd

      public void setCapabilitiesToAdd(List<String> capabilitiesToAdd)

    • setCapabilitiesToAddString

      @DataBoundSetter public void setCapabilitiesToAddString(String capabilitiesToAddString)

    • getCapabilitiesToDrop

      @CheckForNull public List<String> getCapabilitiesToDrop()

    • getCapabilitiesToDropString

      @NonNull public String getCapabilitiesToDropString()

    • setCapabilitiesToDrop

      public void setCapabilitiesToDrop(List<String> capabilitiesToDrop)

    • setCapabilitiesToDropString

      @DataBoundSetter public void setCapabilitiesToDropString(String capabilitiesToDropString)

    • getExtraDockerLabels

      @CheckForNull public Map<String,String> getExtraDockerLabels()

    • getExtraDockerLabelsString

      @NonNull public String getExtraDockerLabelsString()

    • setExtraDockerLabels

      public void setExtraDockerLabels(Map<String,String> extraDockerLabels)

    • setExtraDockerLabelsString

      @DataBoundSetter public void setExtraDockerLabelsString(String extraDockerLabelsString)

    • getRegistry

      public org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint getRegistry()

    • getVolumesFrom

      @Deprecated public String getVolumesFrom()
      Deprecated.
      use getVolumesFrom2()
      Returns:
      unused field

    • getVolumesFrom2

      @CheckForNull public String[] getVolumesFrom2()

    • setVolumesFrom2

      public void setVolumesFrom2(String[] volumesFrom)

    • setVolumes

      @Deprecated public void setVolumes(String[] vols)
      Deprecated.
      use setMounts(String[])
      For ConfigurationAsCode compatibility

    • getVolumes

      @Deprecated @CheckForNull public String[] getVolumes()
      Deprecated.
      use getMounts()
      For ConfigurationAsCode compatibility

    • setVolumesString

      @Deprecated public void setVolumesString(String volumesString)
      Deprecated.
      use setMountsString(String)
      For ConfigurationAsCode compatibility

    • getVolumesString

      @Deprecated @NonNull public String getVolumesString()
      Deprecated.
      use getMountsString()
      For ConfigurationAsCode compatibility

    • getDisplayName

      public String getDisplayName()

    • getDockerCommandArray

      @CheckForNull public String[] getDockerCommandArray()

    • getPortMappings

      @NonNull public Iterable<com.github.dockerjava.api.model.PortBinding> getPortMappings()

    • fillContainerConfig

      public com.github.dockerjava.api.command.CreateContainerCmd fillContainerConfig(com.github.dockerjava.api.command.CreateContainerCmd containerConfig)

    • getDescriptor

      public Descriptor<DockerTemplateBase> getDescriptor()
      Specified by:
      getDescriptor in interface Describable<DockerTemplateBase>

    • getFullImageId

      public String getFullImageId()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object