Documentation
¶
Index ¶
- type ActionEnum
- type EligibleEnum
- type Error
- type ErrorResponse
- type Group
- type History
- type Job
- type JobRequest
- type JobStatus
- type PaginatedJobList
- type PaginatedJobListPagination
- func (m *PaginatedJobListPagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PaginatedJobListPagination) MarshalBinary() ([]byte, error)
- func (m *PaginatedJobListPagination) UnmarshalBinary(b []byte) error
- func (m *PaginatedJobListPagination) Validate(formats strfmt.Registry) error
- type PaginatedWorkflowList
- type PaginatedWorkflowListPagination
- func (m *PaginatedWorkflowListPagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PaginatedWorkflowListPagination) MarshalBinary() ([]byte, error)
- func (m *PaginatedWorkflowListPagination) UnmarshalBinary(b []byte) error
- func (m *PaginatedWorkflowListPagination) Validate(formats strfmt.Registry) error
- type State
- type Transition
- type Workflow
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActionEnum ¶
type ActionEnum string
ActionEnum action enum
swagger:model ActionEnum
const ( // ActionEnumIMMEDIATE captures enum value "IMMEDIATE" ActionEnumIMMEDIATE ActionEnum = "IMMEDIATE" // ActionEnumWAIT captures enum value "WAIT" ActionEnumWAIT ActionEnum = "WAIT" )
func NewActionEnum ¶
func NewActionEnum(value ActionEnum) *ActionEnum
func (ActionEnum) ContextValidate ¶
ContextValidate validates this action enum based on context it is used
func (ActionEnum) Pointer ¶
func (m ActionEnum) Pointer() *ActionEnum
Pointer returns a pointer to a freshly-allocated ActionEnum.
type EligibleEnum ¶
type EligibleEnum string
EligibleEnum eligible enum
swagger:model EligibleEnum
const ( // EligibleEnumCLIENT captures enum value "CLIENT" EligibleEnumCLIENT EligibleEnum = "CLIENT" // EligibleEnumWFX captures enum value "WFX" EligibleEnumWFX EligibleEnum = "WFX" )
func NewEligibleEnum ¶
func NewEligibleEnum(value EligibleEnum) *EligibleEnum
func (EligibleEnum) ContextValidate ¶
ContextValidate validates this eligible enum based on context it is used
func (EligibleEnum) Pointer ¶
func (m EligibleEnum) Pointer() *EligibleEnum
Pointer returns a pointer to a freshly-allocated EligibleEnum.
type Error ¶
type Error struct {
// Identifier code for the reason of the error
Code string `json:"code,omitempty"`
// Log correlation ID
Logref string `json:"logref,omitempty"`
// Error message
Message string `json:"message,omitempty"`
}
Error error
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct {
// errors
// Max Items: 128
Errors []*Error `json:"errors"`
}
ErrorResponse error response
swagger:model ErrorResponse
func (*ErrorResponse) ContextValidate ¶
ContextValidate validate this error response based on the context it is used
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Group ¶
type Group struct {
// description
// Example: Description of the group
Description string `json:"description,omitempty"`
// name
// Example: OPEN
// Required: true
Name string `json:"name"`
// A list of states belonging to this group
// Required: true
// Max Items: 4096
// Min Items: 1
States []string `json:"states"`
}
Group group
swagger:model Group
func (*Group) ContextValidate ¶
ContextValidate validates this group based on context it is used
func (*Group) MarshalBinary ¶
MarshalBinary interface implementation
func (*Group) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type History ¶
type History struct {
// definition
// Example: { \"userDefined\": {} }\n
Definition map[string]interface{} `json:"definition,omitempty"`
// Date and time (ISO8601) when the job was modified (set by wfx)
// Read Only: true
// Format: date-time
Mtime strfmt.DateTime `json:"mtime,omitempty"`
// A previous job status
Status *JobStatus `json:"status,omitempty"`
}
History history
swagger:model History
func (*History) ContextValidate ¶
ContextValidate validate this history based on the context it is used
func (*History) MarshalBinary ¶
MarshalBinary interface implementation
func (*History) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Job ¶
type Job struct {
// client Id
// Example: client42
ClientID string `json:"clientId,omitempty"`
// definition
// Example: { \"userDefined\": {} }\n
Definition map[string]interface{} `json:"definition,omitempty"`
// The job's history. Last in, first out (LIFO). Array is truncated if its length exceeds the maximum allowed length.
// By default, the job history is omitted from responses unless explicitly requested by the client (see the `history` URL parameter).
//
// Max Items: 8192
History []*History `json:"history,omitempty"`
// Unique job ID (wfx-generated)
// Example: 3307e5cb-074c-49b7-99d4-5e61839a4c2d
// Read Only: true
// Max Length: 36
ID string `json:"id,omitempty"`
// Date and time (ISO8601) when the job was last modified (set by wfx)
// Read Only: true
// Format: date-time
Mtime *strfmt.DateTime `json:"mtime,omitempty"`
// status
Status *JobStatus `json:"status,omitempty"`
// Date and time (ISO8601) when the job was created (set by wfx). Although stime conceptually always exists, it's nullable because we don't want to serialize stime in some cases (e.g. for job events).
// Read Only: true
// Format: date-time
Stime *strfmt.DateTime `json:"stime,omitempty"`
// tags
Tags []string `json:"tags,omitempty"`
// workflow
Workflow *Workflow `json:"workflow,omitempty"`
}
Job job
swagger:model Job
func (*Job) ContextValidate ¶
ContextValidate validate this job based on the context it is used
func (*Job) MarshalBinary ¶
MarshalBinary interface implementation
func (*Job) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type JobRequest ¶
type JobRequest struct {
// Create job for the given client ID
// Example: client42
// Required: true
ClientID string `json:"clientId"`
// The existing job definition will be replaced with this if this property is not empty.
// Example: { \"userDefined\": {} }\n
Definition map[string]interface{} `json:"definition,omitempty"`
// tags
// Max Items: 16
Tags []string `json:"tags"`
// Workflow name
// Example: wfx.workflow.dau.direct
// Required: true
Workflow string `json:"workflow"`
}
JobRequest job request
swagger:model JobRequest
func (*JobRequest) ContextValidate ¶
ContextValidate validates this job request based on context it is used
func (*JobRequest) MarshalBinary ¶
func (m *JobRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*JobRequest) UnmarshalBinary ¶
func (m *JobRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type JobStatus ¶
type JobStatus struct {
// Client which sent the status update
// Example: client42
ClientID string `json:"clientId,omitempty"`
// Client-specific JSON object to report additional context information such as error details, stack traces, etc
// Example: {\n \"lines\": [ \"line1\", \"line2\" ]\n}\n
Context map[string]interface{} `json:"context,omitempty"`
// Job definition hash
// Read Only: true
// Max Length: 64
DefinitionHash string `json:"definitionHash,omitempty"`
// Reason message/info, free text from client
// Max Length: 1024
Message string `json:"message,omitempty"`
// Current job progress percentage
// Maximum: 100
Progress int32 `json:"progress,omitempty"`
// Name of the new workflow state
// Example: END
// Required: true
State string `json:"state"`
}
JobStatus Job status information
swagger:model JobStatus
func (*JobStatus) ContextValidate ¶
ContextValidate validate this job status based on the context it is used
func (*JobStatus) MarshalBinary ¶
MarshalBinary interface implementation
func (*JobStatus) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PaginatedJobList ¶
type PaginatedJobList struct {
// content
Content []*Job `json:"content"`
// pagination
Pagination *PaginatedJobListPagination `json:"pagination,omitempty"`
}
PaginatedJobList Paginated list of jobs
swagger:model PaginatedJobList
func (*PaginatedJobList) ContextValidate ¶
ContextValidate validate this paginated job list based on the context it is used
func (*PaginatedJobList) MarshalBinary ¶
func (m *PaginatedJobList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedJobList) UnmarshalBinary ¶
func (m *PaginatedJobList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PaginatedJobListPagination ¶
type PaginatedJobListPagination struct {
// the maximum number of items to return
// Example: 20
Limit int32 `json:"limit,omitempty"`
// the number of items to skip before starting to return results
// Example: 0
Offset int64 `json:"offset,omitempty"`
// the total number of items
// Example: 1000
Total int64 `json:"total,omitempty"`
}
PaginatedJobListPagination paginated job list pagination
swagger:model PaginatedJobListPagination
func (*PaginatedJobListPagination) ContextValidate ¶
func (m *PaginatedJobListPagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this paginated job list pagination based on context it is used
func (*PaginatedJobListPagination) MarshalBinary ¶
func (m *PaginatedJobListPagination) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedJobListPagination) UnmarshalBinary ¶
func (m *PaginatedJobListPagination) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PaginatedWorkflowList ¶
type PaginatedWorkflowList struct {
// content
Content []*Workflow `json:"content"`
// pagination
Pagination *PaginatedWorkflowListPagination `json:"pagination,omitempty"`
}
PaginatedWorkflowList Paginated list of workflows
swagger:model PaginatedWorkflowList
func (*PaginatedWorkflowList) ContextValidate ¶
ContextValidate validate this paginated workflow list based on the context it is used
func (*PaginatedWorkflowList) MarshalBinary ¶
func (m *PaginatedWorkflowList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedWorkflowList) UnmarshalBinary ¶
func (m *PaginatedWorkflowList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PaginatedWorkflowListPagination ¶
type PaginatedWorkflowListPagination struct {
// the maximum number of items to return
// Example: 20
Limit int32 `json:"limit,omitempty"`
// the number of items to skip before starting to return results
// Example: 0
Offset int64 `json:"offset,omitempty"`
// the total number of items
// Example: 1000
Total int64 `json:"total,omitempty"`
}
PaginatedWorkflowListPagination paginated workflow list pagination
swagger:model PaginatedWorkflowListPagination
func (*PaginatedWorkflowListPagination) ContextValidate ¶
func (m *PaginatedWorkflowListPagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this paginated workflow list pagination based on context it is used
func (*PaginatedWorkflowListPagination) MarshalBinary ¶
func (m *PaginatedWorkflowListPagination) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedWorkflowListPagination) UnmarshalBinary ¶
func (m *PaginatedWorkflowListPagination) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type State ¶
type State struct {
// description
// Example: Description of the state
Description string `json:"description,omitempty"`
// name
// Example: START
// Required: true
Name string `json:"name"`
}
State state
swagger:model State
func (*State) ContextValidate ¶
ContextValidate validates this state based on context it is used
func (*State) MarshalBinary ¶
MarshalBinary interface implementation
func (*State) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Transition ¶
type Transition struct {
// The transition execution action (default: WAIT)
// Example: WAIT
Action ActionEnum `json:"action,omitempty"`
// description
// Example: Description of the transition
Description string `json:"description,omitempty"`
// The entity that may execute the transition
// Example: CLIENT
// Required: true
Eligible EligibleEnum `json:"eligible"`
// from
// Example: START
// Required: true
From string `json:"from"`
// to
// Example: END
// Required: true
To string `json:"to"`
}
Transition transition
swagger:model Transition
func (*Transition) ContextValidate ¶
ContextValidate validate this transition based on the context it is used
func (*Transition) MarshalBinary ¶
func (m *Transition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Transition) UnmarshalBinary ¶
func (m *Transition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Workflow ¶
type Workflow struct {
// Description of the workflow
// Example: This is a workflow
// Max Length: 1024
Description string `json:"description,omitempty"`
// groups
// Max Items: 1024
Groups []*Group `json:"groups,omitempty"`
// User provided unique workflow name
// Example: wfx.workflow.dau.direct
// Required: true
// Max Length: 64
// Min Length: 1
// Pattern: ^[a-zA-Z0-9\-\.]+$
Name string `json:"name"`
// states
// Max Items: 4096
States []*State `json:"states,omitempty"`
// transitions
// Max Items: 16384
Transitions []*Transition `json:"transitions,omitempty"`
}
Workflow workflow
swagger:model Workflow
func (*Workflow) ContextValidate ¶
ContextValidate validate this workflow based on the context it is used
func (*Workflow) MarshalBinary ¶
MarshalBinary interface implementation
func (*Workflow) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files