cancellation property

cancellation property

The operation cancellation object, defaulting to None.

Specifies a Cancellation object that can be used to cancel the search operation. It applies to the first call to the search method; to cancel subsequent chunk searches, pass a Cancellation as the second argument of search_next. The search can also be canceled immediately by calling its cancel method, or after a delay with cancel_after, in milliseconds.

Definition:

@property
def cancellation(self):
    ...
@cancellation.setter
def cancellation(self, value):
    ...

See Also