# {py:mod}`labthings_fastapi.actions.invocation_model`

```{py:module} labthings_fastapi.actions.invocation_model
```

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`InvocationStatus <labthings_fastapi.actions.invocation_model.InvocationStatus>`
  -
* - {py:obj}`LogRecordModel <labthings_fastapi.actions.invocation_model.LogRecordModel>`
  - ```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel
    :summary:
    ```
* - {py:obj}`GenericInvocationModel <labthings_fastapi.actions.invocation_model.GenericInvocationModel>`
  -
````

### Data

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

* - {py:obj}`InputT <labthings_fastapi.actions.invocation_model.InputT>`
  - ```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InputT
    :summary:
    ```
* - {py:obj}`OutputT <labthings_fastapi.actions.invocation_model.OutputT>`
  - ```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.OutputT
    :summary:
    ```
* - {py:obj}`InvocationModel <labthings_fastapi.actions.invocation_model.InvocationModel>`
  - ```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InvocationModel
    :summary:
    ```
````

### API

`````{py:class} InvocationStatus(*args, **kwds)
:canonical: labthings_fastapi.actions.invocation_model.InvocationStatus

Bases: {py:obj}`enum.Enum`

````{py:attribute} PENDING
:canonical: labthings_fastapi.actions.invocation_model.InvocationStatus.PENDING
:value: >
   'pending'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InvocationStatus.PENDING
```

````

````{py:attribute} RUNNING
:canonical: labthings_fastapi.actions.invocation_model.InvocationStatus.RUNNING
:value: >
   'running'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InvocationStatus.RUNNING
```

````

````{py:attribute} COMPLETED
:canonical: labthings_fastapi.actions.invocation_model.InvocationStatus.COMPLETED
:value: >
   'completed'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InvocationStatus.COMPLETED
```

````

````{py:attribute} CANCELLED
:canonical: labthings_fastapi.actions.invocation_model.InvocationStatus.CANCELLED
:value: >
   'cancelled'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InvocationStatus.CANCELLED
```

````

````{py:attribute} ERROR
:canonical: labthings_fastapi.actions.invocation_model.InvocationStatus.ERROR
:value: >
   'error'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InvocationStatus.ERROR
```

````

`````

`````{py:class} LogRecordModel
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel

Bases: {py:obj}`pydantic.BaseModel`

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel
```

````{py:attribute} model_config
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.model_config
:value: >
   'ConfigDict(...)'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.model_config
```

````

````{py:attribute} message
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.message
:type: str
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.message
```

````

````{py:attribute} levelname
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.levelname
:type: str
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.levelname
```

````

````{py:attribute} levelno
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.levelno
:type: int
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.levelno
```

````

````{py:attribute} lineno
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.lineno
:type: int
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.lineno
```

````

````{py:attribute} filename
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.filename
:type: str
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.filename
```

````

````{py:attribute} created
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.created
:type: datetime.datetime
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.created
```

````

````{py:method} generate_message(data: typing.Any)
:canonical: labthings_fastapi.actions.invocation_model.LogRecordModel.generate_message
:classmethod:

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.LogRecordModel.generate_message
```

````

`````

````{py:data} InputT
:canonical: labthings_fastapi.actions.invocation_model.InputT
:value: >
   'TypeVar(...)'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InputT
```

````

````{py:data} OutputT
:canonical: labthings_fastapi.actions.invocation_model.OutputT
:value: >
   'TypeVar(...)'

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.OutputT
```

````

`````{py:class} GenericInvocationModel
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel

Bases: {py:obj}`pydantic.BaseModel`, {py:obj}`typing.Generic`\[{py:obj}`labthings_fastapi.actions.invocation_model.InputT`\, {py:obj}`labthings_fastapi.actions.invocation_model.OutputT`\]

````{py:attribute} status
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.status
:type: labthings_fastapi.actions.invocation_model.InvocationStatus
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.status
```

````

````{py:attribute} id
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.id
:type: uuid.UUID
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.id
```

````

````{py:attribute} action
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.action
:type: str
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.action
```

````

````{py:attribute} href
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.href
:type: str
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.href
```

````

````{py:attribute} timeStarted
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.timeStarted
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.timeStarted
```

````

````{py:attribute} timeRequested
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.timeRequested
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.timeRequested
```

````

````{py:attribute} timeCompleted
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.timeCompleted
:type: typing.Optional[datetime.datetime]
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.timeCompleted
```

````

````{py:attribute} input
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.input
:type: labthings_fastapi.actions.invocation_model.InputT
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.input
```

````

````{py:attribute} output
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.output
:type: labthings_fastapi.actions.invocation_model.OutputT
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.output
```

````

````{py:attribute} log
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.log
:type: typing.Sequence[labthings_fastapi.actions.invocation_model.LogRecordModel]
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.log
```

````

````{py:attribute} links
:canonical: labthings_fastapi.actions.invocation_model.GenericInvocationModel.links
:type: labthings_fastapi.thing_description.model.Links
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.GenericInvocationModel.links
```

````

`````

````{py:data} InvocationModel
:canonical: labthings_fastapi.actions.invocation_model.InvocationModel
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.actions.invocation_model.InvocationModel
```

````