createArchiveConnector

Back to index

Summary

Creates a new archiveConnector object.

archiveConnectorName

Stringrequired

Unique name of the 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.

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.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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