shared

Documentation

Index

• type APIDesc
• type AppMetadata
• type CloudProvider
• type Environment
• type EnvironmentType
• type PathParam
• type PathParams
  • func (p PathParams) Get(name string) string
• type Request
• type RequestType

Types

type APIDesc

type APIDesc struct {
	RequestType  reflect.Type
	ResponseType reflect.Type
	Raw          bool
	Exposed      bool
	AuthRequired bool
}

type AppMetadata

type AppMetadata struct {
	AppID        string
	BaseAppID    string
	RuntimeAppID string
	SessionID    string
	APIBaseURL   string
	Environment  Environment
}

type CloudProvider

type CloudProvider string

const (
	CloudAWS   CloudProvider = "aws"
	CloudGCP   CloudProvider = "gcp"
	CloudAzure CloudProvider = "azure"
	CloudLocal CloudProvider = "local"
)

type Environment

type Environment struct {
	Name  string
	Type  EnvironmentType
	Cloud CloudProvider
}

type EnvironmentType

type EnvironmentType string

const (
	EnvProduction  EnvironmentType = "production"
	EnvDevelopment EnvironmentType = "development"
	EnvEphemeral   EnvironmentType = "ephemeral"
	EnvLocal       EnvironmentType = "local"
	EnvTest        EnvironmentType = "test"
)

type PathParam

type PathParam struct {
	Name  string
	Value string
}

type PathParams

type PathParams []PathParam

func (PathParams) Get

func (p PathParams) Get(name string) string

type Request

type Request struct {
	Type          RequestType
	Started       time.Time
	InvocationID  string
	TraceID       string
	CallerBinding string
	ExecutionID   string
	Deployment    string
	Locale        string
	Deadline      time.Time
	API           *APIDesc
	Service       string
	Endpoint      string
	Path          string
	PathParams    PathParams
	Method        string
	Headers       http.Header
	Payload       any

	// CronIdempotencyKey is set when the current request was triggered by a cron job.
	CronIdempotencyKey string
}

type RequestType

type RequestType string

const (
	None         RequestType = "none"
	APICall      RequestType = "api-call"
	InternalCall RequestType = "internal-call"
	RawAPICall   RequestType = "raw-api-call"
	EventCall    RequestType = "event-call"
	DurableCall  RequestType = "durable-call"
)