modifyArchiveConnector

On this page
Back to index

Summary

Modifies the specified archiveConnector object.
archiveConnectorName
Stringrequired
Unique name of the archive connector.
actualParameters
Array<ActualParameter>optional
Actual parameter values for the configured archive connector.
archiveDataFormat
Stringoptional
The data format that the connector consumes the archived data in.
Possible values: "JSON", "XML"
archiveScript
Stringoptional
Script registered to connect to the archive system and store the data being archived.
clearActualParameters
Booleanoptional
True if the archive connector should remove all actual parameters.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled
Booleanoptional
Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled.
newName
Stringoptional
The new name for an existing object that is being renamed.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifyArchiveConnector( archiveConnectorName: "test-archiveConnectorName" /* optional arguments */ )