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

Parameters

  • url (URL) –

  • path (str) –

  • state (str) –

  • error_message (str) –

tamr_client.backup.get_all(session, instance)[source]

Get all backups that have been initiated for a Tamr instance.

Parameters

  • session (Session) – Tamr session

  • instance (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 session

  • instance (Instance) – Tamr instance

  • resource_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 session

  • instance (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 session

  • backup (Backup) – A Tamr backup

Return type

Backup

Returns

Canceled backup

Raises
tamr_client.backup.poll(session, backup)[source]

Poll this backup for server-side updates.

Does not update the Backup object. Instead, returns a new Backup.

Parameters

  • session (Session) – Tamr session

  • backup (Backup) – Tamr backup to be polled

Return type

Backup

Returns

A Tamr backup

Raises

backup.NotFound – If no backup found at the specified URL

Exceptions

class tamr_client.backup.NotFound[source]

Raised when referencing a backup that does not exist on the server.

class tamr_client.backup.InvalidOperation[source]

Raised when attempting an invalid operation.