Package io.github.vansencool.dexternally

Class DExternallyTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.vansencool.dexternally.DExternallyTask
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 abstract class DExternallyTask extends org.gradle.api.DefaultTask
A Gradle task that uploads files to a remote server.

  • Nested Class Summary

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

    org.gradle.api.Task.Namer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Boolean
    compression
    Whether to use compression for the SSH connection.
    Integer
    connectTimeout
    The timeout for the connection in milliseconds.
    List<File>
    files
    The files to be uploaded.
    String
    host
    The host of the remote server.
    String
    password
    The password for SSH authentication.
    Integer
    port
    The port for SSH connection.
    String
    remote
    The remote directory where the file(s) will be uploaded.
    Integer
    sshTimeout
    The timeout for the SSH connection in milliseconds.
    String
    user
    The user for SSH authentication.

    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
    DExternallyTask()
    Constructor for the DExternallyTask.

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getCompression()
    Gets whether to use compression for the SSH connection.
    Integer
    getConnectTimeout()
    Gets the timeout for the connection in milliseconds.
    List<File>
    getFiles()
    Gets the files to be uploaded.
    String
    getHost()
    Gets the host of the remote server.
    String
    getPassword()
    Gets the password for SSH authentication.
    Integer
    getPort()
    Gets the port for SSH connection.
    String
    getRemote()
    Gets the remote directory where the file(s) will be uploaded.
    Integer
    getSshTimeout()
    Gets the timeout for the SSH connection in milliseconds.
    String
    getUser()
    Gets the user for SSH authentication.
    void
    upload()
    Uploads the specified files to the remote server.

    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, getConvention, 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, getConvention, notCompatibleWithConfigurationCache

  • Field Details

    • host

      @Input public String host
      The host of the remote server.

    • user

      @Input public String user
      The user for SSH authentication.

    • password

      @Input public String password
      The password for SSH authentication.

    • remote

      @Input @Optional public String remote
      The remote directory where the file(s) will be uploaded. Defaults to the root directory if not set.

    • port

      @Input @Optional public Integer port
      The port for SSH connection.

    • compression

      @Input @Optional public Boolean compression
      Whether to use compression for the SSH connection.

    • sshTimeout

      @Input @Optional public Integer sshTimeout
      The timeout for the SSH connection in milliseconds.

    • connectTimeout

      @Input @Optional public Integer connectTimeout
      The timeout for the connection in milliseconds.

    • files

      @InputFiles @PathSensitive(RELATIVE) public List<File> files
      The files to be uploaded.

  • Constructor Details

    • DExternallyTask

      public DExternallyTask()
      Constructor for the DExternallyTask.

  • Method Details

    • getHost

      public String getHost()
      Gets the host of the remote server.
      Returns:
      the host of the remote server

    • getUser

      public String getUser()
      Gets the user for SSH authentication.
      Returns:
      the user for SSH authentication

    • getPassword

      public String getPassword()
      Gets the password for SSH authentication.
      Returns:
      the password for SSH authentication

    • getRemote

      public String getRemote()
      Gets the remote directory where the file(s) will be uploaded.
      Returns:
      the remote directory

    • getPort

      public Integer getPort()
      Gets the port for SSH connection.
      Returns:
      the port for SSH connection

    • getFiles

      public List<File> getFiles()
      Gets the files to be uploaded.
      Returns:
      the files to be uploaded

    • getCompression

      public Boolean getCompression()
      Gets whether to use compression for the SSH connection.
      Returns:
      true if compression is enabled, false otherwise

    • getSshTimeout

      public Integer getSshTimeout()
      Gets the timeout for the SSH connection in milliseconds.
      Returns:
      the timeout for the SSH connection

    • getConnectTimeout

      public Integer getConnectTimeout()
      Gets the timeout for the connection in milliseconds.
      Returns:
      the timeout for the connection

    • upload

      public void upload()
      Uploads the specified files to the remote server.