Index
aclaclEntryactualParameteraddCredentialanalyticsServerConfigurationapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

schedule

On this page
Back to index

Summary

This object is responsible for launching a procedure at some time in the future, possibly on a regular interval.
projectName
Stringrequired
The name for the project that must be unique among all projects.
scheduleName
Stringrequired
Name for the schedule; must be unique among all schedules for the project.
actualParameters
Stringoptional
Parameters passed to the invoked procedure/pipeline/process/release/workflow. (Alternate argument name actualParameter.)
applicationName
Stringoptional
The name of the application that owns the process.
applicationProjectName
Stringoptional
Name for the project to which the application belongs to.
beginDate
Stringoptional
The date when this schedule will begin (for example, 2023-05-15).
catalogItemName
Stringoptional
Name of the catalog item to invoke.
catalogName
Stringoptional
Name of the catalog containing the catalog item to invoke.
clearActualParameters
Stringoptional
Whether or not to clear actual parameters for this object.
clearPipelineParameters
Stringoptional
Whether or not to clear pipeline parameters for the schedule.
credentialName
Stringoptional
The name of the credential to use for impersonation.
dataRetentionPolicyName
Stringoptional
The name of the data retention policy to invoke.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
endDate
Stringoptional
The date when this schedule will end (for example, 2023-05-15). The end date is not included in the range of dates.
environmentName
Stringoptional
The name of the environment used to determine where to run the process.
environmentProjectName
Stringoptional
Name for the project to which the environment or environment template belongs to.
environmentTemplateName
Stringoptional
The name of the environment template used to determine the environment where to run the process.
environmentTemplateProjectName
Stringoptional
Name for the project to which the environment template belongs to.
environmentTemplateTierMapName
Stringoptional
The name of the environment template tier map used to determine how to spin up the environment which will be used to run the process.
insertRollingDeployManualStep
Stringoptional
True to indicate a manual step to inject after each phase or batch.
interval
Stringoptional
If specified, the procedure/pipeline/process/release/workflow will be rescheduled over and over again at intervals of this length. Continuous means reschedule the procedure/process/workflow as soon as the previous job finishes.
intervalUnits
Stringoptional
Units for the interval of rescheduling.
misfirePolicy
Stringoptional
Specifies the misfire policy for a schedule.
monthDays
Stringoptional
A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month.
newName
Stringoptional
The new name for an existing object that is being renamed.
pipelineName
Stringoptional
Name of the pipeline to invoke.
pipelineParameters
Stringoptional
Pipeline parameters used by a release schedule to override the default parameters configured in the release. (Alternate argument name pipelineParameter.)
pluginKey
Stringoptional
Name for the project to which the schedule belongs to.
priority
Stringoptional
The priority of the job.
procedureName
Stringoptional
The name of the procedure to invoke.
processName
Stringoptional
The name of the application process to invoke.
releaseName
Stringoptional
Name of the release to invoke.
rollingDeployEnabled
Stringoptional
Perform rolling deployment.
rollingDeployManualStepAssignees
Stringoptional
A list of assignees who receive the notification when rolling deploy iteration completes. (Alternate argument name rollingDeployManualStepAssignee.)
rollingDeployManualStepCondition
Stringoptional
Defines run condition on manual step created during rolling deployment. (Alternate argument name rollingDeployManualStepCondition.)
rollingDeployPhases
Stringoptional
One or more rolling deploy phases to be used for deployment. (Alternate argument name rollingDeployPhase.)
scheduleDisabled
Stringoptional
If this box is checked, the schedule will run. You can disable this schedule whenever necessary.
snapshotName
Stringoptional
The name of the snapshot to be used to invoke the application process.
stagesToRun
Stringoptional
One or more stages to run in a pipeline. (Alternate argument name stagesToRun.)
startTime
Stringoptional
The time of day to begin invoking this schedule's procedure/pipeline/process/release/workflow (24-hour clock, for example, 17:00).
startingStage
Stringoptional
Name of the starting stage in pipeline.
startingStateName
Stringoptional
The name of the starting state of the workflow.
stopTime
Stringoptional
The time of day to stop invoking this schedule's procedure/pipeline/process/release/workflow (don't start a new job after this time); time values use a 24-hour clock, for example, 17:00.
subproject
Stringoptional
Name for the project to which the schedule target object belongs to.
tierMapName
Stringoptional
The name of the tier map used to determine where to run the process.
tierResourceCounts
Stringoptional
Resource count per resource template tier. (Alternate argument name tierResourceCount.)
timeZone
Stringoptional
The time zone to use when interpreting times.
weekDays
Stringoptional
Days of the week: any number of names such as Monday or Tuesday, separated by spaces.
workflowName
Stringoptional
The name of the workflow to invoke.

Usage

There are no usage examples available for schedule.