-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1f184cd
commit 37e94fe
Showing
50 changed files
with
25,792 additions
and
1 deletion.
There are no files selected for viewing
5,453 changes: 5,453 additions & 0 deletions
5,453
docs/0.6.0/_sources/apidocs/ibmcloudant/ibmcloudant.cloudant_v1.rst.txt
Large diffs are not rendered by default.
Oops, something went wrong.
70 changes: 70 additions & 0 deletions
70
.../_sources/apidocs/ibmcloudant/ibmcloudant.couchdb_session_authenticator.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| :py:mod:`ibmcloudant.couchdb_session_authenticator` | ||
| =================================================== | ||
|
|
||
| .. py:module:: ibmcloudant.couchdb_session_authenticator | ||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator | ||
| :parser: myst | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Classes | ||
| ~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`CouchDbSessionAuthenticator <ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator>` | ||
| - .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator | ||
| :parser: myst | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:class:: CouchDbSessionAuthenticator(username: str, password: str, disable_ssl_verification: bool = False) | ||
| :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator | ||
|
|
||
| Bases: :py:obj:`ibm_cloud_sdk_core.authenticators.Authenticator` | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator | ||
| :parser: myst | ||
|
|
||
| .. rubric:: Initialization | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.__init__ | ||
| :parser: myst | ||
|
|
||
| .. py:attribute:: AUTHTYPE_COUCHDB_SESSION | ||
| :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.AUTHTYPE_COUCHDB_SESSION | ||
| :value: 'COUCHDB_SESSION' | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.AUTHTYPE_COUCHDB_SESSION | ||
| :parser: myst | ||
|
|
||
| .. py:method:: authenticate(req: requests.Request) | ||
| :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authenticate | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authenticate | ||
| :parser: myst | ||
|
|
||
| .. py:method:: authentication_type() -> str | ||
| :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authentication_type | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.authentication_type | ||
| :parser: myst | ||
|
|
||
| .. py:method:: set_jar(jar) | ||
| :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.set_jar | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.set_jar | ||
| :parser: myst | ||
|
|
||
| .. py:method:: validate() | ||
| :canonical: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.couchdb_session_authenticator.CouchDbSessionAuthenticator.validate | ||
| :parser: myst |
253 changes: 253 additions & 0 deletions
253
....6.0/_sources/apidocs/ibmcloudant/ibmcloudant.features.changes_follower.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,253 @@ | ||
| :py:mod:`ibmcloudant.features.changes_follower` | ||
| =============================================== | ||
|
|
||
| .. py:module:: ibmcloudant.features.changes_follower | ||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower | ||
| :parser: myst | ||
| :allowtitles: | ||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
| Classes | ||
| ~~~~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`ChangesFollower <ibmcloudant.features.changes_follower.ChangesFollower>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`ChangesFollowerIterator <ibmcloudant.features.changes_follower.ChangesFollowerIterator>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollowerIterator | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`Mode <ibmcloudant.features.changes_follower.Mode>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.Mode | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`TransientErrorSuppression <ibmcloudant.features.changes_follower.TransientErrorSuppression>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.TransientErrorSuppression | ||
| :parser: myst | ||
| :summary: | ||
|
|
||
| Data | ||
| ~~~~ | ||
|
|
||
| .. list-table:: | ||
| :class: autosummary longtable | ||
| :align: left | ||
|
|
||
| * - :py:obj:`BASE_DELAY <ibmcloudant.features.changes_follower.BASE_DELAY>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.BASE_DELAY | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`BATCH_SIZE <ibmcloudant.features.changes_follower.BATCH_SIZE>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.BATCH_SIZE | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`EXP_RETRY_GATE <ibmcloudant.features.changes_follower.EXP_RETRY_GATE>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.EXP_RETRY_GATE | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`FOREVER <ibmcloudant.features.changes_follower.FOREVER>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.FOREVER | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`LONGPOLL_TIMEOUT <ibmcloudant.features.changes_follower.LONGPOLL_TIMEOUT>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.LONGPOLL_TIMEOUT | ||
| :parser: myst | ||
| :summary: | ||
| * - :py:obj:`MIN_CLIENT_TIMEOUT <ibmcloudant.features.changes_follower.MIN_CLIENT_TIMEOUT>` | ||
| - .. autodoc2-docstring:: ibmcloudant.features.changes_follower.MIN_CLIENT_TIMEOUT | ||
| :parser: myst | ||
| :summary: | ||
|
|
||
| API | ||
| ~~~ | ||
|
|
||
| .. py:data:: BASE_DELAY | ||
| :canonical: ibmcloudant.features.changes_follower.BASE_DELAY | ||
| :value: 100 | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.BASE_DELAY | ||
| :parser: myst | ||
|
|
||
| .. py:data:: BATCH_SIZE | ||
| :canonical: ibmcloudant.features.changes_follower.BATCH_SIZE | ||
| :value: 10000 | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.BATCH_SIZE | ||
| :parser: myst | ||
|
|
||
| .. py:class:: ChangesFollower(service: ibmcloudant.cloudant_v1.CloudantV1, *, error_tolerance: int = FOREVER, **kwargs) | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollower | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower | ||
| :parser: myst | ||
|
|
||
| .. rubric:: Initialization | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.__init__ | ||
| :parser: myst | ||
|
|
||
| .. py:property:: error_tolerance | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollower.error_tolerance | ||
| :type: int | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.error_tolerance | ||
| :parser: myst | ||
|
|
||
| .. py:property:: options | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollower.options | ||
| :type: typing.Dict | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.options | ||
| :parser: myst | ||
|
|
||
| .. py:method:: start() -> typing.Iterator[ibmcloudant.cloudant_v1.ChangesResultItem] | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollower.start | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.start | ||
| :parser: myst | ||
|
|
||
| .. py:method:: start_one_off() -> typing.Iterator[ibmcloudant.cloudant_v1.ChangesResultItem] | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollower.start_one_off | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.start_one_off | ||
| :parser: myst | ||
|
|
||
| .. py:method:: stop() -> None | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollower.stop | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollower.stop | ||
| :parser: myst | ||
|
|
||
| .. py:class:: ChangesFollowerIterator(changes_caller, mode: ibmcloudant.features.changes_follower.Mode, error_tolerance: int) | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollowerIterator | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollowerIterator | ||
| :parser: myst | ||
|
|
||
| .. rubric:: Initialization | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollowerIterator.__init__ | ||
| :parser: myst | ||
|
|
||
| .. py:property:: limit | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollowerIterator.limit | ||
| :type: int | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollowerIterator.limit | ||
| :parser: myst | ||
|
|
||
| .. py:method:: retry_delay() | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollowerIterator.retry_delay | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollowerIterator.retry_delay | ||
| :parser: myst | ||
|
|
||
| .. py:property:: since | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollowerIterator.since | ||
| :type: str | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollowerIterator.since | ||
| :parser: myst | ||
|
|
||
| .. py:method:: stop() -> None | ||
| :canonical: ibmcloudant.features.changes_follower.ChangesFollowerIterator.stop | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.ChangesFollowerIterator.stop | ||
| :parser: myst | ||
|
|
||
| .. py:data:: EXP_RETRY_GATE | ||
| :canonical: ibmcloudant.features.changes_follower.EXP_RETRY_GATE | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.EXP_RETRY_GATE | ||
| :parser: myst | ||
|
|
||
| .. py:data:: FOREVER | ||
| :canonical: ibmcloudant.features.changes_follower.FOREVER | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.FOREVER | ||
| :parser: myst | ||
|
|
||
| .. py:data:: LONGPOLL_TIMEOUT | ||
| :canonical: ibmcloudant.features.changes_follower.LONGPOLL_TIMEOUT | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.LONGPOLL_TIMEOUT | ||
| :parser: myst | ||
|
|
||
| .. py:data:: MIN_CLIENT_TIMEOUT | ||
| :canonical: ibmcloudant.features.changes_follower.MIN_CLIENT_TIMEOUT | ||
| :value: 60000 | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.MIN_CLIENT_TIMEOUT | ||
| :parser: myst | ||
|
|
||
| .. py:class:: Mode(*args, **kwds) | ||
| :canonical: ibmcloudant.features.changes_follower.Mode | ||
|
|
||
| Bases: :py:obj:`enum.Enum` | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.Mode | ||
| :parser: myst | ||
|
|
||
| .. rubric:: Initialization | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.Mode.__init__ | ||
| :parser: myst | ||
|
|
||
| .. py:attribute:: FINITE | ||
| :canonical: ibmcloudant.features.changes_follower.Mode.FINITE | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.Mode.FINITE | ||
| :parser: myst | ||
|
|
||
| .. py:attribute:: LISTEN | ||
| :canonical: ibmcloudant.features.changes_follower.Mode.LISTEN | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.Mode.LISTEN | ||
| :parser: myst | ||
|
|
||
| .. py:class:: TransientErrorSuppression(*args, **kwds) | ||
| :canonical: ibmcloudant.features.changes_follower.TransientErrorSuppression | ||
|
|
||
| Bases: :py:obj:`enum.Enum` | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.TransientErrorSuppression | ||
| :parser: myst | ||
|
|
||
| .. rubric:: Initialization | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.TransientErrorSuppression.__init__ | ||
| :parser: myst | ||
|
|
||
| .. py:attribute:: ALWAYS | ||
| :canonical: ibmcloudant.features.changes_follower.TransientErrorSuppression.ALWAYS | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.TransientErrorSuppression.ALWAYS | ||
| :parser: myst | ||
|
|
||
| .. py:attribute:: NEVER | ||
| :canonical: ibmcloudant.features.changes_follower.TransientErrorSuppression.NEVER | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.TransientErrorSuppression.NEVER | ||
| :parser: myst | ||
|
|
||
| .. py:attribute:: TIMER | ||
| :canonical: ibmcloudant.features.changes_follower.TransientErrorSuppression.TIMER | ||
| :value: None | ||
|
|
||
| .. autodoc2-docstring:: ibmcloudant.features.changes_follower.TransientErrorSuppression.TIMER | ||
| :parser: myst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| .. Cloudant Python SDK documentation master file, created by | ||
| sphinx-quickstart on Tue Jan 5 13:47:50 2021. | ||
| Copyright IBM Corporation 2021, 2023. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
| Cloudant Python SDK's Documentation | ||
| =================================== | ||
|
|
||
| CloudantV1 class | ||
| ---------------- | ||
|
|
||
| :class:`CloudantV1 <ibmcloudant.cloudant_v1.CloudantV1>` | ||
|
|
||
| Modules | ||
| ------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 4 | ||
|
|
||
| cloudant_v1 <apidocs/ibmcloudant/ibmcloudant.cloudant_v1> | ||
| couchdb_session_authenticator <apidocs/ibmcloudant/ibmcloudant.couchdb_session_authenticator> | ||
| changes_follower <apidocs/ibmcloudant/ibmcloudant.features.changes_follower> | ||
|
|
||
| Indices and tables | ||
| ------------------ | ||
|
|
||
| * :ref:`genindex` | ||
| * :ref:`modindex` |
Oops, something went wrong.