mstrio > server > fence

class mstrio.server.fence.Fence(connection, id=None, name=None)

Bases: EntityBase, DeleteMixin

Python representation of a Strategy One Fence object.

Parameters:

  • connection (Connection) –

  • id (str | None) –

  • name (str | None) –

id

ID of the fence.

Type:

str

name

Name of the fence.

Type:

str

rank

Rank or precedence of the fence.

Type:

int

type

Type of fence.

Type:

FenceType

nodes

List of nodes across which the fence is applied.

Type:

list[str]

users

List of users, to which the fence is applied.

Type:

list[User]

user_groups

List of user groups, to which the fence is applied.

Type:

list[UserGroup]

projects

List of projects, to which the fence is applied.

Type:

list[Project]

alter(rank=None, nodes=None, users=None, user_groups=None, projects=None)

Alter the Fence object.

Parameters:

  • rank (int, optional) – Rank or precedence of the fence.

  • nodes (str | list[str], optional) – List of nodes across which the fence is applied.

  • users (User | list[User], optional) – List of users, to which the fence is applied.

  • user_groups (UserGroup | list[UserGroup], optional) – List of user groups, to which the fence is applied.

  • projects (Project | list[Project], optional) – List of projects, to which the fence is applied.

Return type:

None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

  • cls (T) – Class (type) of the objects that should be created.

  • source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

  • connection (Connection, optional) – A MSTR Connection object. Defaults to None.

  • to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

  • with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod create(connection, rank, name, type, nodes, users=None, user_groups=None, projects=None)

Create a new Fence.

Parameters:

  • connection (Connection) – Strategy One connection object returned by connection.Connection()

  • rank (int) – Rank or precedence of the fence.

  • name (str) – Name of the fence.

  • type (FenceType) – Type of fence.

  • nodes (str | list[str]) – List of nodes across which the fence is applied.

  • users (User | list[User], optional) – List of users, to which the fence is applied.

  • user_groups (UserGroup | list[UserGroup], optional) – List of user groups, to which the fence is applied.

  • projects (Project | list[Project], optional) – List of projects, to which the fence is applied.

Returns:

Fence object

Return type:

Fence

delete(force=False)

Delete object.

Parameters:

  • force (bool) – If True, then no additional prompt will be shown before deleting object.

  • self (Entity) –

Returns:

True on success. False otherwise.

Return type:

bool

fetch(attr=None)

Fetch the latest object’s state from the I-Server.

Note

This method can overwrite local changes made to the object.

Parameters:

  • attr (Optional[str]) – Attribute name to be fetched. If not specified

  • dictionary. (it will use all getters specified in _API_GETTERS) –

  • None. (Defaults to) –

Raises:

ValueError – If attr cannot be fetched.

Return type:

None

classmethod from_dict(source, connection, to_snake_case=True, with_missing_value=False)
Overrides Dictable.from_dict() to instantiate an object from

a dictionary without calling any additional getters.

Parameters:

  • cls (T) – Class (type) of an object that should be created.

  • source (dict[str, Any]) – a dictionary from which an object will be constructed.

  • connection (Connection) – A Strategy One Connection object.

  • to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case, default True.

  • with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

list_properties(excluded_properties=None)

Fetches all attributes from the server and converts all properties of the object to a dictionary.

Parameters:

excluded_properties (list[str], optional) – A list of object properties that should be excluded from the dict. Defaults to None.

Returns:

A dictionary which keys are object’s attribute names, and

which values are object’s attribute values.

Return type:

dict

print()

Pretty Print all properties of the object.

Return type:

None

classmethod to_csv(objects, name, path=None, properties=None)

Exports MSTR objects to a csv file.

Optionally, saves only the object properties specified in the properties parameter.

Parameters:

  • objects (T | list[T]) – List of objects of the same type that

  • exported. (will be) –

  • name (str) – The name of the csv file ending with ‘.csv’

  • path (Optional[str], optional) – A path to the directory where the file will be saved. Defaults to None.

  • properties (Optional[list[str]], optional) – A list of object’s attribute names that should be included in the exported file. Defaults to None.

Raises:

  • TypeError – If objects is not of type T or list of type T

  • objects. –

Return type:

None

to_dataframe()

Converts all properties of the object to a dataframe.

Returns:

A DataFrame object containing object properties.

Return type:

DataFrame

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

update_properties()

Save compatible local changes of the object attributes to the I-Server. Changes are retrieved from the self._altered_properties dictionary. After the process of update has finished, self._altered_properties is cleared. For this method to work properly, you must override the _alter_properties() method in a subclass.

Raises:

requests.HTTPError – If I-Server raises exception

Return type:

None

enum mstrio.server.fence.FenceType(value)

Bases: AutoName

Valid values are as follows:

USER_FENCE = FenceType.USER_FENCE
WORKLOAD_FENCE = FenceType.WORKLOAD_FENCE
mstrio.server.fence.list_fences(connection, to_dictionary=False, limit=None, **filters)

Get list of fences.

Parameters:

  • connection (Connection) – Strategy One connection object returned by connection.Connection()

  • to_dictionary (bool, optional) – If True returns dicts, by default (False) returns objects.

  • limit (int, optional) – limit the number of elements returned. If None (default), all objects are returned.

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘rank’]

Returns:

A list of fences objects or dictionaries representing them.

Return type:

list[Fence] | list[dict]