SearchFilter

2 minute readReference

createSearchFilter

Creates a new custom filter for the currently logged in user.

Arguments

Argument Name Type Description

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

description

String

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

searchQuery

String

Search filter query CLOB.

shared

Boolean

Flag indicating whether the filter is public or private

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.createSearchFilter( objectType: 'test-objectType', displayName: 'test-displayName' /* optional arguments */)

deleteSearchFilter

Deletes a search filter.

Arguments

Argument Name Type Description

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

userName

String

Search filter user name.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.deleteSearchFilter( objectType: 'test-objectType', displayName: 'test-displayName' /* optional arguments */)

getSearchFilter

Retrieves a search filter by name.

Arguments

Argument Name Type Description

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

userName

String

Search filter user name.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getSearchFilter( objectType: 'test-objectType', displayName: 'test-displayName' /* optional arguments */)

getSearchFilters

Retrieves all search filters.

Arguments

Argument Name Type Description

objectType

String

Object type.

userName

String

Search filter user name.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getSearchFilters( /* optional arguments */)

modifySearchFilter

Modifies an existing search filter.

Arguments

Argument Name Type Description

objectType

String

Object type. (Required)

displayName

String

Search filter name. (Required)

description

String

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

newName

String

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

newObjectType

String

Search filter entity type.

searchQuery

String

Search filter query CLOB.

shared

Boolean

Flag indicating whether the filter is public or private

userName

String

Search filter user name.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifySearchFilter( objectType: 'test-objectType', displayName: 'test-displayName' /* optional arguments */)