heat.objects.stack module

Stack object.

class heat.objects.stack.Stack(context=None, **kwargs)

Bases: heat.objects.base.HeatObject, oslo_versionedobjects.base.VersionedObjectDictCompat, oslo_versionedobjects.base.ComparableVersionedObject

classmethod count_all(context, **kwargs)

classmethod count_total_resources(context, stack_id)

classmethod create(context, values)

classmethod delete(context, stack_id)

classmethod encrypt_hidden_parameters(tmpl)

fields = {'action': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'backup': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'convergence': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'created_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'current_deps': Json(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'current_traversal': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'deleted_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'disable_rollback': Boolean(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'nested_depth': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'owner_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'parent_resource_name': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'prev_raw_template': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'prev_raw_template_id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'raw_template_id': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'raw_template_obj': Object(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=False), 'stack_user_project_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'status': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'status_reason': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'tenant': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'timeout': Integer(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'updated_at': DateTime(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'user_creds_id': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True), 'username': String(default=<class 'oslo_versionedobjects.fields.UnspecifiedDefault'>,nullable=True)}

classmethod get_all(context, limit=None, sort_keys=None, marker=None, sort_dir=None, filters=None, show_deleted=False, show_nested=False, show_hidden=False, tags=None, tags_any=None, not_tags=None, not_tags_any=None, eager_load=False)

classmethod get_all_by_owner_id(context, owner_id)

classmethod get_all_by_root_owner_id(context, root_owner_id)

classmethod get_by_id(context, stack_id, **kwargs)

classmethod get_by_name(context, stack_name)

classmethod get_by_name_and_owner_id(context, stack_name, owner_id)

classmethod get_root_id(context, stack_id)

classmethod get_status(context, stack_id)

Return action and status for the given stack.

identifier()

Return an identifier for this stack.

classmethod persist_state_and_release_lock(context, stack_id, engine_id, values)

property raw_template

refresh()

classmethod select_and_update(context, stack_id, values, exp_trvsl=None)

Update the stack by selecting on traversal ID.

Uses UPDATE … WHERE (compare and swap) to catch any concurrent update problem.

If the stack is found with given traversal, it is updated.

If there occurs a race while updating, only one will succeed and other will get return value of False.

property tags

update_and_save(values)

classmethod update_by_id(context, stack_id, values)

Update and return (boolean) if it was updated.

Note: the underlying stack_update filters by current_traversal and stack_id.