Argument models commands

actionParameter

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

Attributes

Name Type

name

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.actionParameter

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

actualParameter

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

Attributes

Name Type

actualParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.actualParameter

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

additionalFilter

Filter criteria used to define objects to find.

Attributes

Name Type

propertyName

String

operator

String

operand1

String

operand2

String

filter

array[additionalFilter]

Example

import com.electriccloud.client.groovy.apis.model.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

Name Type

name

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.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

Name Type

name

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.attributePath

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

cfgMgrParameter

Configuration management plugin parameter for the provision resource procedure.

Attributes

Name Type

cfgMgrParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.cfgMgrParameter

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

cloudProviderParameter

Cloud provider plugin parameter for the provision resource procedure.

Attributes

Name Type

cloudProviderParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.cloudProviderParameter

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

color

Color mapping used when rendering a DevOps Insight dashboard widget.

Attributes

Name Type

key

String

color

String

Example

import com.electriccloud.client.groovy.apis.model.color

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

componentVersion

Component name and version used for snapshot.

Attributes

Name Type

componentVersionName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.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

Name Type

credentialName

String

userName

String

password

String

Example

import com.electriccloud.client.groovy.apis.model.credential

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

filter

Filter criteria used to define objects to find.

Attributes

Name Type

propertyName

String

operator

String

operand1

String

operand2

String

filter

array[filter]

Example

import com.electriccloud.client.groovy.apis.model.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

Name Type

formParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.formParameter

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

hookParameter

Parameter passed to a resource template hook.

Attributes

Name Type

hookParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.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

Name Type

name

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.linkParameter

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

option

Ordered list of options.

Attributes

Name Type

text

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.option

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

pipelineParameter

Parameter passed to the invoked pipeline.

Attributes

Name Type

pipelineParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.pipelineParameter

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

pluginParameter

Parameter passed to the invoked plugin procedure.

Attributes

Name Type

pluginParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.pluginParameter

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

provisionParameter

Container service plugin parameter for the provision cluster procedure.

Attributes

Name Type

provisionParameterName

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.provisionParameter

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

releaseFlowRuntimeMapping

Mapping between releaseId and flowRuntimeId

Attributes

Name Type

releaseId

String

flowRuntimeId

String

Example

import com.electriccloud.client.groovy.apis.model.releaseFlowRuntimeMapping

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

resourcePhaseMapping

Mapping between resource and rolling deploy phase.

Attributes

Name Type

resourceName

String

rollingDeployPhaseName

String

Example

import com.electriccloud.client.groovy.apis.model.resourcePhaseMapping

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

resourcePoolPhaseMapping

Mapping between resource pool and rolling deploy phase.

Attributes

Name Type

resourcePoolName

String

rollingDeployPhaseName

String

Example

import com.electriccloud.client.groovy.apis.model.resourcePoolPhaseMapping

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

select

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

Attributes

Name Type

propertyName

String

recurse

Boolean

Example

import com.electriccloud.client.groovy.apis.model.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

Name Type

propertyName

String

order

String

Example

import com.electriccloud.client.groovy.apis.model.sort

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

tierMapping

Mapping between the application tier and the environment tier.

Attributes

Name Type

applicationTier

String

environmentTier

String

Example

import com.electriccloud.client.groovy.apis.model.tierMapping

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

tierResourceCount

Resource count per environment tier

Attributes

Name Type

envTemplateTierName

String

resourceCount

String

Example

import com.electriccloud.client.groovy.apis.model.tierResourceCount

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

visualizationProperty

Property or setting used by a widget visualization type.

Attributes

Name Type

name

String

value

String

Example

import com.electriccloud.client.groovy.apis.model.visualizationProperty

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