Function

Function references a deployed Modal Function.

type Function struct {
	FunctionID string
	Logs       *FunctionLogsManager // Logs provides access to logs emitted by this Function.
}

FromName

Accessed via client.Functions

FromName(ctx context.Context, appName string, name string, params *FunctionFromNameParams) (*Function, error)

FromName references a Function from a deployed App by its name.

Parameters (FunctionFromNameParams)

FunctionFromNameParams are options for client.Functions.FromName.

• Environment (string)
• Version (int): Version looks up a version-pinned Function deployed at this App version.

GetCurrentStats

GetCurrentStats(ctx context.Context, params *FunctionGetCurrentStatsParams) (*FunctionStats, error)

GetCurrentStats returns a FunctionStats object with statistics about the Function.

Parameters (FunctionGetCurrentStatsParams)

FunctionGetCurrentStatsParams are options for Function.GetCurrentStats.

No configurable options.

GetWebURL

GetWebURL() string

GetWebURL returns the URL of a Function running as a Web Function. Returns empty string if this Function is not a Web Function.

Instance

Instance(ctx context.Context) (*Function, error)

Remote

Remote(ctx context.Context, args []any, kwargs map[string]any) (any, error)

Remote executes a single input on a remote Function.

Spawn

Spawn(ctx context.Context, args []any, kwargs map[string]any) (*FunctionCall, error)

Spawn starts running a single input on a remote Function.

UpdateAutoscaler

UpdateAutoscaler(ctx context.Context, params *FunctionUpdateAutoscalerParams) (*FunctionAutoscalerSettings, error)

UpdateAutoscaler overrides the current autoscaler behavior for this Function.

Parameters (FunctionUpdateAutoscalerParams)

FunctionUpdateAutoscalerParams contains options for overriding a Function's autoscaler behavior.

• MinContainers (*uint32)
• MaxContainers (*uint32)
• BufferContainers (*uint32)
• ScaledownWindow (*time.Duration)

WithBatching

WithBatching(params *FunctionWithBatchingParams) *Function

Parameters (FunctionWithBatchingParams)

FunctionWithBatchingParams represents batching configuration for a Modal Function.

• MaxBatchSize (int)
• Wait (time.Duration)

WithConcurrency

WithConcurrency(params *FunctionWithConcurrencyParams) *Function

Parameters (FunctionWithConcurrencyParams)

FunctionWithConcurrencyParams represents concurrency configuration for a Modal Function.

• MaxInputs (int)
• TargetInputs (*int)

WithOptions

WithOptions(options *FunctionWithOptionsParams) *Function

Parameters (FunctionWithOptionsParams)

FunctionWithOptionsParams represents runtime options for a Modal Function.

• CPU (*float64)
• CPULimit (*float64)
• MemoryMiB (*int)
• MemoryLimitMiB (*int)
• GPU (*string)
• Env (map[string]string)
• Secrets ([]*Secret)
• Volumes (map[string]*Volume)
• Retries (*Retries)
• MaxContainers (*int)
• BufferContainers (*int)
• ScaledownWindow (*time.Duration)
• Timeout (*time.Duration)
• RoutingRegion (*string)

Function.Logs

Logs provides access to logs emitted by this Function.

Fetch

Fetch(
	ctx context.Context,
	since time.Time,
	params *FunctionLogFetchParams,
) (iter.Seq2[LogEntry, error], error)

Fetch fetches Function logs corresponding to the date range and filters.

since is the start of the time range. params.Until defaults to the current time. The sequence yields LogEntry values in chronological order.

Parameters (FunctionLogFetchParams)

FunctionLogFetchParams are options for fetching Function logs.

• Until (*time.Time): Until is the end of the time range. It defaults to the current time.
• Source (LogSource): Source filters logs by stdout, stderr, or system. The zero value includes all sources.
• SearchText (string): SearchText filters Function logs by search text.

Stream

Stream(
	ctx context.Context,
	params *LogStreamParams,
) (iter.Seq2[LogEntry, error], error)

Stream streams new Function logs until the timeout is reached.

The timeout specifies how long to wait between log entries before terminating the stream. By default, the stream blocks until it is interrupted. The sequence yields LogEntry values as they arrive.

Parameters (LogStreamParams)

LogStreamParams are options for streaming logs.

• Timeout (*time.Duration): Timeout is the duration to wait between log entries before terminating the stream. When nil, the stream blocks until it is interrupted.

Tail

Tail(ctx context.Context, params *LogTailParams) (iter.Seq2[LogEntry, error], error)

Tail fetches the most recent Function logs.

The sequence yields LogEntry values in chronological order.

Parameters (LogTailParams)

LogTailParams are options for fetching the most recent logs.

• Entries (int): Entries is the number of log entries to return. It defaults to 100.
• Source (LogSource): Source filters logs by stdout, stderr, or system. The zero value includes all sources.