Groovy API reference

License

Reference

deleteLicense

Delete a license.

Arguments

Argument NameTypeDescription

productName

String

Product name of the license (Required)

featureName

String

Feature name of the license (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteLicense(
                productName: 'test-productName',
                featureName: 'test-featureName')

getAdminLicense

Get the admin license which can be used when user licenses are maxed out.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getAdminLicense()

getLicense

Return information for one license.

Arguments

Argument NameTypeDescription

productName

String

Product name of the license (Required)

featureName

String

Feature name of the license (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getLicense(
                productName: 'test-productName',
                featureName: 'test-featureName')

getLicenseDetails

Returns licenses details required for UI processing.

Arguments

Argument NameTypeDescription

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getLicenseDetails()

getLicenseUsage

Get the current license usage.

Arguments

Argument NameTypeDescription

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getLicenseUsage()

getLicenses

Returns all license data.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getLicenses()

importLicenseData

Import one or more licenses.

Arguments

Argument NameTypeDescription

licenseData

String

Container elements for license data. Expects embedded XML as CDATA. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.importLicenseData(
                licenseData: 'test-licenseData')