modifyWorkspace

Back to index

Summary

Modifies an existing workspace.

workspaceName

Stringrequired

The workspace name.

agentDrivePath

Stringoptional

Pathname to the root directory of a workspace, for use on Windows, specified with a drive letter.

agentUncPath

Stringoptional

Pathname to the root directory of a workspace, for use on Windows, specified with a UNC path.

agentUnixPath

Stringoptional

Pathname to the root directory of a workspace, for use on UNIX.

credentialName

Stringoptional

The name of the impersonation credential to attach to this workspace.

description

Stringoptional

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

local

Booleanoptional

True if the workspace is local.

newName

Stringoptional

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

workspaceDisabled

Booleanoptional

True means this workspace is disabled.

zoneName

Stringoptional

The zone name.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.modifyWorkspace(
  workspaceName: "test-workspaceName"
  /* optional arguments */
)▼