ArchiveConnector

createArchiveConnector

Create a new archive connector.

Arguments

Argument Name	Type	Description
archiveConnectorName	String	Unique name of the archive connector. (Required)
archiveDataFormat	String	The data format that the connector consumes the archived data in.
archiveScript	String	Script registered to connect to the archive system and store the data being archived.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD.
enabled	Boolean	Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled.

Argument Name

Type

Description

archiveConnectorName

String

Unique name of the archive connector. (Required)

archiveDataFormat

String

The data format that the connector consumes the archived data in.

archiveScript

String

Script registered to connect to the archive system and store the data being archived.

description

String

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

enabled

Boolean

Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled.

Usage

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 */)▼

deleteArchiveConnector

Delete an archive connector.

Arguments

Argument Name	Type	Description
archiveConnectorName	String	Unique name of the archive connector. (Required)

Argument Name

Type

Description

archiveConnectorName

String

Unique name of the archive connector. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteArchiveConnector(
                archiveConnectorName: 'test-archiveConnectorName')▼

getArchiveConnector

Retrieve an archive connector by name.

Arguments

Argument Name	Type	Description
archiveConnectorName	String	Unique name of the archive connector. (Required)

Argument Name

Type

Description

archiveConnectorName

String

Unique name of the archive connector. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getArchiveConnector(
                archiveConnectorName: 'test-archiveConnectorName')▼

getArchiveConnectors

Retrieve all archive connectors.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getArchiveConnectors()▼

modifyArchiveConnector

Modify an archive connector.

Arguments

Argument Name	Type	Description
archiveConnectorName	String	Unique name of the archive connector. (Required)
actualParameters	array	Actual parameter values for the configured archive connector.
archiveDataFormat	String	The data format that the connector consumes the archived data in.
archiveScript	String	Script registered to connect to the archive system and store the data being archived.
clearActualParameters	Boolean	True if the archive connector should remove all actual parameters.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD.
enabled	Boolean	Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled.
newName	String	New name for an existing object that is being renamed.

Argument Name

Type

Description

archiveConnectorName

String

Unique name of the archive connector. (Required)

actualParameters

array

Actual parameter values for the configured archive connector.

archiveDataFormat

String

The data format that the connector consumes the archived data in.

archiveScript

String

Script registered to connect to the archive system and store the data being archived.

clearActualParameters

Boolean

True if the archive connector should remove all actual parameters.

description

String

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

enabled

Boolean

Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled.

newName

String

New name for an existing object that is being renamed.

Usage

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 */)▼