types

Public data types returned by Modal APIs.

BillingReportItem

Costs generated by a specific object during a specific time interval.

Attributes

DictInfo

Information about a Dict object.

Attributes

EnvironmentBillingSummary

Attributes

FileEntry

A file or directory entry listed from a Modal volume.

Attributes

FileEntryType

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

is_file(self)

Return True if this entry is a regular file.

is_dir

is_dir(self)

Return True if this entry is a directory.

is_symlink

is_symlink(self)

Return True if this entry is a symbolic link.

FileType

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

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

FunctionStats

Simple data structure storing stats for a running function.

Attributes

InputInfo

Simple data structure storing information about a function input.

Attributes

InputStatus

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

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

TokenData

A token ID / secret pair.

Attributes

VolumeCreateOptions

Options used when creating a Volume.

Attributes

VolumeInfo

Information about a Volume object.

Attributes

WorkspaceBillingSummary

Attributes

WorkspaceMemberInfo

Metadata about a Workspace member.

Attributes

WorkspaceSettings

Current settings for the workspace.

Attributes