class documentation

class LegalHoldsPolicyCreateError(LegalHoldsError): (source)

View In Hierarchy

This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar team.LegalHoldsPolicyCreateError.start_date_is_later_than_end_date: Start date must be earlier than end date. :ivar team.LegalHoldsPolicyCreateError.empty_members_list: The users list must have at least one user. :ivar team.LegalHoldsPolicyCreateError.invalid_members: Some members in the members list are not valid to be placed under legal hold. :ivar team.LegalHoldsPolicyCreateError.number_of_users_on_hold_is_greater_than_hold_limitation: You cannot add more than 5 users in a legal hold. :ivar team.LegalHoldsPolicyCreateError.transient_error: Temporary infrastructure failure, please retry. :ivar team.LegalHoldsPolicyCreateError.name_must_be_unique: The name provided is already in use by another legal hold. :ivar team.LegalHoldsPolicyCreateError.team_exceeded_legal_hold_quota: Team exceeded legal hold quota. :ivar team.LegalHoldsPolicyCreateError.invalid_date: The provided date is invalid.

Method is_empty_members_list Check if the union tag is ``empty_members_list``.
Method is_invalid_date Check if the union tag is ``invalid_date``.
Method is_invalid_members Check if the union tag is ``invalid_members``.
Method is_name_must_be_unique Check if the union tag is ``name_must_be_unique``.
Method is_number_of_users_on_hold_is_greater_than_hold_limitation Check if the union tag is ``number_of_users_on_hold_is_greater_than_hold_limitation``.
Method is_start_date_is_later_than_end_date Check if the union tag is ``start_date_is_later_than_end_date``.
Method is_team_exceeded_legal_hold_quota Check if the union tag is ``team_exceeded_legal_hold_quota``.
Method is_transient_error Check if the union tag is ``transient_error``.
Class Variable empty_members_list Undocumented
Class Variable invalid_date Undocumented
Class Variable invalid_members Undocumented
Class Variable name_must_be_unique Undocumented
Class Variable number_of_users_on_hold_is_greater_than_hold_limitation Undocumented
Class Variable start_date_is_later_than_end_date Undocumented
Class Variable team_exceeded_legal_hold_quota Undocumented
Class Variable transient_error Undocumented
Method _process_custom_annotations Undocumented

Inherited from LegalHoldsError:

Method is_insufficient_permissions Check if the union tag is ``insufficient_permissions``.
Method is_other Check if the union tag is ``other``.
Method is_unknown_legal_hold_error Check if the union tag is ``unknown_legal_hold_error``.
Class Variable insufficient_permissions Undocumented
Class Variable other Undocumented
Class Variable unknown_legal_hold_error Undocumented
Class Variable _catch_all Undocumented
def is_empty_members_list(self): (source)

Check if the union tag is ``empty_members_list``. :rtype: bool

def is_invalid_date(self): (source)

Check if the union tag is ``invalid_date``. :rtype: bool

def is_invalid_members(self): (source)

Check if the union tag is ``invalid_members``. :rtype: bool

def is_name_must_be_unique(self): (source)

Check if the union tag is ``name_must_be_unique``. :rtype: bool

def is_number_of_users_on_hold_is_greater_than_hold_limitation(self): (source)

Check if the union tag is ``number_of_users_on_hold_is_greater_than_hold_limitation``. :rtype: bool

def is_start_date_is_later_than_end_date(self): (source)

Check if the union tag is ``start_date_is_later_than_end_date``. :rtype: bool

def is_team_exceeded_legal_hold_quota(self): (source)

Check if the union tag is ``team_exceeded_legal_hold_quota``. :rtype: bool

def is_transient_error(self): (source)

Check if the union tag is ``transient_error``. :rtype: bool

empty_members_list = (source)

Undocumented

invalid_date = (source)

Undocumented

invalid_members = (source)

Undocumented

name_must_be_unique = (source)

Undocumented

number_of_users_on_hold_is_greater_than_hold_limitation = (source)

Undocumented

start_date_is_later_than_end_date = (source)

Undocumented

team_exceeded_legal_hold_quota = (source)

Undocumented

transient_error = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)