Documentation
¶
Index ¶
- Variables
- type APIToken
- type Account
- type AppProject
- type AppProjectEdge
- type AppProjectPage
- type AppProjectSlice
- type Application
- type ApplicationEdge
- type ApplicationPage
- type ApplicationSlice
- type BaseEntity
- type CalendarEventPayloadData
- type Component
- type ComponentEdge
- type ComponentPage
- type ComponentSlice
- type Customer
- type Edge
- type Entity
- type Error
- type ErrorTypes
- type Event
- type EventB
- type EventPayload
- type EventPayloadData
- type EventPayloadEdge
- type EventPayloadPage
- type EventPayloadSlice
- type EventResponse
- type EventSource
- type EventSourceEdge
- type EventSourcePage
- type EventSourceSlice
- type GitEventPayloadData
- type GitIntegration
- type GitIntegrationEdge
- type GitIntegrationPage
- type GitIntegrationSlice
- type GitProviders
- type GitSource
- type GitSourceEdge
- type GitSourcePage
- type GitSourceSlice
- type GithubEvent
- type GitopsEntity
- type GitopsEntitySource
- type HTTPTrigger
- type HealthStatus
- type K8sLogicEntity
- type K8sStandardEntity
- type Me
- type NodeStatus
- type ObjectMeta
- type Page
- type PageInfo
- type Phases
- type Pipeline
- type PipelineEdge
- type PipelinePage
- type PipelineSlice
- type Progress
- type Project
- type ProjectBasedEntity
- type ProjectEdge
- type ProjectPage
- type ProjectSlice
- type PushPayload
- type Release
- type ResourceEvent
- type Runtime
- type RuntimeCreationResponse
- type RuntimeEdge
- type RuntimePage
- type RuntimePushPayload
- type RuntimeSlice
- type Sensor
- type SensorDependency
- type SensorEdge
- type SensorPage
- type SensorSlice
- type SensorTrigger
- type Slice
- type SliceInfo
- type SlicePaginationArgs
- type StatusHistoryItem
- type StringPair
- type SwitchAccountResponse
- type SyncStatus
- type UserDetails
- type UserInfo
- type UserRole
- type UserStatus
- type Workflow
- type WorkflowContainerTemplate
- type WorkflowDAGTask
- type WorkflowDAGTemplate
- type WorkflowEdge
- type WorkflowPage
- type WorkflowResourceTemplate
- type WorkflowScriptTemplate
- type WorkflowSlice
- type WorkflowSpec
- type WorkflowSpecTemplate
- type WorkflowStatus
- type WorkflowStep
- type WorkflowStepsTemplate
- type WorkflowSuspendedTemplate
- type WorkflowTemplate
- type WorkflowTemplateEdge
- type WorkflowTemplatePage
- type WorkflowTemplateRef
- type WorkflowTemplateSlice
- type WorkflowTrigger
- type WorkflowTriggerOperation
- type WorkflowsFilterArgs
Constants ¶
This section is empty.
Variables ¶
var AllErrorTypes = []ErrorTypes{ ErrorTypesPermission, ErrorTypesSyntax, }
var AllGitProviders = []GitProviders{ GitProvidersGithub, GitProvidersGitlab, }
var AllHealthStatus = []HealthStatus{ HealthStatusDegraded, HealthStatusHealthy, HealthStatusMissing, HealthStatusProgressing, HealthStatusSuspended, HealthStatusUnknown, }
var AllPhases = []Phases{ PhasesError, PhasesFailed, PhasesPending, PhasesRunning, PhasesSucceeded, PhasesTerminated, }
var AllSyncStatus = []SyncStatus{ SyncStatusOutOfSync, SyncStatusSynced, SyncStatusUnknown, }
var AllUserRole = []UserRole{ UserRoleAccountAdmin, UserRoleAdmin, UserRoleUser, }
var AllUserStatus = []UserStatus{ UserStatusNew, UserStatusPending, UserStatusSuspended, UserStatusUnverifed, }
Functions ¶
This section is empty.
Types ¶
type APIToken ¶
type APIToken struct {
// The token to use in runtime installation and other requests
Token *string `json:"token"`
}
"Generate api token result
type Account ¶
type Account struct {
// The account id
ID string `json:"id"`
// The account unique name
Name string `json:"name"`
}
Account is logical entity that group together users pipeliens and more
type AppProject ¶ added in v0.30.3
type AppProject struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Version of the entity
Version *int `json:"version"`
// Is this the latest version of this entity
Latest *bool `json:"latest"`
// Entity source
Source *GitopsEntitySource `json:"source"`
// Sync status
SyncStatus SyncStatus `json:"syncStatus"`
// Health status
HealthStatus *HealthStatus `json:"healthStatus"`
// Health message
HealthMessage *string `json:"healthMessage"`
// Desired manifest
DesiredManifest *string `json:"desiredManifest"`
// Actual manifest
ActualManifest *string `json:"actualManifest"`
// Projects
Projects []string `json:"projects"`
}
AppProject entity
func (AppProject) IsBaseEntity ¶ added in v0.30.3
func (AppProject) IsBaseEntity()
func (AppProject) IsEntity ¶ added in v0.30.3
func (AppProject) IsEntity()
func (AppProject) IsGitopsEntity ¶ added in v0.30.3
func (AppProject) IsGitopsEntity()
func (AppProject) IsProjectBasedEntity ¶ added in v0.30.3
func (AppProject) IsProjectBasedEntity()
type AppProjectEdge ¶ added in v0.30.3
type AppProjectEdge struct {
// Node contains the actual app-project data
Node *AppProject `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
AppProject Edge
func (AppProjectEdge) IsEdge ¶ added in v0.30.3
func (AppProjectEdge) IsEdge()
type AppProjectPage ¶ added in v0.30.3
type AppProjectPage struct {
// Total amount of app-projects
TotalCount int `json:"totalCount"`
// App project edges
Edges []*AppProjectEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
AppProject Page
func (AppProjectPage) IsPage ¶ added in v0.30.3
func (AppProjectPage) IsPage()
type AppProjectSlice ¶ added in v0.30.3
type AppProjectSlice struct {
// AppProject edges
Edges []*AppProjectEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
AppProject Slice
func (AppProjectSlice) IsSlice ¶ added in v0.30.3
func (AppProjectSlice) IsSlice()
type Application ¶ added in v0.30.3
type Application struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Version of the entity
Version *int `json:"version"`
// Is this the latest version of this entity
Latest *bool `json:"latest"`
// Entity source
Source *GitopsEntitySource `json:"source"`
// Sync status
SyncStatus SyncStatus `json:"syncStatus"`
// Health status
HealthStatus *HealthStatus `json:"healthStatus"`
// Health message
HealthMessage *string `json:"healthMessage"`
// Desired manifest
DesiredManifest *string `json:"desiredManifest"`
// Actual manifest
ActualManifest *string `json:"actualManifest"`
// Projects
Projects []string `json:"projects"`
}
Application entity
func (Application) IsBaseEntity ¶ added in v0.30.3
func (Application) IsBaseEntity()
func (Application) IsEntity ¶ added in v0.30.3
func (Application) IsEntity()
func (Application) IsGitopsEntity ¶ added in v0.30.3
func (Application) IsGitopsEntity()
func (Application) IsProjectBasedEntity ¶ added in v0.30.3
func (Application) IsProjectBasedEntity()
type ApplicationEdge ¶ added in v0.30.3
type ApplicationEdge struct {
// Node contains the actual application data
Node *Application `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Application Edge
func (ApplicationEdge) IsEdge ¶ added in v0.30.3
func (ApplicationEdge) IsEdge()
type ApplicationPage ¶ added in v0.30.3
type ApplicationPage struct {
// Total amount of applications
TotalCount int `json:"totalCount"`
// Application edges
Edges []*ApplicationEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Application Page
func (ApplicationPage) IsPage ¶ added in v0.30.3
func (ApplicationPage) IsPage()
type ApplicationSlice ¶ added in v0.30.3
type ApplicationSlice struct {
// Application edges
Edges []*ApplicationEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Application Slice
func (ApplicationSlice) IsSlice ¶ added in v0.30.3
func (ApplicationSlice) IsSlice()
type CalendarEventPayloadData ¶ added in v0.30.3
type CalendarEventPayloadData struct {
// Type
Type string `json:"type"`
// Repository
Schedule string `json:"schedule"`
// EventType
Interval string `json:"interval"`
// Branch
Timezone string `json:"timezone"`
// Initiator
Metadata string `json:"metadata"`
}
Calendar event payload data
func (CalendarEventPayloadData) IsEventPayloadData ¶ added in v0.30.3
func (CalendarEventPayloadData) IsEventPayloadData()
type Component ¶
type Component struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Self entity reference for the real k8s entity in case of codefresh logical entity
Self *AppProject `json:"self"`
// Projects
Projects []string `json:"projects"`
}
Component entity
func (Component) IsBaseEntity ¶
func (Component) IsBaseEntity()
func (Component) IsK8sLogicEntity ¶ added in v0.30.3
func (Component) IsK8sLogicEntity()
func (Component) IsProjectBasedEntity ¶
func (Component) IsProjectBasedEntity()
type ComponentEdge ¶
type ComponentEdge struct {
// Node contains the actual component data
Node *Component `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Component Edge
func (ComponentEdge) IsEdge ¶
func (ComponentEdge) IsEdge()
type ComponentPage ¶
type ComponentPage struct {
// Total amount of components
TotalCount int `json:"totalCount"`
// Component edges
Edges []*ComponentEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Component Page
func (ComponentPage) IsPage ¶
func (ComponentPage) IsPage()
type ComponentSlice ¶
type ComponentSlice struct {
// Component edges
Edges []*ComponentEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Component Slice
func (ComponentSlice) IsSlice ¶
func (ComponentSlice) IsSlice()
type Error ¶
type Error struct {
// Type
Type *ErrorTypes `json:"type"`
// Code
Code *int `json:"code"`
// Title
Title *string `json:"title"`
// Message
Message *string `json:"message"`
// Suggestion
Suggestion *string `json:"suggestion"`
}
Error
type ErrorTypes ¶
type ErrorTypes string
Error types
const ( // Permission error ErrorTypesPermission ErrorTypes = "PERMISSION" // Syntax error ErrorTypesSyntax ErrorTypes = "SYNTAX" )
func (ErrorTypes) IsValid ¶
func (e ErrorTypes) IsValid() bool
func (ErrorTypes) MarshalGQL ¶
func (e ErrorTypes) MarshalGQL(w io.Writer)
func (ErrorTypes) String ¶
func (e ErrorTypes) String() string
func (*ErrorTypes) UnmarshalGQL ¶
func (e *ErrorTypes) UnmarshalGQL(v interface{}) error
type EventB ¶ added in v0.30.3
type EventB struct {
// Name of event
Name *string `json:"name"`
}
Remove this later
func (EventB) IsPushPayload ¶ added in v0.30.3
func (EventB) IsPushPayload()
type EventPayload ¶ added in v0.30.3
type EventPayload struct {
// UID of event
UID *string `json:"uid"`
// Content of the event
Data *string `json:"data"`
// Time
Time *string `json:"time"`
// Event source
EventSource *EventSource `json:"eventSource"`
// Event name
EventName *string `json:"eventName"`
// Event type
EventType *string `json:"eventType"`
// Account
Account *string `json:"account"`
// Runtime
Runtime *string `json:"runtime"`
}
Event payload entity
func (EventPayload) IsEntity ¶ added in v0.30.3
func (EventPayload) IsEntity()
type EventPayloadData ¶ added in v0.30.3
type EventPayloadData interface {
IsEventPayloadData()
}
Event payload data types
type EventPayloadEdge ¶ added in v0.30.3
type EventPayloadEdge struct {
// Node contains the actual event payload data
Node *EventPayload `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
EventPayload Edge
func (EventPayloadEdge) IsEdge ¶ added in v0.30.3
func (EventPayloadEdge) IsEdge()
type EventPayloadPage ¶ added in v0.30.3
type EventPayloadPage struct {
// Total amount of EventPayload
TotalCount int `json:"totalCount"`
// EventPayload edges
Edges []*EventPayloadEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
EventPayload Page
func (EventPayloadPage) IsPage ¶ added in v0.30.3
func (EventPayloadPage) IsPage()
type EventPayloadSlice ¶ added in v0.30.3
type EventPayloadSlice struct {
// EventPayload edges
Edges []*EventPayloadEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
EventPayload Slice
func (EventPayloadSlice) IsSlice ¶ added in v0.30.3
func (EventPayloadSlice) IsSlice()
type EventResponse ¶ added in v0.30.3
type EventResponse struct {
// Account ID
AccountID string `json:"accountId"`
// Time of event
Time string `json:"time"`
// Payload of event
Payload PushPayload `json:"payload"`
}
EventResponse
type EventSource ¶
type EventSource struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Version of the entity
Version *int `json:"version"`
// Is this the latest version of this entity
Latest *bool `json:"latest"`
// Entity source
Source *GitopsEntitySource `json:"source"`
// Sync status
SyncStatus SyncStatus `json:"syncStatus"`
// Health status
HealthStatus *HealthStatus `json:"healthStatus"`
// Health message
HealthMessage *string `json:"healthMessage"`
// Desired manifest
DesiredManifest *string `json:"desiredManifest"`
// Actual manifest
ActualManifest *string `json:"actualManifest"`
// Projects
Projects []string `json:"projects"`
}
Event source entity
func (EventSource) IsBaseEntity ¶
func (EventSource) IsBaseEntity()
func (EventSource) IsEntity ¶
func (EventSource) IsEntity()
func (EventSource) IsGitopsEntity ¶
func (EventSource) IsGitopsEntity()
func (EventSource) IsProjectBasedEntity ¶
func (EventSource) IsProjectBasedEntity()
type EventSourceEdge ¶
type EventSourceEdge struct {
// Node contains the actual event source data
Node *EventSource `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Event source Edge
func (EventSourceEdge) IsEdge ¶
func (EventSourceEdge) IsEdge()
type EventSourcePage ¶
type EventSourcePage struct {
// Total amount of event sources
TotalCount int `json:"totalCount"`
// Event source edges
Edges []*EventSourceEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Event source Page
func (EventSourcePage) IsPage ¶
func (EventSourcePage) IsPage()
type EventSourceSlice ¶
type EventSourceSlice struct {
// Event source edges
Edges []*EventSourceEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Event source Slice
func (EventSourceSlice) IsSlice ¶
func (EventSourceSlice) IsSlice()
type GitEventPayloadData ¶ added in v0.30.3
type GitEventPayloadData struct {
// Type
Type string `json:"type"`
// Repository
Repository string `json:"repository"`
// EventType
EventType string `json:"eventType"`
// Branch
Branch string `json:"branch"`
// Initiator
Initiator string `json:"initiator"`
// Commit data
Commit *string `json:"commit"`
}
Git event payload data
func (GitEventPayloadData) IsEventPayloadData ¶ added in v0.30.3
func (GitEventPayloadData) IsEventPayloadData()
type GitIntegration ¶
type GitIntegration struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Version of the entity
Version *int `json:"version"`
// Is this the latest version of this entity
Latest *bool `json:"latest"`
// Entity source
Source *GitopsEntitySource `json:"source"`
// Sync status
SyncStatus SyncStatus `json:"syncStatus"`
// Health status
HealthStatus *HealthStatus `json:"healthStatus"`
// Health message
HealthMessage *string `json:"healthMessage"`
// Desired manifest
DesiredManifest *string `json:"desiredManifest"`
// Actual manifest
ActualManifest *string `json:"actualManifest"`
// Projects
Projects []string `json:"projects"`
// Git provider
Provider *GitProviders `json:"provider"`
// API URL of the git provider
APIURL string `json:"apiUrl"`
}
Git integration entity
func (GitIntegration) IsBaseEntity ¶
func (GitIntegration) IsBaseEntity()
func (GitIntegration) IsEntity ¶
func (GitIntegration) IsEntity()
func (GitIntegration) IsGitopsEntity ¶
func (GitIntegration) IsGitopsEntity()
func (GitIntegration) IsProjectBasedEntity ¶
func (GitIntegration) IsProjectBasedEntity()
type GitIntegrationEdge ¶
type GitIntegrationEdge struct {
// Node contains the actual git integration data
Node *GitIntegration `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Git integration Edge
func (GitIntegrationEdge) IsEdge ¶
func (GitIntegrationEdge) IsEdge()
type GitIntegrationPage ¶
type GitIntegrationPage struct {
// Total amount of git integration
TotalCount int `json:"totalCount"`
// Git integration edges
Edges []*GitIntegrationEdge `json:"edges"`
// Git integration information
PageInfo *PageInfo `json:"pageInfo"`
}
Git integration Page
func (GitIntegrationPage) IsPage ¶
func (GitIntegrationPage) IsPage()
type GitIntegrationSlice ¶
type GitIntegrationSlice struct {
// Git integration edges
Edges []*GitIntegrationEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Git integration Slice
func (GitIntegrationSlice) IsSlice ¶
func (GitIntegrationSlice) IsSlice()
type GitProviders ¶
type GitProviders string
Git Providers
const ( // Github GitProvidersGithub GitProviders = "GITHUB" // Gitlab GitProvidersGitlab GitProviders = "GITLAB" )
func (GitProviders) IsValid ¶
func (e GitProviders) IsValid() bool
func (GitProviders) MarshalGQL ¶
func (e GitProviders) MarshalGQL(w io.Writer)
func (GitProviders) String ¶
func (e GitProviders) String() string
func (*GitProviders) UnmarshalGQL ¶
func (e *GitProviders) UnmarshalGQL(v interface{}) error
type GitSource ¶
type GitSource struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Self entity reference for the real k8s entity in case of codefresh logical entity
Self *AppProject `json:"self"`
// Projects
Projects []string `json:"projects"`
}
Git source entity
func (GitSource) IsBaseEntity ¶
func (GitSource) IsBaseEntity()
func (GitSource) IsK8sLogicEntity ¶ added in v0.30.3
func (GitSource) IsK8sLogicEntity()
func (GitSource) IsProjectBasedEntity ¶
func (GitSource) IsProjectBasedEntity()
type GitSourceEdge ¶
type GitSourceEdge struct {
// Node contains the actual git source data
Node *GitSource `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Git source Edge
func (GitSourceEdge) IsEdge ¶
func (GitSourceEdge) IsEdge()
type GitSourcePage ¶
type GitSourcePage struct {
// Total amount of git sources
TotalCount int `json:"totalCount"`
// Git source edges
Edges []*GitSourceEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Git source Page
func (GitSourcePage) IsPage ¶
func (GitSourcePage) IsPage()
type GitSourceSlice ¶
type GitSourceSlice struct {
// Git source edges
Edges []*GitSourceEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Git source Slice
func (GitSourceSlice) IsSlice ¶
func (GitSourceSlice) IsSlice()
type GithubEvent ¶
type GithubEvent struct {
// Name
Name string `json:"name"`
// Repository owner
Owner string `json:"owner"`
// Repository names
Repositories []string `json:"repositories"`
// Webhook events
Events []string `json:"events"`
}
Github event
func (GithubEvent) IsEvent ¶
func (GithubEvent) IsEvent()
type GitopsEntitySource ¶
type GitopsEntitySource struct {
// Entity source
GitSource *GitSource `json:"gitSource"`
// Path
Path string `json:"path"`
// Git revision
Revision string `json:"revision"`
// Git manifest
GitManifest string `json:"gitManifest"`
}
Gitops entity source
type HTTPTrigger ¶
type HTTPTrigger struct {
// Name
Name string `json:"name"`
// Conditions
Conditions string `json:"conditions"`
// Url
URL string `json:"url"`
// Method
Method string `json:"method"`
}
Http Trigger
func (HTTPTrigger) IsSensorTrigger ¶
func (HTTPTrigger) IsSensorTrigger()
type HealthStatus ¶
type HealthStatus string
Health Status
const ( // resource status indicates failure HealthStatusDegraded HealthStatus = "DEGRADED" // resource is healthy HealthStatusHealthy HealthStatus = "HEALTHY" // resource is missing from the cluster HealthStatusMissing HealthStatus = "MISSING" // resource not yet healthy but has a chance to become healthy HealthStatusProgressing HealthStatus = "PROGRESSING" // resource is suspended (for example: cronjob) HealthStatusSuspended HealthStatus = "SUSPENDED" // health assessment failed HealthStatusUnknown HealthStatus = "UNKNOWN" )
func (HealthStatus) IsValid ¶
func (e HealthStatus) IsValid() bool
func (HealthStatus) MarshalGQL ¶
func (e HealthStatus) MarshalGQL(w io.Writer)
func (HealthStatus) String ¶
func (e HealthStatus) String() string
func (*HealthStatus) UnmarshalGQL ¶
func (e *HealthStatus) UnmarshalGQL(v interface{}) error
type K8sLogicEntity ¶ added in v0.30.3
type K8sLogicEntity interface {
IsK8sLogicEntity()
}
K8s logic entity
type K8sStandardEntity ¶ added in v0.30.3
type K8sStandardEntity interface {
IsK8sStandardEntity()
}
Base entity
type Me ¶
type Me struct {
// The user id
ID string `json:"id"`
// The roles of the user provide specific permission for the current user
Roles []*UserRole `json:"roles"`
// The accounts the this user have acsess to
Accounts []*Account `json:"accounts"`
// The default account for this user
ActiveAccount *Account `json:"activeAccount"`
// The customers that this user is in
Customers []Customer `json:"customers"`
// The current status of this user
Status *UserStatus `json:"status"`
// Provide details about this user
Details *UserDetails `json:"details"`
// Provide info on user
Info *UserInfo `json:"info"`
}
Me
type NodeStatus ¶ added in v0.30.3
type NodeStatus struct {
// Type
Type string `json:"type"`
// Name
Name string `json:"name"`
// Display name
DisplayName string `json:"displayName"`
// Template Name
TemplateName string `json:"templateName"`
// Node children
Children []*string `json:"children"`
// Current step phase
Phase *Phases `json:"phase"`
// Progress
Progress *Progress `json:"progress"`
// Message
Message *string `json:"message"`
// Start time
StartedAt *string `json:"startedAt"`
// Finish time
FinishedAt *string `json:"finishedAt"`
// Inputs
Inputs *string `json:"inputs"`
// Previous statuses
Statuses []*StatusHistoryItem `json:"statuses"`
}
Node status
type ObjectMeta ¶
type ObjectMeta struct {
// Group
Group string `json:"group"`
// Version
Version string `json:"version"`
// Kind
Kind string `json:"kind"`
// Name
Name string `json:"name"`
// Description
Description *string `json:"description"`
// Namespace
Namespace string `json:"namespace"`
// Runtime
Runtime string `json:"runtime"`
// Account name
Account string `json:"account"`
// Labels
Labels []*StringPair `json:"labels"`
// Annotations
Annotations []*StringPair `json:"annotations"`
// Last updated
LastUpdated *string `json:"lastUpdated"`
// Created
Created *string `json:"created"`
}
Object metadata
type PageInfo ¶
type PageInfo struct {
// Cursor for the first result in the page
StartCursor *string `json:"startCursor"`
// Cursor for the last result in the page
EndCursor *string `json:"endCursor"`
// Indicate if there is next page
HasNextPage bool `json:"hasNextPage"`
// Indicate if there is previous page
HasPrevPage bool `json:"hasPrevPage"`
}
Information about current page
type Phases ¶ added in v0.30.3
type Phases string
Workflow phases
func (Phases) MarshalGQL ¶ added in v0.30.3
func (*Phases) UnmarshalGQL ¶ added in v0.30.3
type Pipeline ¶
type Pipeline struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Self entity reference for the real k8s entity in case of codefresh logical entity
Self *Sensor `json:"self"`
// Projects
Projects []string `json:"projects"`
// Dependencies
Dependencies []*SensorDependency `json:"dependencies"`
// Trigger name
Trigger string `json:"trigger"`
}
Pipeline entity
func (Pipeline) IsBaseEntity ¶
func (Pipeline) IsBaseEntity()
func (Pipeline) IsK8sLogicEntity ¶ added in v0.30.3
func (Pipeline) IsK8sLogicEntity()
func (Pipeline) IsProjectBasedEntity ¶
func (Pipeline) IsProjectBasedEntity()
type PipelineEdge ¶
type PipelineEdge struct {
// Node contains the actual pipeline data
Node *Pipeline `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Pipeline Edge
func (PipelineEdge) IsEdge ¶
func (PipelineEdge) IsEdge()
type PipelinePage ¶
type PipelinePage struct {
// Total amount of pipelines
TotalCount int `json:"totalCount"`
// Pipeline edges
Edges []*PipelineEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Pipeline Page
func (PipelinePage) IsPage ¶
func (PipelinePage) IsPage()
type PipelineSlice ¶
type PipelineSlice struct {
// Pipeline edges
Edges []*PipelineEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Pipeline Slice
func (PipelineSlice) IsSlice ¶
func (PipelineSlice) IsSlice()
type Project ¶
type Project struct {
// Project name
Name string `json:"name"`
// Project description
Description *string `json:"description"`
}
Project entity
type ProjectBasedEntity ¶
type ProjectBasedEntity interface {
IsProjectBasedEntity()
}
Project based entity
type ProjectEdge ¶
type ProjectEdge struct {
// Node contains the actual project data
Node *Project `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Project Edge
func (ProjectEdge) IsEdge ¶
func (ProjectEdge) IsEdge()
type ProjectPage ¶
type ProjectPage struct {
// Total amount of Projects
TotalCount int `json:"totalCount"`
// Project edges
Edges []*ProjectEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Project Page
func (ProjectPage) IsPage ¶
func (ProjectPage) IsPage()
type ProjectSlice ¶
type ProjectSlice struct {
// Project edges
Edges []*ProjectEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Project Slice
func (ProjectSlice) IsSlice ¶
func (ProjectSlice) IsSlice()
type Release ¶ added in v0.30.3
type Release struct {
// Release version
Version string `json:"version"`
}
Release Entity
type ResourceEvent ¶
type ResourceEvent struct {
// Name
Name string `json:"name"`
// Group
Group string `json:"group"`
// Version
Version string `json:"version"`
// Kind
Kind string `json:"kind"`
// Namespace
Namespace string `json:"namespace"`
}
Resource event
func (ResourceEvent) IsEvent ¶
func (ResourceEvent) IsEvent()
type Runtime ¶
type Runtime struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Self entity reference for the real k8s entity in case of codefresh logical entity
Self *AppProject `json:"self"`
// Projects
Projects []string `json:"projects"`
// Cluster
Cluster *string `json:"cluster"`
// Runtime version
RuntimeVersion *string `json:"runtimeVersion"`
}
Runtime entity
func (Runtime) IsBaseEntity ¶
func (Runtime) IsBaseEntity()
func (Runtime) IsK8sLogicEntity ¶ added in v0.30.3
func (Runtime) IsK8sLogicEntity()
func (Runtime) IsProjectBasedEntity ¶
func (Runtime) IsProjectBasedEntity()
type RuntimeCreationResponse ¶
type RuntimeCreationResponse struct {
// The runtime access token that will be used for requests from the runtime
NewAccessToken string `json:"newAccessToken"`
// The name of the newly created runtime
Name string `json:"name"`
}
Response for creating a runtime
type RuntimeEdge ¶
type RuntimeEdge struct {
// Node contains the actual runtime data
Node *Runtime `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Runtime Edge
func (RuntimeEdge) IsEdge ¶
func (RuntimeEdge) IsEdge()
type RuntimePage ¶
type RuntimePage struct {
// Total amount of runtimes
TotalCount int `json:"totalCount"`
// Runtime edges
Edges []*RuntimeEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Runtime Page
func (RuntimePage) IsPage ¶
func (RuntimePage) IsPage()
type RuntimePushPayload ¶ added in v0.30.3
type RuntimePushPayload struct {
// Name of event
Name *string `json:"name"`
}
RuntimePushPayload
func (RuntimePushPayload) IsPushPayload ¶ added in v0.30.3
func (RuntimePushPayload) IsPushPayload()
type RuntimeSlice ¶
type RuntimeSlice struct {
// Runtime edges
Edges []*RuntimeEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Runtime Slice
func (RuntimeSlice) IsSlice ¶
func (RuntimeSlice) IsSlice()
type Sensor ¶
type Sensor struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Version of the entity
Version *int `json:"version"`
// Is this the latest version of this entity
Latest *bool `json:"latest"`
// Entity source
Source *GitopsEntitySource `json:"source"`
// Sync status
SyncStatus SyncStatus `json:"syncStatus"`
// Health status
HealthStatus *HealthStatus `json:"healthStatus"`
// Health message
HealthMessage *string `json:"healthMessage"`
// Desired manifest
DesiredManifest *string `json:"desiredManifest"`
// Actual manifest
ActualManifest *string `json:"actualManifest"`
// Projects
Projects []string `json:"projects"`
// Dependencies
Dependencies []*SensorDependency `json:"dependencies"`
// Triggers
Triggers []SensorTrigger `json:"triggers"`
}
Sensor entity
func (Sensor) IsBaseEntity ¶
func (Sensor) IsBaseEntity()
func (Sensor) IsGitopsEntity ¶
func (Sensor) IsGitopsEntity()
func (Sensor) IsProjectBasedEntity ¶
func (Sensor) IsProjectBasedEntity()
type SensorDependency ¶
type SensorDependency struct {
// Name
Name string `json:"name"`
// EventSource name
EventSource string `json:"eventSource"`
// Event name
Event string `json:"event"`
}
Sensor dependency
type SensorEdge ¶
type SensorEdge struct {
// Node contains the actual sensor data
Node *Sensor `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Sensor Edge
func (SensorEdge) IsEdge ¶
func (SensorEdge) IsEdge()
type SensorPage ¶
type SensorPage struct {
// Total amount of sensors
TotalCount int `json:"totalCount"`
// Sensor edges
Edges []*SensorEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Sensor Page
func (SensorPage) IsPage ¶
func (SensorPage) IsPage()
type SensorSlice ¶
type SensorSlice struct {
// Sensor edges
Edges []*SensorEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Sensor Slice
func (SensorSlice) IsSlice ¶
func (SensorSlice) IsSlice()
type SliceInfo ¶
type SliceInfo struct {
// Cursor for the first result in the slice
StartCursor *string `json:"startCursor"`
// Cursor for the last result in the slice
EndCursor *string `json:"endCursor"`
// Indicate if there is next slice
HasNextPage bool `json:"hasNextPage"`
// Indicate if there is previous slice
HasPrevPage bool `json:"hasPrevPage"`
}
Information about current slice
type SlicePaginationArgs ¶
type SlicePaginationArgs struct {
// Returns workflow templates after the provided cursor
After *string `json:"after"`
// Returns workflow templates before the provided cursor
Before *string `json:"before"`
// Returns the first X workflow templates
First *int `json:"first"`
// Returns the last X workflow templates
Last *int `json:"last"`
}
Pagination arguments to request slice
type StatusHistoryItem ¶ added in v0.30.3
type StatusHistoryItem struct {
// The time the status started
Since string `json:"since"`
// Phase
Phase Phases `json:"phase"`
// Message
Message *string `json:"message"`
}
Workflow status history item
type StringPair ¶
Lable
type SwitchAccountResponse ¶
type SwitchAccountResponse struct {
// The token to use for the next requests
NewAccessToken *string `json:"newAccessToken"`
}
"response for request to switch account
type SyncStatus ¶
type SyncStatus string
Sync status
const ( // Out of sync SyncStatusOutOfSync SyncStatus = "OUT_OF_SYNC" // Synced SyncStatusSynced SyncStatus = "SYNCED" // Unknown SyncStatusUnknown SyncStatus = "UNKNOWN" )
func (SyncStatus) IsValid ¶
func (e SyncStatus) IsValid() bool
func (SyncStatus) MarshalGQL ¶
func (e SyncStatus) MarshalGQL(w io.Writer)
func (SyncStatus) String ¶
func (e SyncStatus) String() string
func (*SyncStatus) UnmarshalGQL ¶
func (e *SyncStatus) UnmarshalGQL(v interface{}) error
type UserDetails ¶
type UserDetails struct {
// The user name
Name string `json:"name"`
// User image url
Image *string `json:"image"`
}
"User Details
type UserInfo ¶
type UserInfo struct {
// The user name
Name *string `json:"name"`
// Register date
RegisterDate *string `json:"registerDate"`
// Last time user logged in to the system
LastLoginDate *string `json:"lastLoginDate"`
}
"User statistics
type UserRole ¶
type UserRole string
"User role provide specific permission for the current user
func (UserRole) MarshalGQL ¶
func (*UserRole) UnmarshalGQL ¶
type UserStatus ¶
type UserStatus string
"User status active or disable
const ( // New user UserStatusNew UserStatus = "NEW" // Pending user UserStatusPending UserStatus = "PENDING" // Suspended UserStatusSuspended UserStatus = "SUSPENDED" // Unverifed user UserStatusUnverifed UserStatus = "UNVERIFED" )
func (UserStatus) IsValid ¶
func (e UserStatus) IsValid() bool
func (UserStatus) MarshalGQL ¶
func (e UserStatus) MarshalGQL(w io.Writer)
func (UserStatus) String ¶
func (e UserStatus) String() string
func (*UserStatus) UnmarshalGQL ¶
func (e *UserStatus) UnmarshalGQL(v interface{}) error
type Workflow ¶
type Workflow struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Projects
Projects []string `json:"projects"`
// Workflow spec
Spec *WorkflowSpec `json:"spec"`
// Workflow status
Status *WorkflowStatus `json:"status"`
// Events payload Data
EventsPayloadData []EventPayloadData `json:"eventsPayloadData"`
// Events payload references
EventsPayload []*EventPayload `json:"eventsPayload"`
// Pipeline refernece
Pipeline *Pipeline `json:"pipeline"`
// Actual manifest
ActualManifest *string `json:"actualManifest"`
}
Workflow entity
func (Workflow) IsBaseEntity ¶
func (Workflow) IsBaseEntity()
func (Workflow) IsK8sStandardEntity ¶ added in v0.30.3
func (Workflow) IsK8sStandardEntity()
func (Workflow) IsProjectBasedEntity ¶
func (Workflow) IsProjectBasedEntity()
type WorkflowContainerTemplate ¶ added in v0.30.3
type WorkflowContainerTemplate struct {
// Name
Name string `json:"name"`
}
Workflow container template
func (WorkflowContainerTemplate) IsWorkflowSpecTemplate ¶ added in v0.30.3
func (WorkflowContainerTemplate) IsWorkflowSpecTemplate()
type WorkflowDAGTask ¶
type WorkflowDAGTask struct {
// Name
Name string `json:"name"`
// Template to execute
Template WorkflowSpecTemplate `json:"template"`
}
Workflow DAG task
type WorkflowDAGTemplate ¶
type WorkflowDAGTemplate struct {
// Name
Name string `json:"name"`
// Tasks
Tasks []*WorkflowDAGTask `json:"tasks"`
}
Workflow DAG template
func (WorkflowDAGTemplate) IsWorkflowSpecTemplate ¶
func (WorkflowDAGTemplate) IsWorkflowSpecTemplate()
type WorkflowEdge ¶
type WorkflowEdge struct {
// Node contains the actual workflow data
Node *Workflow `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Workflow Edge
func (WorkflowEdge) IsEdge ¶
func (WorkflowEdge) IsEdge()
type WorkflowPage ¶
type WorkflowPage struct {
// Total amount of workflows
TotalCount int `json:"totalCount"`
// Workflow edges
Edges []*WorkflowEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
Workflow Page
func (WorkflowPage) IsPage ¶
func (WorkflowPage) IsPage()
type WorkflowResourceTemplate ¶ added in v0.30.3
type WorkflowResourceTemplate struct {
// Name
Name string `json:"name"`
}
Workflow Resource template
func (WorkflowResourceTemplate) IsWorkflowSpecTemplate ¶ added in v0.30.3
func (WorkflowResourceTemplate) IsWorkflowSpecTemplate()
type WorkflowScriptTemplate ¶ added in v0.30.3
type WorkflowScriptTemplate struct {
// Name
Name string `json:"name"`
}
Workflow script template
func (WorkflowScriptTemplate) IsWorkflowSpecTemplate ¶ added in v0.30.3
func (WorkflowScriptTemplate) IsWorkflowSpecTemplate()
type WorkflowSlice ¶
type WorkflowSlice struct {
// Workflow edges
Edges []*WorkflowEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
Workflow Slice
func (WorkflowSlice) IsSlice ¶
func (WorkflowSlice) IsSlice()
type WorkflowSpec ¶
type WorkflowSpec struct {
// Entrypoint
Entrypoint string `json:"entrypoint"`
// Templates
Templates []WorkflowSpecTemplate `json:"templates"`
// Workflow template reference
WorkflowTemplateRef *WorkflowTemplateRef `json:"workflowTemplateRef"`
}
Workflow spec
type WorkflowSpecTemplate ¶
type WorkflowSpecTemplate interface {
IsWorkflowSpecTemplate()
}
Workflow spec template
type WorkflowStatus ¶
type WorkflowStatus struct {
// Creation time
CreatedAt string `json:"createdAt"`
// Start time
StartedAt *string `json:"startedAt"`
// Finish time
FinishedAt *string `json:"finishedAt"`
// Current workflow phase
Phase Phases `json:"phase"`
// Progress
Progress *Progress `json:"progress"`
// Current workflow nodes status
Nodes []*NodeStatus `json:"nodes"`
// Message
Message *string `json:"message"`
// Previous statuses
Statuses []*StatusHistoryItem `json:"statuses"`
}
Workflow status
type WorkflowStep ¶
type WorkflowStep struct {
// Name
Name string `json:"name"`
// Template to execute
Template WorkflowSpecTemplate `json:"template"`
}
Workflow step
type WorkflowStepsTemplate ¶
type WorkflowStepsTemplate struct {
// Name
Name string `json:"name"`
// Steps
Steps [][]*WorkflowStep `json:"steps"`
}
Workflow steps template
func (WorkflowStepsTemplate) IsWorkflowSpecTemplate ¶
func (WorkflowStepsTemplate) IsWorkflowSpecTemplate()
type WorkflowSuspendedTemplate ¶ added in v0.30.3
type WorkflowSuspendedTemplate struct {
// Name
Name string `json:"name"`
}
Workflow Resource template
func (WorkflowSuspendedTemplate) IsWorkflowSpecTemplate ¶ added in v0.30.3
func (WorkflowSuspendedTemplate) IsWorkflowSpecTemplate()
type WorkflowTemplate ¶
type WorkflowTemplate struct {
// Object metadata
Metadata *ObjectMeta `json:"metadata"`
// Errors
Errors []*Error `json:"errors"`
// Entities referencing this entity
ReferencedBy []BaseEntity `json:"referencedBy"`
// Entities referenced by this enitity
References []BaseEntity `json:"references"`
// Version of the entity
Version *int `json:"version"`
// Is this the latest version of this entity
Latest *bool `json:"latest"`
// Entity source
Source *GitopsEntitySource `json:"source"`
// Sync status
SyncStatus SyncStatus `json:"syncStatus"`
// Health status
HealthStatus *HealthStatus `json:"healthStatus"`
// Health message
HealthMessage *string `json:"healthMessage"`
// Desired manifest
DesiredManifest *string `json:"desiredManifest"`
// Actual manifest
ActualManifest *string `json:"actualManifest"`
// Projects
Projects []string `json:"projects"`
// Workflow spec
Workflow *WorkflowSpec `json:"workflow"`
}
Workflow template entity
func (WorkflowTemplate) IsBaseEntity ¶
func (WorkflowTemplate) IsBaseEntity()
func (WorkflowTemplate) IsEntity ¶
func (WorkflowTemplate) IsEntity()
func (WorkflowTemplate) IsGitopsEntity ¶
func (WorkflowTemplate) IsGitopsEntity()
func (WorkflowTemplate) IsProjectBasedEntity ¶
func (WorkflowTemplate) IsProjectBasedEntity()
type WorkflowTemplateEdge ¶
type WorkflowTemplateEdge struct {
// Node contains the actual workflow template data
Node *WorkflowTemplate `json:"node"`
// Cursor
Cursor string `json:"cursor"`
}
Workflow template Edge
func (WorkflowTemplateEdge) IsEdge ¶
func (WorkflowTemplateEdge) IsEdge()
type WorkflowTemplatePage ¶
type WorkflowTemplatePage struct {
// Total amount of workflow templates
TotalCount int `json:"totalCount"`
// Workflow template edges
Edges []*WorkflowTemplateEdge `json:"edges"`
// Page information
PageInfo *PageInfo `json:"pageInfo"`
}
WorkflowTemplate Page
func (WorkflowTemplatePage) IsPage ¶
func (WorkflowTemplatePage) IsPage()
type WorkflowTemplateRef ¶ added in v0.30.3
type WorkflowTemplateRef struct {
// Name
Name *string `json:"name"`
}
Workflow template ref
type WorkflowTemplateSlice ¶
type WorkflowTemplateSlice struct {
// Workflow template edges
Edges []*WorkflowTemplateEdge `json:"edges"`
// Slice information
PageInfo *SliceInfo `json:"pageInfo"`
}
WorkflowTemplate Slice
func (WorkflowTemplateSlice) IsSlice ¶
func (WorkflowTemplateSlice) IsSlice()
type WorkflowTrigger ¶
type WorkflowTrigger struct {
// Name
Name string `json:"name"`
// Conditions
Conditions string `json:"conditions"`
// Workflow manifest
Workflow string `json:"workflow"`
// Operation
Op WorkflowTriggerOperation `json:"op"`
}
Http Trigger
func (WorkflowTrigger) IsSensorTrigger ¶
func (WorkflowTrigger) IsSensorTrigger()
type WorkflowTriggerOperation ¶
type WorkflowTriggerOperation string
Workflow Trigger Operation
const ( // Resubmit WorkflowTriggerOperationResubmit WorkflowTriggerOperation = "RESUBMIT" // Resume WorkflowTriggerOperationResume WorkflowTriggerOperation = "RESUME" // Retry WorkflowTriggerOperationRetry WorkflowTriggerOperation = "RETRY" // Submit WorkflowTriggerOperationSubmit WorkflowTriggerOperation = "SUBMIT" // Suspend WorkflowTriggerOperationSuspend WorkflowTriggerOperation = "SUSPEND" // Terminate WorkflowTriggerOperationTerminate WorkflowTriggerOperation = "TERMINATE" )
func (WorkflowTriggerOperation) IsValid ¶
func (e WorkflowTriggerOperation) IsValid() bool
func (WorkflowTriggerOperation) MarshalGQL ¶
func (e WorkflowTriggerOperation) MarshalGQL(w io.Writer)
func (WorkflowTriggerOperation) String ¶
func (e WorkflowTriggerOperation) String() string
func (*WorkflowTriggerOperation) UnmarshalGQL ¶
func (e *WorkflowTriggerOperation) UnmarshalGQL(v interface{}) error
type WorkflowsFilterArgs ¶ added in v0.30.3
type WorkflowsFilterArgs struct {
// Filter workflows from a specific project
Project *string `json:"project"`
// Filter workflows from a specific runtime
Runtime *string `json:"runtime"`
// Filter workflows from a specific pipeline
Pipeline *string `json:"pipeline"`
// Filter workflows from a specific repositories
Repositories []*string `json:"repositories"`
// Filter workflows from a specific branches
Branches []*string `json:"branches"`
// Filter workflows from a specific event types
EventTypes []*string `json:"eventTypes"`
// Filter workflows from a specific initiators
Initiators []*string `json:"initiators"`
// Filter workflows from a specific statuses
Statuses []*Phases `json:"statuses"`
// Filter workflows from a specific start date
StartDate *string `json:"startDate"`
}
Workflow filter arguments