heat.engine.parameters 模块

class heat.engine.parameters.BooleanParam(name, schema, value=None)

基类: Parameter

一个类型为“Boolean”的模板参数。

value()

获取参数值，可以选择性地对其进行清理以便输出。

class heat.engine.parameters.CommaDelimitedListParam(name, schema, value=None)

基类: ParsedParameter, Sequence

一个类型为“CommaDelimitedList”的模板参数。

default_parsed()

parse(value)

value()

获取参数值，可以选择性地对其进行清理以便输出。

class heat.engine.parameters.JsonParam(name, schema, value=None)

基类: ParsedParameter

一个其值为 map 或 list 的模板参数。

default_parsed()

parse(value)

value()

获取参数值，可以选择性地对其进行清理以便输出。

class heat.engine.parameters.NumberParam(name, schema, value=None)

基类: Parameter

一个类型为“Number”的模板参数。

value()

获取参数值，可以选择性地对其进行清理以便输出。

class heat.engine.parameters.Parameter(name, schema, value=None)

基类: object

一个模板参数。

default()

返回参数的默认值。

description()

返回参数的描述。

has_default()

返回参数是否具有默认值。

has_value()

参数具有用户或默认值。

hidden()

返回参数是否隐藏。

隐藏的参数应在任何输出到用户的过程中进行清理。

label()

返回标签或参数名称。

name

schema

set_default(value)

tags()

返回与参数关联的标签

user_default

user_value

validate(validate_value=True, context=None)

验证参数。

此方法验证参数的模式是否有效，以及默认值（如果存在）或参数的用户提供值是否符合模式。

value()

获取参数值，可以选择性地对其进行清理以便输出。

class heat.engine.parameters.Parameters(stack_identifier, tmpl, user_params=None, param_defaults=None)

基类: Mapping

堆栈的参数。

堆栈的参数，类型检查、默认值等由堆栈的模板指定。

immutable_params_modified(new_parameters, input_params)

map(func, filter_func=<function Parameters.<lambda>>)

将提供的函数映射到每个 Parameter。

将提供的函数映射到每个 Parameter（可选的过滤器函数）并返回结果字典。

set_stack_id(stack_identifier)

设置 StackId 伪参数值。

validate(validate_value=True, context=None)

验证所有参数。

此方法验证用户提供的参数是否实际上在模板中定义，以及所有参数是否有效。

class heat.engine.parameters.ParsedParameter(name, schema, value=None)

基类: Parameter

具有缓存解析值的模板参数。

property parsed

class heat.engine.parameters.Schema(data_type, description=None, default=None, schema=None, constraints=None, hidden=False, label=None, immutable=False, tags=None)

基类: Schema

参数模式。

BOOLEAN = 'Boolean'

CONSTRAINTS = 'Constraints'

DEFAULT = 'Default'

DESCRIPTION = 'Description'

HIDDEN = 'NoEcho'

IMMUTABLE = 'Immutable'

KEYS = ('Type', 'Description', 'Default', 'Schema', 'Constraints', 'NoEcho', 'Label', 'Immutable', 'Tags')

LABEL = 'Label'

LIST = 'CommaDelimitedList'

MAP = 'Json'

NUMBER = 'Number'

PARAMETER_KEYS = ('Type', 'Default', 'NoEcho', 'AllowedValues', 'AllowedPattern', 'MaxLength', 'MinLength', 'MaxValue', 'MinValue', 'Description', 'ConstraintDescription', 'Label')

SCHEMA = 'Schema'

STRING = 'String'

TAGS = 'Tags'

TYPE = 'Type'

TYPES = ('String', 'Number', 'CommaDelimitedList', 'Json', 'Boolean')

classmethod from_dict(param_name, schema_dict)

从旧版模式字典返回参数模式对象。

参数：

param_name (str) – 拥有模式的参数名称；用于更详细的日志记录

static get_num(key, context)

set_default(default=None)

设置此模式对象的默认值。

validate_value(value, context=None)

class heat.engine.parameters.StringParam(name, schema, value=None)

基类: Parameter

类型为“String”的模板参数。

value()

获取参数值，可以选择性地对其进行清理以便输出。