Index
aclaclEntryactualParameteraddCredentialapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

stateDefinition

On this page
Back to index

Summary

A state definition in a workflow definition. Each workflow can contain one or more states.
projectName
Stringrequired
The name for the project that must be unique among all projects.
stateDefinitionName
Stringrequired
The name used for the state definition.
workflowDefinitionName
Stringrequired
The name of the workflow definition.
actualParameters
Stringoptional
The actual parameters to the state definition's process. (Alternate argument name actualParameter.)
clearActualParameters
Stringoptional
True if the state definition should remove all actual parameters to the process.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName
Stringoptional
The new name for an existing object that is being renamed.
startable
Stringoptional
True if the workflow can begin in this state.
subprocedure
Stringoptional
The name of the subprocedure.
subproject
Stringoptional
The name of the project that contains the subprocedure.
substartingState
Stringoptional
The name of the starting state to use in the subworkflowDefinition.
subworkflowDefinition
Stringoptional
The name of the subworkflowDefinition.

Usage

There are no usage examples available for stateDefinition.