Argument models

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

Name

Type

name

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

Name	Type	actualParameterName
String	value	String

Name

Type

actualParameterName

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

Name	Type	propertyName
String	operator	String
operand1	String	operand2
String	filter	array[additionalFilter]

Name

Type

propertyName

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

Name	Type	name
String	value	String

Name

Type

name

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

Name	Type	name
String	value	String

Name

Type

name

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

Name	Type	cfgMgrParameterName
String	value	String

Name

Type

cfgMgrParameterName

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

Name	Type	cloudProviderParameterName
String	value	String

Name

Type

cloudProviderParameterName

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

Name	Type	key
String	color	String

Name

Type

key

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

Name	Type	componentVersionName
String	value	String

Name

Type

componentVersionName

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

Name	Type	credentialName
String	userName	String

Name

Type

credentialName

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

Name	Type	name
String	value	String

Name

Type

name

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

Name	Type	name
String	value	String

Name

Type

name

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

Name	Type	name
String	value	String

Name

Type

name

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

Name	Type	name
String	value	String

Name

Type

name

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

Name	Type	type
String	mapping	String

Name

Type

type

String

mapping

String

Example

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

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

ExportParameter

Parameter passed to the invoked DSL export procedure.

Attributes

Name	Type	exportParameterName
String	value	String

Name

Type

exportParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.ExportParameter

def arg = new ExportParameter(
        exportParameterName: 'exportParameterName-value',
        value: 'value-value')

Field

Fields for plugin configuration

Attributes

Name	Type	name
String	value	String

Name

Type

name

String

value

String

Example

import com.electriccloud.client.groovy.models.Field

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

Filter

Filter criteria used to define objects to find.

Attributes

Name	Type	propertyName
String	operator	String
operand1	String	operand2
String	filter	array[filter]

Name

Type

propertyName

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

Name	Type	formParameterName
String	value	String

Name

Type

formParameterName

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

Name	Type	hookParameterName
String	value	String

Name

Type

hookParameterName

String

value

String

Example

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

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

ImportParameter

Parameter passed to the invoked DSL import procedure.

Attributes

Name	Type	importParameterName
String	value	String

Name

Type

importParameterName

String

value

String

Example

import com.electriccloud.client.groovy.models.ImportParameter

def arg = new ImportParameter(
        importParameterName: 'importParameterName-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

Name

Type

name

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

Name	Type	text
String	value	String

Name

Type

text

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

Name	Type	pipelineParameterName
String	value	String

Name

Type

pipelineParameterName

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

Name	Type	pluginParameterName
String	value	String

Name

Type

pluginParameterName

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

Name	Type	provisionParameterName
String	value	String

Name

Type

provisionParameterName

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

Name	Type	releaseId
String	flowRuntimeId	String

Name

Type

releaseId

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

Name	Type	resourceName
String	rollingDeployPhaseName	String

Name

Type

resourceName

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

Name	Type	resourcePoolName
String	rollingDeployPhaseName	String

Name

Type

resourcePoolName

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

Name	Type	name
String	value	String

Name

Type

name

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

Name	Type	propertyName
String	recurse	Boolean

Name

Type

propertyName

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

Name	Type	propertyName
String	order	String

Name

Type

propertyName

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

Name	Type	applicationTier
String	environmentTier	String

Name

Type

applicationTier

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

Name	Type	envTemplateTierName
String	resourceCount	String

Name

Type

envTemplateTierName

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

Name	Type	name
String	value	String

Name

Type

name

String

value

String

Example

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

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