addResourceTemplateToEnvironmentTemplateTier
Adds the given resource template to the given environment template tier.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentTemplateName | String | The name of the environment template. (Required) |
environmentTemplateTierName | String | Name for the environment template tier; must be unique among all tiers for the environment template. (Required) |
resourceTemplateName | String | Name for the resource template; must be unique among all resource templates. (Required) |
resourceCount | Integer | The number of resources to be spun from a given resource template |
resourceTemplateProjectName | String | Name for the project to which the resource template belongs to. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.addResourceTemplateToEnvironmentTemplateTier(
projectName: 'test-projectName',
environmentTemplateName: 'test-environmentTemplateName',
environmentTemplateTierName: 'test-environmentTemplateTierName',
resourceTemplateName: 'test-resourceTemplateName'
/* optional arguments */)
addResourceToEnvironmentTemplateTier
Adds the given resource to the given environment template tier.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentTemplateName | String | The name of the environment template. (Required) |
environmentTemplateTierName | String | Name for the environment template tier; must be unique among all tiers for the environment template. (Required) |
resourceName | String | Name for the resource; must be unique among all resources. (Required) |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.addResourceToEnvironmentTemplateTier(
projectName: 'test-projectName',
environmentTemplateName: 'test-environmentTemplateName',
environmentTemplateTierName: 'test-environmentTemplateTierName',
resourceName: 'test-resourceName')
createEnvironmentTemplateTier
Create a new environment template tier.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentTemplateName | String | The name of the environment template. (Required) |
environmentTemplateTierName | String | Name for the environment template tier; must be unique among all tiers for the environment template. (Required) |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
resourceCount | Integer | The number of resources to be spun from a given resource template |
resourceNames | String array | List of resources to add to the environment tier. |
resourceTemplateName | String | Name for the resource template; must be unique among all resource templates. |
resourceTemplateProjectName | String | Name for the project to which the resource template belongs to. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.createEnvironmentTemplateTier(
projectName: 'test-projectName',
environmentTemplateName: 'test-environmentTemplateName',
environmentTemplateTierName: 'test-environmentTemplateTierName'
/* optional arguments */)
deleteEnvironmentTemplateTier
Deletes an environment template tier.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentTemplateName | String | The name of the environment template. (Required) |
environmentTemplateTierName | String | Name for the environment template tier; must be unique among all tiers for the environment template. (Required) |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.deleteEnvironmentTemplateTier(
projectName: 'test-projectName',
environmentTemplateName: 'test-environmentTemplateName',
environmentTemplateTierName: 'test-environmentTemplateTierName')
getEnvironmentTemplateTier
Retrieve an environment template tier by name.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentTemplateName | String | The name of the environment template. (Required) |
environmentTemplateTierName | String | Name for the environment template tier; must be unique among all tiers for the environment template. (Required) |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.getEnvironmentTemplateTier(
projectName: 'test-projectName',
environmentTemplateName: 'test-environmentTemplateName',
environmentTemplateTierName: 'test-environmentTemplateTierName')
getEnvironmentTemplateTiers
Retrieve all environment template tiers in an environment template.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentTemplateName | String | The name of the environment template. (Required) |
includeTemplateDetails | Boolean | True to include resource template details. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.getEnvironmentTemplateTiers(
projectName: 'test-projectName',
environmentTemplateName: 'test-environmentTemplateName'
/* optional arguments */)
modifyEnvironmentTemplateTier
Modify an environment template tier.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
environmentTemplateName | String | The name of the environment template. (Required) |
environmentTemplateTierName | String | Name for the environment template tier; must be unique among all tiers for the environment template. (Required) |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName | String | New name for an existing object that is being renamed. |
resourceCount | Integer | The number of resources to be spun from a given resource template |
resourceNames | String array | List of resources to add to the environment tier. |
resourceTemplateName | String | Name for the resource template; must be unique among all resource templates. |
resourceTemplateProjectName | String | Name for the project to which the resource template belongs to. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.modifyEnvironmentTemplateTier(
projectName: 'test-projectName',
environmentTemplateName: 'test-environmentTemplateName',
environmentTemplateTierName: 'test-environmentTemplateTierName'
/* optional arguments */)