Groovy API reference

Argument models

4 minute readReference

ActionParameter

Parameter passed as an argument for the action to be performed on the object within a container cluster.

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.ActionParameter

def arg = new ActionParameter(
        name: 'name-value',
        value: 'value-value')

ActualParameter

Parameter passed to the invoked procedure/pipeline/process/release/workflow.

Attributes

NameTypeactualParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.ActualParameter

def arg = new ActualParameter(
        actualParameterName: 'actualParameterName-value',
        value: 'value-value')

AdditionalFilter

Filter criteria used to define objects to find.

Attributes

NameTypepropertyName

String

operator

String

operand1

String

operand2

String

filter

array[additionalFilter]

Example

import com.electriccloud.client.groovy.models.AdditionalFilter

def arg = new AdditionalFilter(
        propertyName: 'propertyName-value',
        operator: 'operator-value',
        operand1: 'operand1-value',
        operand2: 'operand2-value',
        filter: 'filter-value')

AttributeDataType

Datatype for a DevOps Insight report attribute or field.

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.AttributeDataType

def arg = new AttributeDataType(
        name: 'name-value',
        value: 'value-value')

AttributePath

Widget parameter used by a DevOps Insight dashboard to display data based on report attribute or field values.

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.AttributePath

def arg = new AttributePath(
        name: 'name-value',
        value: 'value-value')

CfgMgrParameter

Configuration management plugin parameter for the provision resource procedure.

Attributes

NameTypecfgMgrParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.CfgMgrParameter

def arg = new CfgMgrParameter(
        cfgMgrParameterName: 'cfgMgrParameterName-value',
        value: 'value-value')

CloudProviderParameter

Cloud provider plugin parameter for the provision resource procedure.

Attributes

NameTypecloudProviderParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.CloudProviderParameter

def arg = new CloudProviderParameter(
        cloudProviderParameterName: 'cloudProviderParameterName-value',
        value: 'value-value')

Color

Color mapping used when rendering a DevOps Insight dashboard widget.

Attributes

NameTypekey

String

color

String

Example

import com.electriccloud.client.groovy.models.Color

def arg = new Color(
        key: 'key-value',
        color: 'color-value')

ComponentVersion

Component name and version used for snapshot.

Attributes

NameTypecomponentVersionName

String

value

String

Example

import com.electriccloud.client.groovy.models.ComponentVersion

def arg = new ComponentVersion(
        componentVersionName: 'componentVersionName-value',
        value: 'value-value')

Credential

Username/password credential supplied by a user at runtime. The credential is used by the job and then discarded when the job completes.

Attributes

NameTypecredentialName

String

userName

String

Example

import com.electriccloud.client.groovy.models.Credential

def arg = new Credential(
        credentialName: 'credentialName-value',
        userName: 'userName-value',
        password: 'password-value')

CredentialReferenceParameter

Credential reference parameter for procedure run.

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.CredentialReferenceParameter

def arg = new CredentialReferenceParameter(
        name: 'name-value',
        value: 'value-value')

DefinitionParameter

Parameters to supply to define a cluster

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.DefinitionParameter

def arg = new DefinitionParameter(
        name: 'name-value',
        value: 'value-value')

DefinitionSourceParameter

Parameters to resolve the source of the artifact representing microservice definition

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.DefinitionSourceParameter

def arg = new DefinitionSourceParameter(
        name: 'name-value',
        value: 'value-value')

DeployParameter

Parameters to supply to deploy procedure of microservice definition type provider

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.DeployParameter

def arg = new DeployParameter(
        name: 'name-value',
        value: 'value-value')

DestinationMapping

Destination mapping for CI event type.

Attributes

NameTypetype

String

mapping

String

Example

import com.electriccloud.client.groovy.models.DestinationMapping

def arg = new DestinationMapping(
        type: 'type-value',
        mapping: 'mapping-value')

Filter

Filter criteria used to define objects to find.

Attributes

NameTypepropertyName

String

operator

String

operand1

String

operand2

String

filter

array[filter]

Example

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

def arg = new Filter(
        propertyName: 'propertyName-value',
        operator: 'operator-value',
        operand1: 'operand1-value',
        operand2: 'operand2-value',
        filter: 'filter-value')

FormParameter

Dsl form parameter used for catalog item run.

Attributes

NameTypeformParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.FormParameter

