Documentation
¶
Index ¶
Constants ¶
View Source
const ( // TaskAllOf1ReasonTimeout captures enum value "timeout" TaskAllOf1ReasonTimeout string = "timeout" // TaskAllOf1ReasonKilled captures enum value "killed" TaskAllOf1ReasonKilled string = "killed" // TaskAllOf1ReasonBadExit captures enum value "bad_exit" TaskAllOf1ReasonBadExit string = "bad_exit" // TaskAllOf1ReasonClientRequest captures enum value "client_request" TaskAllOf1ReasonClientRequest 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"`
}
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"`
}
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 AppsWrapperApps `json:"apps"`
// error
Error *ErrorBody `json:"error,omitempty"`
}
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 AppsWrapperApps ¶
type AppsWrapperApps []*App
type Error ¶
type Error struct {
// error
Error *ErrorBody `json:"error,omitempty"`
}
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"`
}
func (*ErrorBody) MarshalBinary ¶
MarshalBinary interface implementation
func (*ErrorBody) UnmarshalBinary ¶
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"`
}
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 interface{} `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 *int64 `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"`
// Signing key for JWT
JwtKey string `json:"jwt_key,omitempty"`
// Maximum number of hot functions concurrency
MaxConcurrency int32 `json:"max_concurrency,omitempty"`
// Max usable memory for this route (MiB).
Memory int64 `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 *int64 `json:"timeout,omitempty"`
// Route type
Type interface{} `json:"type,omitempty"`
}
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"`
}
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 RoutesWrapperRoutes `json:"routes"`
}
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 RoutesWrapperRoutes ¶
type RoutesWrapperRoutes []*Route
type Task ¶
type Task struct {
NewTask
TaskAllOf1
}
func (*Task) MarshalBinary ¶
MarshalBinary interface implementation
func (Task) MarshalJSON ¶
MarshalJSON marshals this object to a JSON structure
func (*Task) UnmarshalBinary ¶
UnmarshalBinary interface implementation
func (*Task) UnmarshalJSON ¶
UnmarshalJSON unmarshals this object from a JSON structure
type TaskAllOf1 ¶
type TaskAllOf1 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"`
// 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"`
}
func (*TaskAllOf1) MarshalBinary ¶
func (m *TaskAllOf1) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskAllOf1) UnmarshalBinary ¶
func (m *TaskAllOf1) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskWrapper ¶
type TaskWrapper struct {
// task
// Required: true
Task *Task `json:"task"`
}
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"`
}
func (*Version) MarshalBinary ¶
MarshalBinary interface implementation
func (*Version) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files
Click to show internal directories.
Click to hide internal directories.