Variable

Variables module.

A collection of functions for working with vRA Code Stream variables.

class codestream.api.codestream.variable.VRAVariable(var_project, var_name, var_desc, var_type, var_value)

Bases: object

Variable as a reusable class.

Parameters:

object (class) – Reusable object holding vRA variable info.

__dict__ = mappingproxy({'__module__': 'codestream.api.codestream.variable', '__doc__': '\n    Variable as a reusable class.\n\n    Args:\n        object (class): Reusable object holding vRA variable info.\n    ', '__init__': <function VRAVariable.__init__>, '__dict__': <attribute '__dict__' of 'VRAVariable' objects>, '__weakref__': <attribute '__weakref__' of 'VRAVariable' objects>, '__annotations__': {}})

__init__(var_project, var_name, var_desc, var_type, var_value)

Fields for a variable in vRA.

__module__ = 'codestream.api.codestream.variable'

__weakref__

list of weak references to the object (if defined)

codestream.api.codestream.variable.get(bearer_token, settings=<class 'codestream.common.VRASettings'>, variable=<class 'codestream.api.codestream.variable.VRAVariable'>)

Get a variable.

Parameters:

• settings (VRASettings) – vRA Settings

• bearer_token (string) – vRA Access Token

• variable (VRAVariable) – vRA Variable fields.

codestream.api.codestream.variable.update(bearer_token, settings=<class 'codestream.common.VRASettings'>, variable=<class 'codestream.api.codestream.variable.VRAVariable'>)

Update a variable.

Parameters:

• settings (VRASettings) – vRA Settings

• bearer_token (string) – vRA Access Token

• variable (VRAVariable) – vRA Variable fields.