Session commands

createSession

Create a session

Arguments

Argument Name Type Description

expirationDate

String

The date when this session will expire

serviceAccountName

String

Service account name under for which the webhook session needs to be created for

timeZone

String

The time zone to use when interpreting expiration date.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createSession(
                /* optional arguments */)

deleteSession

Delete a session

Arguments

Argument Name Type Description

sessionId

String

Id of the session

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteSession()

getSessions

Retrieve all sessions for a service account

Arguments

Argument Name Type Description

serviceAccountName

String

Service account name under for which the webhook session needs to be created for

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSessions()

login

Login the client with the given credentials.

Arguments

Argument Name Type Description

password

String

Secret value used to identify the account for a particular user.

userName

String

User name under which you wish to login.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.login(
                /* optional arguments */)

logout

Logout the client session.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.logout()

modifySession

Modify a session

Arguments

Argument Name Type Description

sessionId

String

Id of the session

expirationDate

String

The date when this session will expire

timeZone

String

The time zone to use when interpreting expiration date.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifySession(
                /* optional arguments */)