Package io.jenkins.plugins.swarmcloud

Class SwarmSecretConfig

java.lang.Object
hudson.model.AbstractDescribableImpl<SwarmSecretConfig>
io.jenkins.plugins.swarmcloud.SwarmSecretConfig
All Implemented Interfaces:
Describable<SwarmSecretConfig>
public class SwarmSecretConfig extends AbstractDescribableImpl<SwarmSecretConfig>
Configuration for Docker Swarm Secrets to be mounted in agent containers. Supports both external secrets (pre-created in Swarm) and referencing Jenkins credentials.

  • Constructor Details

    • SwarmSecretConfig

      @DataBoundConstructor public SwarmSecretConfig(@NonNull String secretName)

  • Method Details

    • getSecretName

      @NonNull public String getSecretName()

    • getTargetPath

      @Nullable public String getTargetPath()

    • setTargetPath

      @DataBoundSetter public void setTargetPath(String targetPath)

    • getFileName

      @Nullable public String getFileName()

    • setFileName

      @DataBoundSetter public void setFileName(String fileName)

    • getFileMode

      @Nullable public String getFileMode()

    • setFileMode

      @DataBoundSetter public void setFileMode(String fileMode)

    • getUid

      @Nullable public String getUid()

    • setUid

      @DataBoundSetter public void setUid(String uid)

    • getGid

      @Nullable public String getGid()

    • setGid

      @DataBoundSetter public void setGid(String gid)

    • getCredentialsId

      @Nullable public String getCredentialsId()

    • setCredentialsId

      @DataBoundSetter public void setCredentialsId(String credentialsId)

    • getEffectiveTargetPath

      @NonNull public String getEffectiveTargetPath()
      Returns the effective target path for the secret.

    • getEffectiveFileName

      @NonNull public String getEffectiveFileName()
      Returns the effective file name.

    • getFileModeAsLong

      @Nullable public Long getFileModeAsLong()
      Returns the file mode as a Long, or null if not specified.

    • usesCredentials

      public boolean usesCredentials()
      Checks if this secret should be created from Jenkins credentials.