Operation

class tamr_client.Operation(url, type, status=None, description=None)

A Tamr operation

See https://docs.tamr.com/new/reference/the-operation-object

Parameters

• url (URL) –

• type (str) –

• status (Optional[Dict[str, str]]) –

• description (Optional[str]) –

tamr_client.operation.check(session, operation)

Waits for the operation to finish and raises an exception if the operation was not successful.

Parameters

operation (Operation) – Operation to be checked.

Raises

Failed – If the operation failed.

tamr_client.operation.poll(session, operation)

Poll this operation for server-side updates.

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

Parameters

operation (Operation) – Operation to be polled.

Return type

Operation

tamr_client.operation.wait(session, operation, *, poll_interval_seconds=3, timeout_seconds=None)

Continuously polls for this operation’s server-side state.

Parameters

• operation (Operation) – Operation to be polled.

• poll_interval_seconds (int) – Time interval (in seconds) between subsequent polls.

• timeout_seconds (Optional[int]) – Time (in seconds) to wait for operation to resolve.

Raises

TimeoutError – If operation takes longer than timeout_seconds to resolve.

Return type

Operation

tamr_client.operation.succeeded(operation)

Convenience method for checking if operation was successful.

Return type

bool

tamr_client.operation.by_resource_id(session, instance, resource_id)

Get operation by ID

Parameters

resource_id (str) – The ID of the operation

Return type

Operation

Exceptions

class tamr_client.operation.Failed

Raised when checking a failed operation.

class tamr_client.operation.NotFound

Raised when referencing an operation that does not exist on the server.