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.

CloudBees Flow

cloudBeesFlowCallRestApi: CloudBees Flow - Call REST API

Call CloudBees Flow REST API
  • parameters (optional)
    Specify the parameters for the REST API. Parameters are transformed into JSON object and used within body of HTTP request.
      Array/List
      Nested Object
    • key
      • Type: String
    • value
      • Type: String
  • body (optional)
    Specify the body for the REST API. This parameter is not used if 'Parameters' are provided.
    • Type: String
  • configuration (optional)
    Specify the name of the CloudBees Flow configuration.
    • Type: String
  • envVarNameForResult (optional)
    If provided, result of calling CloudBees REST API (json output) will be stored within provided environment variable available within build.
    • Type: String
  • httpMethod (optional)
    Specify the HTTP Method
    • Type: String
  • urlPath (optional)
    Specify the URL Path for the REST API
    • Type: String

cloudBeesFlowDeployApplication: CloudBees Flow - Deploy Application

Deploy application using CloudBees Flow.
  • applicationName (optional)
    Specify the CloudBees Flow application process name
    • Type: String
  • applicationProcessName (optional)
    Specify parameters for the CloudBees Flow pipeline.
    • Type: String
  • configuration (optional)
    Specify the name of the CloudBees Flow configuration.
    • Type: String
  • deployParameters (optional)
    • Type: String
  • environmentName (optional)
    Specify the CloudBees Flow environment name
    • Type: String
  • projectName (optional)
    Specify the CloudBees Flow project name.
    • Type: String
  • validationTrigger (optional)
    • Type: String

step([$class: 'ElectricFlowGenericRestApi']): CloudBees Flow - Call REST API

Call CloudBees Flow REST API
  • parameters (optional)
    Specify the parameters for the REST API. Parameters are transformed into JSON object and used within body of HTTP request.
      Array/List
      Nested Object
    • key
      • Type: String
    • value
      • Type: String
  • body (optional)
    Specify the body for the REST API. This parameter is not used if 'Parameters' are provided.
    • Type: String
  • configuration (optional)
    Specify the name of the CloudBees Flow configuration.
    • Type: String
  • envVarNameForResult (optional)
    If provided, result of calling CloudBees REST API (json output) will be stored within provided environment variable available within build.
    • Type: String
  • httpMethod (optional)
    Specify the HTTP Method
    • Type: String
  • urlPath (optional)
    Specify the URL Path for the REST API
    • Type: String

cloudBeesFlowRunPipeline: CloudBees Flow - Run Pipeline

Run a CloudBees Flow pipeline.
  • addParam (optional)
    • Type: String
  • additionalOption (optional)
      net.sf.json.JSONArray
  • configuration (optional)
    Specify the name of the CloudBees Flow configuration.
    • Type: String
  • pipelineName (optional)
    Specify the CloudBees Flow pipeline name.
    • Type: String
  • projectName (optional)
    Specify the CloudBees Flow project name.
    • Type: String

cloudBeesFlowCreateAndDeployAppFromJenkinsPackage: CloudBees Flow - Create/Deploy Application from Deployment Package

Create/Deploy an application in CloudBees Flow from a deployment package.
  • configuration
    Specify the name of the CloudBees Flow configuration.
    • Type: String
  • filePath
    Specify the location or path for the deployment package to be published to CloudBees Flow. For e.g., MyProject/target
    • Type: String

cloudBeesFlowRunProcedure: CloudBees Flow - Run Procedure

Run a procedure in CloudBees Flow.
  • configuration (optional)
    Specify the name of the CloudBees Flow configuration.
    • Type: String
  • procedureName (optional)
    Specify the CloudBees Flow procedure name
    • Type: String
  • procedureParameters (optional)
    • Type: String
  • projectName (optional)
    Specify the CloudBees Flow project name.
    • Type: String

cloudBeesFlowTriggerRelease: CloudBees Flow - Trigger Release

Trigger release in CloudBees Flow
  • configuration (optional)
    Specify the name of the CloudBees Flow configuration.
    • Type: String
  • parameters (optional)
    • Type: String
  • projectName (optional)
    Specify the CloudBees Flow project name.
    • Type: String
  • releaseName (optional)
    Specify the CloudBees Flow release name.
    • Type: String
  • startingStage (optional)
    • Type: String
  • validationTrigger (optional)
    • Type: String

cloudBeesFlowPublishArtifact: CloudBees Flow - Publish Artifact

Publish artifact to CloudBees Flow Artifact Repository.
  • repositoryName
    Specify the name of the CloudBees Flow Repository.
    • Type: String
  • artifactName
    Specify the name of the application artifact using the format <group_id>:<artifact_key>. For e.g., "com.example:helloworld"
    • Type: String
  • artifactVersion
    Specify the version of the application artifact. For e.g., you can specify 1.0 or 1.0-$BUILD_TAG that is based on Jenkins environment variable.
    • Type: String
  • filePath
    Specify the location or path for the artifact files to be published to CloudBees Flow. For e.g., MyProject/**/*-$BUILD_NUMBER.war.
    • Type: String
  • configuration
    Specify the name of the CloudBees Flow configuration.
    • 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.