Documentation
¶
Index ¶
Constants ¶
View Source
const ( // RouteFormatDefault captures enum value "default" RouteFormatDefault string = "default" // RouteFormatHTTP captures enum value "http" RouteFormatHTTP string = "http" // RouteFormatJSON captures enum value "json" RouteFormatJSON string = "json" )
View Source
const ( // RouteTypeSync captures enum value "sync" RouteTypeSync string = "sync" // RouteTypeAsync captures enum value "async" RouteTypeAsync string = "async" )
View Source
const ( // TaskReasonTimeout captures enum value "timeout" TaskReasonTimeout string = "timeout" // TaskReasonKilled captures enum value "killed" TaskReasonKilled string = "killed" // TaskReasonBadExit captures enum value "bad_exit" TaskReasonBadExit string = "bad_exit" // TaskReasonClientRequest captures enum value "client_request" TaskReasonClientRequest string = "client_request" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
// Application configuration
Config map[string]string `json:"config,omitempty"`
// Name of this app. Must be different than the image name. Can ony contain alphanumeric, -, and _.
// Read Only: true
Name string `json:"name,omitempty"`
}
App app swagger:model App
func (*App) MarshalBinary ¶
MarshalBinary interface implementation
func (*App) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AppWrapper ¶
type AppWrapper struct {
// app
// Required: true
App *App `json:"app"`
// error
Error *ErrorBody `json:"error,omitempty"`
}
AppWrapper app wrapper swagger:model AppWrapper
func (*AppWrapper) MarshalBinary ¶
func (m *AppWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppWrapper) UnmarshalBinary ¶
func (m *AppWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppsWrapper ¶
type AppsWrapper struct {
// apps
// Required: true
Apps []*App `json:"apps"`
// error
Error *ErrorBody `json:"error,omitempty"`
}
AppsWrapper apps wrapper swagger:model AppsWrapper
func (*AppsWrapper) MarshalBinary ¶
func (m *AppsWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppsWrapper) UnmarshalBinary ¶
func (m *AppsWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Call ¶
type Call struct {
// App name that is assigned to a route that is being executed.
// Read Only: true
AppName string `json:"app_name,omitempty"`
// Time when call completed, whether it was successul or failed. Always in UTC.
// Read Only: true
CompletedAt strfmt.DateTime `json:"completed_at,omitempty"`
// Time when call was submitted. Always in UTC.
// Read Only: true
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Call UUID ID.
// Read Only: true
ID string `json:"id,omitempty"`
// App route that is being executed.
// Read Only: true
Path string `json:"path,omitempty"`
// Time when call started execution. Always in UTC.
// Read Only: true
StartedAt strfmt.DateTime `json:"started_at,omitempty"`
// Call execution status.
// Read Only: true
Status string `json:"status,omitempty"`
}
Call call swagger:model Call
func (*Call) MarshalBinary ¶
MarshalBinary interface implementation
func (*Call) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CallWrapper ¶
type CallWrapper struct {
// Call object.
// Required: true
Call *Call `json:"call"`
}
CallWrapper call wrapper swagger:model CallWrapper
func (*CallWrapper) MarshalBinary ¶
func (m *CallWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CallWrapper) UnmarshalBinary ¶
func (m *CallWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CallsWrapper ¶
type CallsWrapper struct {
// calls
// Required: true
Calls []*Call `json:"calls"`
// error
Error *ErrorBody `json:"error,omitempty"`
}
CallsWrapper calls wrapper swagger:model CallsWrapper
func (*CallsWrapper) MarshalBinary ¶
func (m *CallsWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CallsWrapper) UnmarshalBinary ¶
func (m *CallsWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// error
Error *ErrorBody `json:"error,omitempty"`
}
Error error swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ErrorBody ¶
type ErrorBody struct {
// fields
// Read Only: true
Fields string `json:"fields,omitempty"`
// message
// Read Only: true
Message string `json:"message,omitempty"`
}
ErrorBody error body swagger:model ErrorBody
func (*ErrorBody) MarshalBinary ¶
MarshalBinary interface implementation
func (*ErrorBody) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Log ¶
type Log struct {
// Call UUID ID
CallID string `json:"call_id,omitempty"`
// log
Log string `json:"log,omitempty"`
}
Log log swagger:model Log
func (*Log) MarshalBinary ¶
MarshalBinary interface implementation
func (*Log) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LogWrapper ¶
type LogWrapper struct {
// Call log entry.
// Required: true
Log *Log `json:"log"`
}
LogWrapper log wrapper swagger:model LogWrapper
func (*LogWrapper) MarshalBinary ¶
func (m *LogWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LogWrapper) UnmarshalBinary ¶
func (m *LogWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NewTask ¶
type NewTask struct {
// Name of Docker image to use. This is optional and can be used to override the image defined at the group level.
// Required: true
Image *string `json:"image"`
// Payload for the task. This is what you pass into each task to make it do something.
Payload string `json:"payload,omitempty"`
}
NewTask new task swagger:model NewTask
func (*NewTask) MarshalBinary ¶
MarshalBinary interface implementation
func (*NewTask) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Route ¶
type Route struct {
// Route configuration - overrides application configuration
Config map[string]string `json:"config,omitempty"`
// Payload format sent into function.
Format string `json:"format,omitempty"`
// Map of http headers that will be sent with the response
Headers map[string][]string `json:"headers,omitempty"`
// Hot functions idle timeout before termination. Value in Seconds
IDLETimeout *int32 `json:"idle_timeout,omitempty"`
// Name of Docker image to use in this route. You should include the image tag, which should be a version number, to be more accurate. Can be overridden on a per route basis with route.image.
Image string `json:"image,omitempty"`
// Max usable memory for this route (MiB).
Memory uint64 `json:"memory,omitempty"`
// URL path that will be matched to this route
// Read Only: true
Path string `json:"path,omitempty"`
// Timeout for executions of this route. Value in Seconds
Timeout *int32 `json:"timeout,omitempty"`
// Route type
Type string `json:"type,omitempty"`
}
Route route swagger:model Route
func (*Route) MarshalBinary ¶
MarshalBinary interface implementation
func (*Route) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RouteWrapper ¶
type RouteWrapper struct {
// error
Error *ErrorBody `json:"error,omitempty"`
// message
Message string `json:"message,omitempty"`
// route
// Required: true
Route *Route `json:"route"`
}
RouteWrapper route wrapper swagger:model RouteWrapper
func (*RouteWrapper) MarshalBinary ¶
func (m *RouteWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RouteWrapper) UnmarshalBinary ¶
func (m *RouteWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RoutesWrapper ¶
type RoutesWrapper struct {
// error
Error *ErrorBody `json:"error,omitempty"`
// routes
// Required: true
Routes []*Route `json:"routes"`
}
RoutesWrapper routes wrapper swagger:model RoutesWrapper
func (*RoutesWrapper) MarshalBinary ¶
func (m *RoutesWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RoutesWrapper) UnmarshalBinary ¶
func (m *RoutesWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Task ¶
type Task struct {
// Time when task completed, whether it was successul or failed. Always in UTC.
CompletedAt strfmt.DateTime `json:"completed_at,omitempty"`
// Time when task was submitted. Always in UTC.
// Read Only: true
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Env vars for the task. Comes from the ones set on the Group.
EnvVars map[string]string `json:"env_vars,omitempty"`
// The error message, if status is 'error'. This is errors due to things outside the task itself. Errors from user code will be found in the log.
Error string `json:"error,omitempty"`
// Group this task belongs to.
// Read Only: true
GroupName string `json:"group_name,omitempty"`
// Name of Docker image to use. This is optional and can be used to override the image defined at the group level.
// Required: true
Image *string `json:"image"`
// Payload for the task. This is what you pass into each task to make it do something.
Payload string `json:"payload,omitempty"`
// Machine usable reason for task being in this state.
// Valid values for error status are `timeout | killed | bad_exit`.
// Valid values for cancelled status are `client_request`.
// For everything else, this is undefined.
//
Reason string `json:"reason,omitempty"`
// If this field is set, then this task was retried by the task referenced in this field.
// Read Only: true
RetryAt string `json:"retry_at,omitempty"`
// If this field is set, then this task is a retry of the ID in this field.
// Read Only: true
RetryOf string `json:"retry_of,omitempty"`
// Time when task started execution. Always in UTC.
StartedAt strfmt.DateTime `json:"started_at,omitempty"`
}
Task task swagger:model Task
func (*Task) MarshalBinary ¶
MarshalBinary interface implementation
func (*Task) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TaskWrapper ¶
type TaskWrapper struct {
// task
// Required: true
Task *Task `json:"task"`
}
TaskWrapper task wrapper swagger:model TaskWrapper
func (*TaskWrapper) MarshalBinary ¶
func (m *TaskWrapper) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskWrapper) UnmarshalBinary ¶
func (m *TaskWrapper) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Version ¶
type Version struct {
// version
// Read Only: true
Version string `json:"version,omitempty"`
}
Version version swagger:model Version
func (*Version) MarshalBinary ¶
MarshalBinary interface implementation
func (*Version) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files
Click to show internal directories.
Click to hide internal directories.