alias_api.flatten_group_nodes
- alias_api.flatten_group_nodes(*args, **kwargs)
Overloaded function.
flatten_group_nodes() -> int
Flatten all top-level group nodes in the DAG.
This function is deprecated. Use method ungroup with UngroupOption.Collapse instead.
Any group nodes found in the top-level group nodes will have all its children moved to the top-level group node, and then be removed. The result is each group node specified will not contain any nested group nodes.
- return
The status code result of the flatten operation.
- rtype
int(AlStatusCode)
flatten_group_nodes(group_nodes: collections.abc.Sequence[alias_api.AlGroupNode]) -> int
Flatten the specified group nodes.
Any group nodes found in the specified group nodes will have all its children moved to the top-level group node, and then itself will be removed. The result is each group node specified will not contain any nested group nodes.
- param group_nodes
The group nodes to flatten.
- type group_nodes
list<AlGroupNode>
- return
The status code result of the flatten operation.
- rtype
int(AlStatusCode)