# {py:mod}`bluesky_tiled_plugins.clients.document`

```{py:module} bluesky_tiled_plugins.clients.document
```

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Document <bluesky_tiled_plugins.clients.document.Document>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document
    :summary:
    ```
* - {py:obj}`Start <bluesky_tiled_plugins.clients.document.Start>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Start
    :summary:
    ```
* - {py:obj}`Stop <bluesky_tiled_plugins.clients.document.Stop>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Stop
    :summary:
    ```
* - {py:obj}`Resource <bluesky_tiled_plugins.clients.document.Resource>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Resource
    :summary:
    ```
* - {py:obj}`StreamResource <bluesky_tiled_plugins.clients.document.StreamResource>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.StreamResource
    :summary:
    ```
* - {py:obj}`Descriptor <bluesky_tiled_plugins.clients.document.Descriptor>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Descriptor
    :summary:
    ```
* - {py:obj}`Event <bluesky_tiled_plugins.clients.document.Event>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Event
    :summary:
    ```
* - {py:obj}`EventPage <bluesky_tiled_plugins.clients.document.EventPage>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.EventPage
    :summary:
    ```
* - {py:obj}`Datum <bluesky_tiled_plugins.clients.document.Datum>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Datum
    :summary:
    ```
* - {py:obj}`StreamDatum <bluesky_tiled_plugins.clients.document.StreamDatum>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.StreamDatum
    :summary:
    ```
* - {py:obj}`DatumPage <bluesky_tiled_plugins.clients.document.DatumPage>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.DatumPage
    :summary:
    ```
````

### API

````{py:exception} NotMutable()
:canonical: bluesky_tiled_plugins.clients.document.NotMutable

Bases: {py:obj}`Exception`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.NotMutable
```

````

`````{py:class} Document(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.Document

Bases: {py:obj}`dict`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document
```

````{py:attribute} pop
:canonical: bluesky_tiled_plugins.clients.document.Document.pop
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document.pop
```

````

````{py:attribute} popitem
:canonical: bluesky_tiled_plugins.clients.document.Document.popitem
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document.popitem
```

````

````{py:attribute} clear
:canonical: bluesky_tiled_plugins.clients.document.Document.clear
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document.clear
```

````

````{py:attribute} setdefault
:canonical: bluesky_tiled_plugins.clients.document.Document.setdefault
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document.setdefault
```

````

````{py:attribute} update
:canonical: bluesky_tiled_plugins.clients.document.Document.update
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document.update
```

````

````{py:method} to_dict()
:canonical: bluesky_tiled_plugins.clients.document.Document.to_dict

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Document.to_dict
```

````

`````

````{py:class} Start(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.Start

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Start
```

````

````{py:class} Stop(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.Stop

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Stop
```

````

````{py:class} Resource(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.Resource

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Resource
```

````

````{py:class} StreamResource(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.StreamResource

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.StreamResource
```

````

````{py:class} Descriptor(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.Descriptor

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Descriptor
```

````

````{py:class} Event(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.Event

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Event
```

````

````{py:class} EventPage(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.EventPage

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.EventPage
```

````

````{py:class} Datum(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.Datum

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.Datum
```

````

````{py:class} StreamDatum(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.StreamDatum

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.StreamDatum
```

````

````{py:class} DatumPage(*args, **kwargs)
:canonical: bluesky_tiled_plugins.clients.document.DatumPage

Bases: {py:obj}`bluesky_tiled_plugins.clients.document.Document`

```{autodoc2-docstring} bluesky_tiled_plugins.clients.document.DatumPage
```

````