XfitPolicy#

class XfitPolicy(policy_type=None, name=None, description=None, updated_time=None, is_default=False, is_enabled=True, categories=None, parameters=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

Parameters:
  • policy_type – (policy_type)

  • name (min=1 chars, max=256 chars) – (name) The name of the policy.

  • description (min=1 chars, max=512 chars) – (description) The description of the policy.

  • updated_time – (updated_time) Last updated time of the policy in ISO-8601 format.

  • is_default – (is_default) Indicates whether the policy is applied by default. (Default False)

  • is_enabled (required) – (is_enabled) Indicates if the policy is enabled or disabled. (Default True)

  • categories (required) – (categories) List of associated category details for the policy.

  • parameters (required) – (parameters) Key value pairs for the relevant properties of a policy. For example, it can hold the lookback period for an Inefficiency exclusion policy.

property categories#

List of associated category details for the policy.

Type:

list[ CategoryDetail ]

property description#

The description of the policy.

Type:

str

property is_default#

Indicates whether the policy is applied by default.

Type:

bool

property is_enabled#

Indicates if the policy is enabled or disabled.

Type:

bool

property name#

The name of the policy.

Type:

str

property parameters#

Key value pairs for the relevant properties of a policy. For example, it can hold the lookback period for an Inefficiency exclusion policy.

Type:

list[ KVStringPair ]

property policy_type#
Type:

PolicyType

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property updated_time#

Last updated time of the policy in ISO-8601 format.

Type:

datetime