Serializers and Validators
splitiorequests.serializers.environments module
Environment Serializers
- splitiorequests.serializers.environments.dump_environment(environment_obj: Environment) dict
Dump Environment object into dictionary
- Parameters
environment_obj – Environment object
- Returns
Environment data dictionary
- splitiorequests.serializers.environments.dump_environments(environments_obj: List[Environment]) dict
Dump Environments object into dictionary
- Parameters
environments_obj – Environments object
- Returns
Environments data dictionary
- splitiorequests.serializers.environments.load_environment(data: dict, unknown_handler: str = 'RAISE') Optional[Environment]
Environment dict data loader
- Parameters
data – Environment data
unknown_handler – Include or Exclude unknown fields
- Returns
Environment object
- splitiorequests.serializers.environments.load_environments(data: List[Dict[str, Union[str, bool]]], unknown_handler: str = 'RAISE') Optional[List[Environment]]
Environments dict data loader
- Parameters
data – Environments data
unknown_handler – Include or Exclude unknown fields
- Returns
Environments object
splitiorequests.serializers.segments module
Segment and Segment Keys Serializers
- splitiorequests.serializers.segments.dump_segment(segment_obj: Segment) dict
Dump Segment object into dictionary
- Parameters
segment_obj – Segment object
- Returns
Segment data dictionary
- splitiorequests.serializers.segments.dump_segment_keys(segment_keys_obj: SegmentKeys) dict
Dump Segment Keys object into dictionary
- Parameters
segment_keys_obj – Segment Keys object
- Returns
Segment Keys data dictionary
- splitiorequests.serializers.segments.load_segment(data: dict, unknown_handler: str = 'RAISE') Optional[Segment]
Segment dict data loader
- Parameters
data – Segment data
unknown_handler – Include or Exclude unknown fields
- Returns
Segment object
- splitiorequests.serializers.segments.load_segment_keys(data: dict, unknown_handler: str = 'RAISE') Optional[SegmentKeys]
Segment Keys dict data loader
- Parameters
data – Segment Keys data
unknown_handler – Include or Exclude unknown fields
- Returns
Segment Keys object
splitiorequests.serializers.splits module
Split Serializers
- splitiorequests.serializers.splits.dump_split(split_obj: Split) dict
Dump Split object into dictionary
- Parameters
split_obj – Split object
- Returns
Split data dictionary
- splitiorequests.serializers.splits.dump_split_definition(split_definition_obj: SplitDefinition) dict
Dump Split Definition object into dictionary
- Parameters
split_definition_obj – Split Definition object
- Returns
Split Definition data dictionary
- splitiorequests.serializers.splits.dump_split_definitions(split_definitions_obj: SplitDefinitions) dict
Dump Split Definitions object into dictionary
- Parameters
split_definitions_obj – Split Definitions object
- Returns
Split Definitions data dictionary
- splitiorequests.serializers.splits.dump_splits(split_obj: Splits) dict
Dump Splits object into dictionary
- Parameters
split_obj – Splits object
- Returns
Splits data dictionary
- splitiorequests.serializers.splits.load_split(data: dict, unknown_handler: str = 'RAISE') Optional[Split]
Split dict data loader
- Parameters
data – Split data
unknown_handler – Include or Exclude unknown fields
- Returns
Split object
- splitiorequests.serializers.splits.load_split_definition(data: dict, unknown_handler: str = 'RAISE') Optional[SplitDefinition]
Split Definition dict data loader
- Parameters
data – Split Definition data
unknown_handler – Include or Exclude unknown fields
- Returns
SplitDefinition object
- splitiorequests.serializers.splits.load_split_definitions(data: dict, unknown_handler: str = 'RAISE') Optional[SplitDefinitions]
Split Definitions dict data loader
- Parameters
data – Split Definitions data
unknown_handler – Include or Exclude unknown fields
- Returns
SplitDefinitions object
splitiorequests.serializers.traffic_types module
TrafficType Serializers
- splitiorequests.serializers.traffic_types.dump_traffic_types(traffic_types_obj: List[TrafficType]) dict
Dump TrafficType object into dictionary
- Parameters
traffic_types_obj – TrafficType object
- Returns
TrafficType data dictionary
- splitiorequests.serializers.traffic_types.load_traffic_types(data: List[Dict[str, str]], unknown_handler: str = 'RAISE') Optional[List[TrafficType]]
TrafficType dict data loader
- Parameters
data – TrafficType data
unknown_handler – Include or Exclude unknown fields
- Returns
TrafficType object
splitiorequests.serializers.workspaces module
Workspace Serializers
- splitiorequests.serializers.workspaces.dump_workspaces(workspaces_obj: Workspaces) dict
Dump Workspaces object into dictionary
- Parameters
workspaces_obj – Workspaces object
- Returns
Workspaces data dictionary
- splitiorequests.serializers.workspaces.load_workspaces(data: dict, unknown_handler: str = 'RAISE') Optional[Workspaces]
Workspaces dict data loader
- Parameters
data – Workspaces data
unknown_handler – Include or Exclude unknown fields
- Returns
Workspaces object