getPipelineRuntimes

Summary

Retrieves pipeline runs.

caseSensitiveSearch

Booleanoptional

Applicable only for case-sensitive databases. When set to True (default), searches are case-sensitive. When set to False, searches are case-insensitive.

filters

Array<Filter>optional

A list of zero or more filter criteria definitions used to define objects to find.

firstResult

Integeroptional

Result pagination: the first row to return.

flowRuntimeId

Stringoptional

The ID of the flow runtime.

flowRuntimeName

Stringoptional

The name of the flow runtime.

maxResults

Integeroptional

Result pagination: the number of rows to return.

pipelineName

Stringoptional

The name of the pipeline.

projectName

Stringoptional

The name of the project.

releaseId

Stringoptional

The ID of the release.

releaseName

Stringoptional

The name of the release.

sortKey

Stringoptional

How to sort the results.

sortOrder

Stringoptional

Specifies the order to sort the results.

Possible values: "ascending", "descending"

viewName

Stringoptional

The name of the view.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.getPipelineRuntimes(
  /* optional arguments */
)▼

Examples

Retrieve number of pipeline runs based on outcome

This example retrieves the number of pipeline runs whose outcome is error.

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

ElectricFlow ef = new ElectricFlow()

// Define filter for the query
Filter pipelineRunFilter = new Filter(
    operator: "equals",
    propertyName: "outcome",
    operand1: "error"
)

// Execute the query with the filter
def result = ef.getPipelineRuntimes(filters: [pipelineRunFilter])▼

You can find the property names, and their associated datatypes for any entity, using describeObject API.