Backup¶
-
class
tamr_client.
Backup
(url, path, state, error_message)[source]¶ A Tamr backup
See https://docs.tamr.com/new/docs/configuration-backup-and-restore
-
tamr_client.backup.
get_all
(session, instance)[source]¶ Get all backups that have been initiated for a Tamr instance.
- Parameters
session (
Session
) – Tamr sessioninstance (
Instance
) – Tamr instance
- Return type
List
[Backup
]- Returns
A list of Tamr backups
- Raises
backup.NotFound – If no backup found at the specified URL
-
tamr_client.backup.
by_resource_id
(session, instance, resource_id)[source]¶ Get information on a specific Tamr backup.
- Parameters
session (
Session
) – Tamr sessioninstance (
Instance
) – Tamr instanceresource_id (
str
) – Resource ID of the backup
- Return type
Backup
- Returns
A Tamr backup
- Raises
backup.NotFound – If no backup found at the specified URL
-
tamr_client.backup.
initiate
(session, instance)[source]¶ Initiate a Tamr backup.
- Parameters
session (
Session
) – Tamr sessioninstance (
Instance
) – Tamr instance
- Return type
Backup
- Returns
Initiated backup
- Raises
backup.InvalidOperation – If attempting an invalid operation
-
tamr_client.backup.
cancel
(session, backup)[source]¶ Cancel a Tamr backup.
- Parameters
session (
Session
) – Tamr sessionbackup (
Backup
) – A Tamr backup
- Return type
Backup
- Returns
Canceled backup
- Raises
backup.NotFound – If no backup found at the specified URL
backup.InvalidOperation – If attempting an invalid operation
-
tamr_client.backup.
poll
(session, backup)[source]¶ Poll this backup for server-side updates.
Does not update the
Backup
object. Instead, returns a newBackup
.- Parameters
session (
Session
) – Tamr sessionbackup (
Backup
) – Tamr backup to be polled
- Return type
Backup
- Returns
A Tamr backup
- Raises
backup.NotFound – If no backup found at the specified URL