PersonaCategory

createPersonaCategory

Creates a new personaCategory object. Specify the name of the new page with personaCategoryName.

Arguments

Argument Name	Type	Description
personaCategoryName	String	The persona category name. (Required)
afterCategory	String	If specified, the category will be placed after the named category.
beforeCategory	String	If specified, the category will be placed before the named category.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled	Boolean	Whether to enable the PersonaCategory.
personaPages	String array	A list of pages in a persona category.

Argument Name

Type

Description

personaCategoryName

String

The persona category name. (Required)

afterCategory

String

If specified, the category will be placed after the named category.

beforeCategory

String

If specified, the category will be placed before the named category.

description

String

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

enabled

Boolean

Whether to enable the PersonaCategory.

personaPages

String array

A list of pages in a persona category.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createPersonaCategory(
                personaCategoryName: 'test-personaCategoryName'
                /* optional arguments */)

deletePersonaCategory

Deletes the specified personaCategory object by name.

Arguments

Argument Name	Type	Description
personaCategoryName	String	The persona category name. (Required)

Argument Name

Type

Description

personaCategoryName

String

The persona category name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePersonaCategory(
                personaCategoryName: 'test-personaCategoryName')

getPersonaCategories

Retrieves all persona categories.

Arguments

Argument Name	Type	Description
includeDisabled	Boolean	Whether to include disabled PersonaCategories.

Argument Name

Type

Description

includeDisabled

Boolean

Whether to include disabled PersonaCategories.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getPersonaCategory

Retrieves the specified personaCategory object.

Arguments

Argument Name	Type	Description
personaCategoryName	String	The persona category name. (Required)

Argument Name

Type

Description

personaCategoryName

String

The persona category name. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonaCategory(
                personaCategoryName: 'test-personaCategoryName')

modifyPersonaCategory

Modifies the specified personaCategory object.

Arguments

Argument Name	Type	Description
personaCategoryName	String	The persona category name. (Required)
afterCategory	String	If specified, the category will be placed after the named category.
beforeCategory	String	If specified, the category will be placed before the named category.
clearPages	Boolean	Clears persona pages for the category, if modifying.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled	Boolean	Whether to enable the PersonaCategory.
newName	String	The new name for an existing object that is being renamed.
personaPages	String array	A list of pages in a persona category.

Argument Name

Type

Description

personaCategoryName

String

The persona category name. (Required)

afterCategory

String

If specified, the category will be placed after the named category.

beforeCategory

String

If specified, the category will be placed before the named category.

clearPages

Boolean

Clears persona pages for the category, if modifying.

description

String

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

enabled

Boolean

Whether to enable the PersonaCategory.

newName

String

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

personaPages

String array

A list of pages in a persona category.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPersonaCategory(
                personaCategoryName: 'test-personaCategoryName'
                /* optional arguments */)