Sandbox

Sandbox(name, include_in_sandbox_dimension=True, loaded=False, active=False, queued=False)

Bases: TM1Object

Abstraction of a TM1 Sandbox

Parameters:

Name	Type	Description	Default
name	str	name of the Sandbox	required
include_in_sandbox_dimension	bool		True
loaded	bool	use default false when creating sandbox	False
active	bool	use default false when creating sandbox	False
queued	bool	use default false when creating sandbox	False

Source code in TM1py/Objects/Sandbox.py

def __init__(
    self,
    name: str,
    include_in_sandbox_dimension: bool = True,
    loaded: bool = False,
    active: bool = False,
    queued: bool = False,
):
    """
    :param name: name of the Sandbox
    :param include_in_sandbox_dimension:
    :param loaded: use default false when creating sandbox
    :param active: use default false when creating sandbox
    :param queued: use default false when creating sandbox
    """
    self.name = name
    self.include_in_sandbox_dimension = include_in_sandbox_dimension
    self.loaded = loaded
    self.active = active
    self.queued = queued

active = active instance-attribute

body property

include_in_sandbox_dimension property writable

loaded = loaded instance-attribute

name property writable

queued = queued instance-attribute

from_dict(sandbox_as_dict) classmethod

Alternative constructor

Parameters:

Name	Type	Description	Default
sandbox_as_dict	Dict	user as dict	required

Returns:

Type	Description
Sandbox	an instance of this class

Source code in TM1py/Objects/Sandbox.py

@classmethod
def from_dict(cls, sandbox_as_dict: Dict) -> "Sandbox":
    """Alternative constructor

    :param sandbox_as_dict: user as dict
    :return: an instance of this class
    """
    return cls(
        name=sandbox_as_dict["Name"],
        include_in_sandbox_dimension=sandbox_as_dict["IncludeInSandboxDimension"],
        loaded=sandbox_as_dict["IsLoaded"],
        active=sandbox_as_dict["IsActive"],
        queued=sandbox_as_dict["IsQueued"],
    )

from_json(sandbox_as_json) classmethod

Alternative constructor

Parameters:

Name	Type	Description	Default
sandbox_as_json	str	user as JSON string	required

Returns:

Type	Description
Sandbox	sandbox, an instance of this class

Source code in TM1py/Objects/Sandbox.py

@classmethod
def from_json(cls, sandbox_as_json: str) -> "Sandbox":
    """Alternative constructor

    :param sandbox_as_json: user as JSON string
    :return: sandbox, an instance of this class
    """
    sandbox_as_dict = json.loads(sandbox_as_json)
    return cls.from_dict(sandbox_as_dict)