createScmSync

On this page
Back to index

Summary

Creates a new source code synchronization object.
For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.
projectName
Stringrequired
The name for the project that must be unique among all projects.
scmSyncName
Stringrequired
Name of SCM Sync.
branch
Stringoptional
The branch
configurationName
Stringoptional
Configuration name.
configurationProjectName
Stringoptional
Configuration project name.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
destinationDir
Stringoptional
Destination directory on the agent where local SCM repository will be located.
excludeObjects
Array<Unknown>optional
List of paths to the objects that should not be synchronized.
exportParameters
Array<ExportParameter>optional
List of export parameters.
importParameters
Array<ImportParameter>optional
List of import parameters.
includeObjects
Array<Unknown>optional
List of paths to the objects that should be synchronized.
relativePath
Stringoptional
Relative path.
repository
Stringoptional
The SCM repository.
resourceName
Stringoptional
Resource name.
scmType
Stringoptional
Specify the type of SCM.
syncType
Stringoptional
Specify whether it's a sync from SCM or to SCM.
Possible values: "fromScm", "toScm"

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.createScmSync( projectName: "test-projectName", scmSyncName: "test-scmSyncName" /* optional arguments */ )