Function

Function references a deployed Modal Function.

type Function struct {
	FunctionID string
}

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(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() 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(ctx context.Context) (*Function, error)

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

Remote executes a single input on a remote Function.

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

Spawn starts running a single input on a remote Function.

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

UpdateAutoscaler overrides the current autoscaler behavior for this Function.

Parameters (FunctionUpdateAutoscalerParams)

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

WithBatching(params *FunctionWithBatchingParams) *Function

Parameters (FunctionWithBatchingParams)

FunctionWithBatchingParams represents batching configuration for a Modal Function.

WithConcurrency(params *FunctionWithConcurrencyParams) *Function

Parameters (FunctionWithConcurrencyParams)

FunctionWithConcurrencyParams represents concurrency configuration for a Modal Function.

WithOptions(options *FunctionWithOptionsParams) *Function

Parameters (FunctionWithOptionsParams)

FunctionWithOptionsParams represents runtime options for a Modal Function.