Class WatchQueryIndexOptions

couchbase/management/options.py:724–754

Available options to for a :class:`~couchbase.management.queries.QueryIndexManager`'s watch indexes operation. .. note:: All management options should be imported from `couchbase.management.options`. Args: collection_name (str, optional): **DEPRECATED** - use :class:`~

class WatchQueryIndexOptions(dict):
    """Available options to for a :class:`~couchbase.management.queries.QueryIndexManager`'s watch
    indexes operation.

    .. note::
        All management options should be imported from `couchbase.management.options`.

    Args:
        collection_name (str, optional):  **DEPRECATED** - use :class:`~couchbase.management.queries.CollectionQueryIndexManager`.
            Specifies the collection of the index.
        scope_name (str, optional):  **DEPRECATED** - use :class:`~couchbase.management.queries.CollectionQueryIndexManager`.
            Specifies the scope of the index.
        timeout (timedelta, optional): The timeout for this operation. Defaults to global
            management operation timeout.
        watch_primary (bool, optional): Specifies whether the primary indexes should
            be watched as well.
        parent_span (:class:`~couchbase.observability.tracing.RequestTracer`, optional): The parent span for this operation.
    """  # noqa: E501
    @overload
    def __init__(self,
                 watch_primary: Optional[bool] = None,
                 timeout: Optional[timedelta] = None,
                 scope_name: Optional[str] = None,
                 collection_name: Optional[str] = None,
                 parent_span: Optional[RequestSpan] = None
                 ) -> None:
        ...

    def __init__(self, **kwargs: Any) -> None:
        kwargs = {k: v for k, v in kwargs.items() if v is not None}
        super().__init__(**kwargs)


class BuildDeferredQueryIndexOptions(dict):