Skip to content

Commit c49763d

Browse files
author
Nick Selpa
committed
Add flavor text explaining each function
1 parent cee2bf0 commit c49763d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

cloudendure/cloudendure.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,6 +501,9 @@ def get_machine_sync_details(self) -> List[Any]:
501501
return response_list
502502

503503
def get_machines_not_synced(self) -> List[Any]:
504+
"""Returns machines in a CloudEndure project which are either rescanning or
505+
backlogged for replication data.
506+
"""
504507
backlogged_machines: List[Any] = []
505508
sync_report: List[Any] = self.get_machine_sync_details()
506509
print(f"INFO: Filtering for backlogged servers in Project: ({self.project_name})")
@@ -514,6 +517,9 @@ def get_machines_not_synced(self) -> List[Any]:
514517
print(f"INFO: All machines are in Continuous Data Replication in Project: ({self.project_name})")
515518

516519
def get_machines_not_started(self) -> List[Any]:
520+
"""Returns machines in a CloudEndure project which are not in a STARTED
521+
state.
522+
"""
517523
not_started_machines: List[Any] = []
518524
sync_report: List[Any] = self.get_machine_sync_details()
519525
print(f"INFO: Getting replication not STARTED for machines in Project: ({self.project_name})")
@@ -527,6 +533,9 @@ def get_machines_not_started(self) -> List[Any]:
527533
print(f"INFO: All machines are STARTED in Project: ({self.project_name})")
528534

529535
def get_stale_machines(self, delta_seconds: int = 86400) -> List[Any]:
536+
"""Returns machines in a CloudEndure project which have not been seen by
537+
the CloudEndure console for greater than 24 hours (86400 seconds [default]).
538+
"""
530539
stale_machines: List[Any] = []
531540
sync_report: List[Any] = self.get_machine_sync_details()
532541
print(f"INFO: Getting stale machines (not seen for {delta_seconds} seconds or later) in Project: ({self.project_name})")

0 commit comments

Comments
 (0)