Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Reservation

3 minute readReference

createReservation

Creates a new reservation.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects. (Required)

reservationName

String

The name of the environment reservation. (Required)

environmentName

String

The name of the environment.

applicationName

String

The name of the application.

beginDate

String

Date of beginning reservation.

blackout

Boolean

Do not allow executions against an environment at specified period.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

endDate

String

The date when reservation event ends.

environmentProjectName

String

The name of the environment project name.

environmentTierName

String

The name of the environment tier.

monthDays

String

A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month.

overlap

Boolean

Allow to overlap the reservation.

pipelineName

String

The name of the pipeline.

recurrence

Boolean

Recurrence reservation.

recurrenceEndDate

String

Date of beginning reservation.

releaseName

String

The name of the release.

timeZone

String

The time zone to use when interpreting times.

weekDays

String

Days of the week: any number of names such as Monday or Tuesday, separated by spaces.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createReservation(
                projectName: 'test-projectName',
                reservationName: 'test-reservationName'
                /* optional arguments */)
▼

deleteReservation

Deletes the specified reservation.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects. (Required)

reservationName

String

The name of the environment reservation. (Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteReservation(
                projectName: 'test-projectName',
                reservationName: 'test-reservationName')
▼

getReservation

Retrieves an environment reservation by its name.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects. (Required)

reservationName

String

The name of the environment reservation. (Required)

beginDate

String

Date of beginning reservation.

endDate

String

The date when reservation event ends.

includeTimeslots

Boolean

Include timeslots in reservation response.

timeZone

String

The time zone to use when interpreting times.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getReservation(
                projectName: 'test-projectName',
                reservationName: 'test-reservationName'
                /* optional arguments */)
▼

getReservations

Retrieves all environment reservations.

Arguments

Argument Name Type Description

projectName

String

Name for the project; must be unique among all projects.

applicationName

String

The name of the application.

beginDate

String

Date of beginning reservation.

blackout

Boolean

Blackout reservations.

endDate

String

The date when reservation event ends.

environmentName

String

The name of the environment.

environmentProjectName

String

The name of the environment project name.

environmentTierName

String

The name of the environment tier.

includeTimeslots

Boolean

Include timeslots in reservation response.

pipelineName

String

The name of the pipeline.

releaseName

String

The name of the release.

reserverTypes

String array

Reserver types.

timeZone

String

The time zone to use when interpreting times.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getReservations(
                /* optional arguments */)
▼

modifyReservation

Modifies an environment reservation.

Arguments

Argument Name Type Description

projectName

String

The name for the project that must be unique among all projects. (Required)

reservationName

String

The name of the environment reservation. (Required)

environmentName

String

The name of the environment.

applicationName

String

The name of the application.

beginDate

String

Date of beginning reservation.

blackout

Boolean

Do not allow executions against an environment at specified period.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

endDate

String

The date when reservation event ends.

environmentProjectName

String

The name of the environment project name.

environmentTierName

String

The name of the environment tier.

monthDays

String

A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month.

newName

String

The new name for an existing object that is being renamed.

overlap

Boolean

Allow to overlap the reservation.

pipelineName

String

The name of the pipeline.

recurrence

Boolean

Recurrence reservation.

recurrenceEndDate

String

Date of beginning reservation.

releaseName

String

The name of the release.

timeZone

String

The time zone to use when interpreting times.

weekDays

String

Days of the week: any number of names such as Monday or Tuesday, separated by spaces.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyReservation(
                projectName: 'test-projectName',
                reservationName: 'test-reservationName'
                /* optional arguments */)
▼
repository
resource