Documentation
¶
Index ¶
Constants ¶
const ( // AppShapeGENERICX86 captures enum value "GENERIC_X86" AppShapeGENERICX86 string = "GENERIC_X86" // AppShapeGENERICARM captures enum value "GENERIC_ARM" AppShapeGENERICARM string = "GENERIC_ARM" // AppShapeGENERICX86ARM captures enum value "GENERIC_X86_ARM" AppShapeGENERICX86ARM string = "GENERIC_X86_ARM" )
const ( // FnShapeGENERICX86 captures enum value "GENERIC_X86" FnShapeGENERICX86 string = "GENERIC_X86" // FnShapeGENERICARM captures enum value "GENERIC_ARM" FnShapeGENERICARM string = "GENERIC_ARM" // FnShapeGENERICX86ARM captures enum value "GENERIC_X86_ARM" FnShapeGENERICX86ARM string = "GENERIC_X86_ARM" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
// Application annotations - this is a map of annotations attached to this app, keys must not exceed 128 bytes and must consist of non-whitespace printable ascii characters, and the seralized representation of individual values must not exeed 512 bytes.
Annotations map[string]interface{} `json:"annotations,omitempty"`
// Application function configuration, applied to all Functions.
Config map[string]string `json:"config,omitempty"`
// Time when app was created. Always in UTC.
// Read Only: true
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// App ID
// Read Only: true
ID string `json:"id,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"`
// Valid values are "GENERIC_X86", "GENERIC_ARM" and "GENERIC_X86_ARM". Default is "GENERIC_X86". Setting this to "GENERIC_X86", will run the functions in the application on X86 processor architecture.
// Setting this to "GENERIC_ARM", will run the functions in the application on ARM processor architecture.
// When set to "GENERIC_X86_ARM", functions in the application are run on either X86 or ARM processor architecture.
// Accepted values are:
// "GENERIC_X86", "GENERIC_ARM", "GENERIC_X86_ARM"
//
// Enum: [GENERIC_X86 GENERIC_ARM GENERIC_X86_ARM]
Shape string `json:"shape,omitempty"`
// A comma separated list of syslog urls to send all function logs to. supports tls, udp or tcp. e.g. tls://logs.papertrailapp.com:1
SyslogURL *string `json:"syslog_url,omitempty"`
// Most recent time that app was updated. Always in UTC.
// Read Only: true
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}
App app
swagger:model App
func (*App) MarshalBinary ¶
MarshalBinary interface implementation
func (*App) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AppList ¶
type AppList struct {
// items
// Required: true
Items []*App `json:"items"`
// Cursor to send with subsequent request to receive the next page, if non-empty.
// Read Only: true
NextCursor string `json:"next_cursor,omitempty"`
}
AppList app list
swagger:model AppList
func (*AppList) MarshalBinary ¶
MarshalBinary interface implementation
func (*AppList) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// fields
// Read Only: true
Fields string `json:"fields,omitempty"`
// message
// Read Only: true
Message string `json:"message,omitempty"`
}
Error error
swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Fn ¶
type Fn struct {
// Func annotations - this is a map of annotations attached to this func, keys must not exceed 128 bytes and must consist of non-whitespace printable ascii characters, and the seralized representation of individual values must not exeed 512 bytes.
Annotations map[string]interface{} `json:"annotations,omitempty"`
// App ID.
AppID string `json:"app_id,omitempty"`
// Function configuration key values.
Config map[string]string `json:"config,omitempty"`
// Time when function was created. Always in UTC RFC3339.
// Read Only: true
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Unique identifier
// Read Only: true
ID string `json:"id,omitempty"`
// Hot functions idle timeout before container termination. Value in Seconds.
IdleTimeout *int32 `json:"idle_timeout,omitempty"`
// Full container image name, e.g. hub.docker.com/fnproject/yo or fnproject/yo (default registry: hub.docker.com)
Image string `json:"image,omitempty"`
// Maximum usable memory given to function (MiB).
Memory uint64 `json:"memory,omitempty"`
// Unique name for this function.
Name string `json:"name,omitempty"`
// Valid values are "GENERIC_X86", "GENERIC_ARM" and "GENERIC_X86_ARM". Default is "GENERIC_X86". Setting this to "GENERIC_X86", will run the functions in the application on X86 processor architecture.
// Setting this to "GENERIC_ARM", will run the functions in the application on ARM processor architecture.
// When set to "GENERIC_X86_ARM", functions in the application are run on either X86 or ARM processor architecture.
// Accepted values are:
// "GENERIC_X86", "GENERIC_ARM", "GENERIC_X86_ARM"
//
// Enum: [GENERIC_X86 GENERIC_ARM GENERIC_X86_ARM]
Shape string `json:"shape,omitempty"`
// Timeout for executions of a function. Value in Seconds.
Timeout *int32 `json:"timeout,omitempty"`
// Most recent time that function was updated. Always in UTC RFC3339.
// Read Only: true
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}
Fn fn
swagger:model Fn
func (*Fn) MarshalBinary ¶
MarshalBinary interface implementation
func (*Fn) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FnList ¶
type FnList struct {
// items
// Required: true
Items []*Fn `json:"items"`
// Cursor to send with subsequent request to receive the next page, if non-empty.
// Read Only: true
NextCursor string `json:"next_cursor,omitempty"`
}
FnList fn list
swagger:model FnList
func (*FnList) MarshalBinary ¶
MarshalBinary interface implementation
func (*FnList) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Trigger ¶
type Trigger struct {
// Trigger annotations - this is a map of annotations attached to this trigger, keys must not exceed 128 bytes and must consist of non-whitespace printable ascii characters, and the seralized representation of individual values must not exeed 512 bytes.
Annotations map[string]interface{} `json:"annotations,omitempty"`
// Opaque, unique Application identifier
// Read Only: true
AppID string `json:"app_id,omitempty"`
// Time when trigger was created. Always in UTC.
// Read Only: true
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Opaque, unique Function identifier
// Read Only: true
FnID string `json:"fn_id,omitempty"`
// Unique Trigger identifier.
// Read Only: true
ID string `json:"id,omitempty"`
// Unique name for this trigger, used to identify this trigger.
Name string `json:"name,omitempty"`
// URI path for this trigger. e.g. `sayHello`, `say/hello`
Source string `json:"source,omitempty"`
// Class of trigger, e.g. schedule, http, queue
Type string `json:"type,omitempty"`
// Most recent time that trigger was updated. Always in UTC.
// Read Only: true
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}
Trigger trigger
swagger:model Trigger
func (*Trigger) MarshalBinary ¶
MarshalBinary interface implementation
func (*Trigger) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TriggerList ¶
type TriggerList struct {
// items
// Required: true
Items []*Trigger `json:"items"`
// Cursor to send with subsequent request to receive the next page, if non-empty.
// Read Only: true
NextCursor string `json:"next_cursor,omitempty"`
}
TriggerList trigger list
swagger:model TriggerList
func (*TriggerList) MarshalBinary ¶
func (m *TriggerList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TriggerList) UnmarshalBinary ¶
func (m *TriggerList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation