Documentation
¶
Index ¶
- Variables
- func ValidateAgentRelease(result *AgentRelease) (err error)
- func ValidateAgentReleaseView(result *AgentReleaseView) (err error)
- func ValidateAgentRenew(result *AgentRenew) (err error)
- func ValidateAgentRenewView(result *AgentRenewView) (err error)
- func ValidateAgentStatus(result *AgentStatus) (err error)
- func ValidateAgentStatusView(result *AgentStatusView) (err error)
- func ValidateAgentTicket(result *AgentTicket) (err error)
- func ValidateAgentTicketView(result *AgentTicketView) (err error)
- type AgentRelease
- type AgentReleaseView
- type AgentRenew
- type AgentRenewView
- type AgentStatus
- type AgentStatusView
- type AgentTicket
- type AgentTicketView
Constants ¶
This section is empty.
Variables ¶
var ( // AgentTicketMap is a map indexing the attribute names of AgentTicket by view // name. AgentTicketMap = map[string][]string{ "default": { "id", "ticket", "ttl_ms", "protocol", }, } // AgentRenewMap is a map indexing the attribute names of AgentRenew by view // name. AgentRenewMap = map[string][]string{ "default": { "ttl_ms", "protocol", }, } // AgentStatusMap is a map indexing the attribute names of AgentStatus by view // name. AgentStatusMap = map[string][]string{ "default": { "active", "sessions", "protocol", }, } // AgentReleaseMap is a map indexing the attribute names of AgentRelease by // view name. AgentReleaseMap = map[string][]string{ "default": { "ok", }, } )
Functions ¶
func ValidateAgentRelease ¶
func ValidateAgentRelease(result *AgentRelease) (err error)
ValidateAgentRelease runs the validations defined on the viewed result type AgentRelease.
func ValidateAgentReleaseView ¶
func ValidateAgentReleaseView(result *AgentReleaseView) (err error)
ValidateAgentReleaseView runs the validations defined on AgentReleaseView using the "default" view.
func ValidateAgentRenew ¶
func ValidateAgentRenew(result *AgentRenew) (err error)
ValidateAgentRenew runs the validations defined on the viewed result type AgentRenew.
func ValidateAgentRenewView ¶
func ValidateAgentRenewView(result *AgentRenewView) (err error)
ValidateAgentRenewView runs the validations defined on AgentRenewView using the "default" view.
func ValidateAgentStatus ¶
func ValidateAgentStatus(result *AgentStatus) (err error)
ValidateAgentStatus runs the validations defined on the viewed result type AgentStatus.
func ValidateAgentStatusView ¶
func ValidateAgentStatusView(result *AgentStatusView) (err error)
ValidateAgentStatusView runs the validations defined on AgentStatusView using the "default" view.
func ValidateAgentTicket ¶
func ValidateAgentTicket(result *AgentTicket) (err error)
ValidateAgentTicket runs the validations defined on the viewed result type AgentTicket.
func ValidateAgentTicketView ¶
func ValidateAgentTicketView(result *AgentTicketView) (err error)
ValidateAgentTicketView runs the validations defined on AgentTicketView using the "default" view.
Types ¶
type AgentRelease ¶
type AgentRelease struct {
// Type to project
Projected *AgentReleaseView
// View to render
View string
}
AgentRelease is the viewed result type that is projected based on a view.
type AgentReleaseView ¶
type AgentReleaseView struct {
// Whether the session is gone (unknown ids report ok: best-effort release)
OK *bool
}
AgentReleaseView is a type that runs validations on a projected type.
type AgentRenew ¶
type AgentRenew struct {
// Type to project
Projected *AgentRenewView
// View to render
View string
}
AgentRenew is the viewed result type that is projected based on a view.
type AgentRenewView ¶
type AgentRenewView struct {
// Renewed lifetime in milliseconds
TTLMs *int
// Agent ticket/API revision
Protocol *int
}
AgentRenewView is a type that runs validations on a projected type.
type AgentStatus ¶
type AgentStatus struct {
// Type to project
Projected *AgentStatusView
// View to render
View string
}
AgentStatus is the viewed result type that is projected based on a view.
type AgentStatusView ¶
type AgentStatusView struct {
// Whether at least one live agent session is bound to this workspace
Active *bool
// Live (unexpired) session count for this workspace
Sessions *int
// Agent ticket/API revision
Protocol *int
}
AgentStatusView is a type that runs validations on a projected type.
type AgentTicket ¶
type AgentTicket struct {
// Type to project
Projected *AgentTicketView
// View to render
View string
}
AgentTicket is the viewed result type that is projected based on a view.
type AgentTicketView ¶
type AgentTicketView struct {
// Opaque server-side session identifier for renew/release correlation. Never
// sent to the guest
ID *string
// Signed bearer ticket (id.payload.signature) to present in the agent attach
// message
Ticket *string
// Ticket/session lifetime in milliseconds; renew at half of it
TTLMs *int
// Agent ticket/API revision
Protocol *int
}
AgentTicketView is a type that runs validations on a projected type.
Source Files