def arg = new FormParameter(
        formParameterName: 'formParameterName-value',
        value: 'value-value')

HookParameter

Parameter passed to a resource template hook.

Attributes

NameTypehookParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.HookParameter

def arg = new HookParameter(
        hookParameterName: 'hookParameterName-value',
        value: 'value-value')

LinkParameter

Widget parameter used by a DevOps Insight dashboard to construct the drill-down link for the widget.

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.LinkParameter

def arg = new LinkParameter(
        name: 'name-value',
        value: 'value-value')

Option

Ordered list of options.

Attributes

NameTypetext

String

value

String

Example

import com.electriccloud.client.groovy.models.Option

def arg = new Option(
        text: 'text-value',
        value: 'value-value')

PipelineParameter

Parameter passed to the invoked pipeline.

Attributes

NameTypepipelineParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.PipelineParameter

def arg = new PipelineParameter(
        pipelineParameterName: 'pipelineParameterName-value',
        value: 'value-value')

PluginParameter

Parameter passed to the invoked plugin procedure.

Attributes

NameTypepluginParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.PluginParameter

def arg = new PluginParameter(
        pluginParameterName: 'pluginParameterName-value',
        value: 'value-value')

ProvisionParameter

Container service plugin parameter for the provision cluster procedure.

Attributes

NameTypeprovisionParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.ProvisionParameter

def arg = new ProvisionParameter(
        provisionParameterName: 'provisionParameterName-value',
        value: 'value-value')

ReleaseFlowRuntimeMapping

Mapping between releaseId and flowRuntimeId

Attributes

NameTypereleaseId

String

flowRuntimeId

String

Example

import com.electriccloud.client.groovy.models.ReleaseFlowRuntimeMapping

def arg = new ReleaseFlowRuntimeMapping(
        releaseId: 'releaseId-value',
        flowRuntimeId: 'flowRuntimeId-value')

ResourcePhaseMapping

Mapping between resource and rolling deploy phase.

Attributes

NameTyperesourceName

String

rollingDeployPhaseName

String

Example

import com.electriccloud.client.groovy.models.ResourcePhaseMapping

def arg = new ResourcePhaseMapping(
        resourceName: 'resourceName-value',
        rollingDeployPhaseName: 'rollingDeployPhaseName-value')

ResourcePoolPhaseMapping

Mapping between resource pool and rolling deploy phase.

Attributes

NameTyperesourcePoolName

String

rollingDeployPhaseName

String

Example

import com.electriccloud.client.groovy.models.ResourcePoolPhaseMapping

def arg = new ResourcePoolPhaseMapping(
        resourcePoolName: 'resourcePoolName-value',
        rollingDeployPhaseName: 'rollingDeployPhaseName-value')

RollbackParameter

Parameters to store microservice definition rollback parameters

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.RollbackParameter

def arg = new RollbackParameter(
        name: 'name-value',
        value: 'value-value')

Select

Property to return for each object found by a search, find or lookup API.

Attributes

NameTypepropertyName

String

recurse

Boolean

Example

import com.electriccloud.client.groovy.models.Select

def arg = new Select(
        propertyName: 'propertyName-value',
        recurse: 'recurse-value')

Sort

Sort criterion consisting of a property name and a sort order - either an ascending or descending sort order.

Attributes

NameTypepropertyName

String

order

String

Example

import com.electriccloud.client.groovy.models.Sort

def arg = new Sort(
        propertyName: 'propertyName-value',
        order: 'order-value')

TierMapping

Mapping between the application tier and the environment tier.

Attributes

NameTypeapplicationTier

String

environmentTier

String

Example

import com.electriccloud.client.groovy.models.TierMapping

def arg = new TierMapping(
        applicationTier: 'applicationTier-value',
        environmentTier: 'environmentTier-value')

TierResourceCount

Resource count per environment tier

Attributes

NameTypeenvTemplateTierName

String

resourceCount

String

Example

import com.electriccloud.client.groovy.models.TierResourceCount

def arg = new TierResourceCount(
        envTemplateTierName: 'envTemplateTierName-value',
        resourceCount: 'resourceCount-value')

VisualizationProperty

Property or setting used by a widget visualization type.

Attributes

NameTypename

String

value

String

Example

import com.electriccloud.client.groovy.models.VisualizationProperty

def arg = new VisualizationProperty(
        name: 'name-value',
        value: 'value-value')