getTask

Back to index

Summary

Retrieves a task by its name.

projectName

Stringrequired

The name for the project that must be unique among all projects.

stageName

Stringoptional

Name of the stage to which this task belongs to.

taskName

Stringrequired

The name of the task.

gateType

Stringoptional

The type of the gate.

Possible values: "POST", "PRE"

pipelineName

Stringoptional

The name of the pipeline.

releaseName

Stringoptional

The name of the release.

timeZone

Stringoptional

The time zone to use when interpreting times.

validate

Booleanoptional

If passed 1, then all validations check if the definition is complete and valid.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.getTask(
  projectName: "test-projectName",
  taskName: "test-taskName"
  /* optional arguments */
)▼