# types
Public data types returned by Modal APIs.
## AppInfo
Information about a modal App, including its lifecycle and member functions and servers.
**Attributes**
## AppLifecycle
Timestamps and attributions for events in an App's lifecycle.
Timestamps or attributions may be None when they do not apply to this App
(e.g., App is not deployed, App was not explicitly stopped).
**Attributes**
## AppState
```python
class AppState(str, enum.Enum)
```
An enumeration.
The possible values are:
* `EPHEMERAL`
* `DETACHED`
* `DEPLOYED`
* `STOPPING`
* `STOPPED`
* `INITIALIZING`
* `DISABLED`
## BillingReportItem
Costs generated by a specific object during a specific time interval.
**Attributes**
## CloudBucketMountInfo
**Attributes**
## DictInfo
Information about a Dict object.
**Attributes**
## EnvironmentBillingSummary
**Attributes**
## FileEntry
A file or directory entry listed from a Modal volume.
**Attributes**
## FileEntryType
```python
class FileEntryType(enum.IntEnum)
```
Type of a file entry listed from a Modal volume.
The possible values are:
* `UNSPECIFIED`
* `FILE`
* `DIRECTORY`
* `SYMLINK`
* `FIFO`
* `SOCKET`
## FileInfo
Metadata for a file or directory entry in a Sandbox.
**Attributes**
### is\_file
```python
is_file(self)
```
Return `True` if this entry is a regular file.
### is\_dir
```python
is_dir(self)
```
Return `True` if this entry is a directory.
### is\_symlink
```python
is_symlink(self)
```
Return `True` if this entry is a symbolic link.
## FileType
```python
class FileType(enum.Enum)
```
Type of a filesystem entry.
The possible values are:
* `FILE`
* `DIRECTORY`
* `SYMLINK`
## FileWatchEvent
A filesystem change event reported by `Sandbox.filesystem.watch()`.
`paths` contains the absolute path(s) affected by the event. For most
event types it holds a single entry. Rename operations are reported as
`Modify` events: when both the source and destination fall within the
watched scope, `paths` holds `[source, destination]`; when only one
side of the rename is visible, `paths` holds that single path.
**Attributes**
## FileWatchEventType
```python
class FileWatchEventType(enum.Enum)
```
Type of a filesystem watch event reported by `Sandbox.filesystem.watch()`.
The possible values are:
* `Unknown`
* `Access`
* `Create`
* `Modify`
* `Remove`
## FunctionAutoscalerSettings
**Attributes**
## FunctionCurrentStats
Simple data structure storing stats for a running function.
**Attributes**
## FunctionInfo
A simple data structure containing static info about a Function handle.
**Attributes**
## FunctionStats
Historical Function statistics for a time range.
**Attributes**
## InputInfo
Simple data structure storing information about a function input.
**Attributes**
## InputStatus
```python
class InputStatus(enum.IntEnum)
```
Enum representing status of a function input.
The possible values are:
* `PENDING`
* `SUCCESS`
* `FAILURE`
* `INIT_FAILURE`
* `TERMINATED`
* `TIMEOUT`
## LogEntry
A log entry queried through a Modal object or App.
The object\_id field identifies the object or App whose log manager produced the entry. The context\_ids field
contains progressively narrower IDs corresponding to the context in which the log entry was emitted. For example,
for a function log entry, this will contain the function call ID, the input ID, and the container ID.
**Attributes**
## MemberTokenInfo
**Attributes**
## MetricDefinition
The name, unit, and meaning of an individual exportable series.
**Attributes**
## MetricSeries
An individual metric series with points ordered by time.
**Attributes**
## MetricsSchema
A metrics group and its individual series definitions.
**Attributes**
## ObjectMetrics
Exported metrics over the effective, UTC-aligned \[since, until) range.
**Attributes**
## ProxyTokenInfo
Metadata about a proxy token, not including the token secret.
**Attributes**
## QueueInfo
Information about a Queue object.
**Attributes**
## SandboxConnectCredentials
Simple data structure storing credentials for making HTTP connections to a sandbox.
**Attributes**
## SecretInfo
Information about a Secret object.
**Attributes**
## ServerAutoscalerSettings
**Attributes**
## ServerContainerInfo
Information about a container serving requests for a Server.
**Attributes**
## ServerInfo
A simple data structure containing static info about a Server handle.
**Attributes**
## ServerSessionCredentials
Credentials for a sticky session on a Server.
Requests carrying `token` are routed to the same container.
**Attributes**
## ServerStats
Historical Server statistics for a time range.
**Attributes**
Inference-engine statistics for a Server.
## ServiceUserInfo
A lightweight dataclass containing metadata about a Modal Service User.
**Attributes**
## StatsPercentile
A percentile measurement for a metric or strat.
**Attributes**
## StatsPercentileDistribution
**Attributes**
## TimeSeriesPoint
A metric sample at a UTC bucket start. A missing observation has value None.
**Attributes**
## TokenData
A token ID / secret pair.
**Attributes**
## VolumeCreateOptions
Options used when creating a Volume.
**Attributes**
## VolumeInfo
Information about a Volume object.
**Attributes**
## VolumeMountInfo
**Attributes**
## WorkspaceBillingSummary
**Attributes**
## WorkspaceMemberInfo
Metadata about a Workspace member.
**Attributes**
## WorkspaceSettings
Current settings for the workspace.
**Attributes**