createScmSync
[PREVIEW] This API is in preview mode, and therefore subject to change. Create a new git sync.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
scmSyncName | String | Name of Scm Sync (Required) |
branch | String | Branch |
configurationName | String | Configuration name |
configurationProjectName | String | Configuration project name |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
destinationDir | String | Destination directory on the agent where local SCM repository will be located |
excludeObjects | String array | List of paths to the objects that should not be synchronized |
exportParameters | ExportParameter array | List of export parameters. |
importParameters | ImportParameter array | List of import parameters. |
includeObjects | String array | List of paths to the objects that should be synchronized |
relativePath | String | Relative path |
repository | String | Scm repository |
resourceName | String | Resource name |
scmType | String | Specify the type of SCM. |
syncType | String | Specify whether it’s a sync from SCM or to SCM. |
deleteScmSync
getScmSync
getScmSyncs
modifyScmSync
[PREVIEW] This API is in preview mode, and therefore subject to change. Modify an existing git sync.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
scmSyncName | String | Name of Scm Sync (Required) |
branch | String | Branch |
clearExcludeObjects | Boolean | Whether or not to clear exclude objects for this object. |
clearIncludeObjects | Boolean | Whether or not to clear include objects for this object. |
configurationName | String | Configuration name |
configurationProjectName | String | Configuration project name |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
destinationDir | String | Destination directory on the agent where local SCM repository will be located |
excludeObjects | String array | List of paths to the objects that should not be synchronized |
exportParameters | ExportParameter array | List of export parameters. |
importParameters | ImportParameter array | List of import parameters. |
includeObjects | String array | List of paths to the objects that should be synchronized |
newName | String | New name for an existing object that is being renamed. |
relativePath | String | Relative path |
repository | String | Scm repository |
resourceName | String | Resource name |
scmType | String | Specify the type of SCM. |
syncType | String | Specify whether it’s a sync from SCM or to SCM. |
triggerEnabled | Boolean | True if trigger configured and enabled, false otherwise. |