The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

File Operations Plugin

fileOperations: File Operations

  • fileOperations
      Array/List
      Nested Choice of Objects
    • fileCopyOperation
      • includes
        Files included to copy, this supports ant-style file pattern ex: target/*/final*.xml
        • Type: String
      • excludes
        Files excluded from copying, this supports ant-style file pattern ex: target/*/final*.xml
        • Type: String
      • targetLocation
        Destination folder location to copy the files. Base directory is workspace.
        • Type: String
      • flattenFiles
        If selected, files are copied directly to the target location without preserving source file sub-directory structure.
        • Type: boolean
      • renameFiles
        By default, the file name of the source file is preserved. When flattening files, this can cause problems if files of the same name exist in multiple source sub-directories. Selecting this option allows the output file name to be manipulated to avoid file name clashes.
        • Type: boolean
      • sourceCaptureExpression
        Java-style regular expression that is run against the full path of each matching source file. This should be used to capture parts of the path that will be used in the target name expression to make each file name unique across all subdirectories.
        • Type: String
      • targetNameExpression
        An expression that provides the desired target file name. This can reference variables captured in the source capture expression by using $1, $2 etc.
        • Type: String
    • fileCreateOperation
      • fileName
        Path and Name of the file to be created in workspace.
        • Type: String
      • fileContent
        File content to be created, use environment variables where needed.
        • Type: String
    • fileDeleteOperation
      • includes
        Files included to delete, this supports ant-style file pattern ex: target/*/final*.xml
        • Type: String
      • excludes
        Files excluded from deleting, this supports ant-style file pattern ex: target/*/final*.xml
        • Type: String
    • fileDownloadOperation
      • url
        Url of the file to download.
        • Type: String
      • userName
        • Type: String
      • password
        • Type: String
      • targetLocation
        Destination location to download the file. Base directory is workspace.
        • Type: String
      • targetFileName
        • Type: String
      • proxyHost
        • Type: String
      • proxyPort
        • Type: String
    • fileJoinOperation
      • sourceFile
        Source file path to copy the content.
        • Type: String
      • targetFile
        Target file path to append the content from source file.
        • Type: String
    • filePropertiesToJsonOperation
      • sourceFile
        Source file path of properties.
        • Type: String
      • targetFile
        Target file path to create or update with json data.
        • Type: String
    • fileRenameOperation
      • source
        File to be renamed.
        • Type: String
      • destination
        Destination file location to rename. Base directory is workspace.
        • Type: String
    • fileTransformOperation
      • includes
        Files included to copy, this supports ant-style file pattern ex: target/*/final*.xml
        • Type: String
      • excludes
        Files excluded from copying, this supports ant-style file pattern ex: target/*/final*.xml
        • Type: String
    • fileUnTarOperation
      • filePath
        Source tar file location.
        • Type: String
      • targetLocation
        Destination folder location to untar the files. Base directory is workspace.
        • Type: String
      • isGZIP
        • Type: boolean
    • fileUnZipOperation
      • filePath
        Source zip file location.
        • Type: String
      • targetLocation
        Destination folder location to unzip the files. Base directory is workspace.
        • Type: String
    • fileZipOperation
      • folderPath
        Path of the folder to create zip file in workspace.
        • Type: String
    • folderCopyOperation
      • sourceFolderPath
        Folder to be copied.
        • Type: String
      • destinationFolderPath
        Destination folder location to copy the files. Base directory is workspace.
        • Type: String
    • folderCreateOperation
      • folderPath
        Path and Name of the folder to be created in workspace.
        • Type: String
    • folderDeleteOperation
      • folderPath
        Path and Name of the folder to be deleted in workspace.
        • Type: String
    • folderRenameOperation
      • source
        Folder to be renamed.
        • Type: String
      • destination
        Destination folder name to rename. Base directory is workspace.
        • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.