models

Documentation

Index

• type ApprovalConfig
• type ApprovalNotification
• type ApprovalStatus
• type Approver
• type Cache
• type CreatePipelineRequest
• type CreatePipelineResponse
• type DeletePipelineRecordRequest
• type DeletePipelineRecordResponse
• type DeletePipelineRequest
• type DeletePipelineResponse
• type Dir
• type EmailNotification
• type Env
• type GetPipelineRecordRequest
• type GetPipelineRecordResponse
• type GetPipelineRequest
• type GetPipelineResponse
• type KVPair
• type LastStageStatus
• type ListPipelineRecordsRequest
• type ListPipelineRecordsResponse
• type ListPipelinesRequest
• type ListPipelinesResponse
• type Notification
• type Page
• type Pipeline
• type PipelineFilter
• type PipelineRecord
• type PipelineRecordFilter
• type PipelineRecordStage
• type PipelineRecordStep
• type PipelineRecordTask
• type RetryPipelineRecordRequest
• type RetryPipelineRecordResponse
• type RollbackTrigger
• type RollingUpdateConfig
• type RollingUpdateStatus
• type RunPipelineRequest
• type RunPipelineResponse
• type SCM
• type Scheduled
• type SmsNotification
• type Stage
• type Step
• type StopPipelineRecordRequest
• type StopPipelineRecordResponse
• type Task
• type TaskWebhook
• type Trigger
• type UpdatePipelinePropertiesRequest
• type UpdatePipelinePropertiesResponse
• type UpdatePipelineRequest
• type UpdatePipelineResponse
• type User
• type Var
• type Webhook
• type WebhookNotification

Types

type ApprovalConfig

type ApprovalConfig struct {
	Type         string                `json:"Type"`
	Approvers    []*User               `json:"Approvers,omitempty"`
	Notification *ApprovalNotification `json:"Notification,omitempty"`
}

type ApprovalNotification

type ApprovalNotification struct {
	Enable        bool     `json:"Enable"`
	Rules         []string `json:"Rules"`
	NotifyMethods []string `json:"NotifyMethods"`
}

type ApprovalStatus

type ApprovalStatus struct {
	Type      string      `json:"Type"`
	Approvers []*Approver `json:"Approvers,omitempty"`
	Status    string      `json:"Status"`
}

type Approver

type Approver struct {
	AccountId   int64  `json:"AccountId,omitempty"`
	UserId      int64  `json:"UserId,omitempty"`
	Name        string `json:"Name"`
	Description string `json:"Description,omitempty"`
	Status      string `json:"Status"`
}

type Cache

type Cache struct {
	Dirs []Dir `json:"Dirs,omitempty"`
}

type CreatePipelineRequest

type CreatePipelineRequest struct {
	WorkspaceId string   `json:"WorkspaceId"`
	Item        Pipeline `json:"Item"`
	ClientToken string   `json:"ClientToken,omitempty"`
}

type CreatePipelineResponse

type CreatePipelineResponse struct {
	Id string `json:"Id"`
}

type DeletePipelineRecordRequest

type DeletePipelineRecordRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	PipelineId  string `json:"PipelineId"`
	Id          string `json:"Id"`
}

type DeletePipelineRecordResponse

type DeletePipelineRecordResponse struct {
}

type DeletePipelineRequest

type DeletePipelineRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	Id          string `json:"Id"`
}

type DeletePipelineResponse

type DeletePipelineResponse struct {
}

type Dir

type Dir struct {
	Path        string `json:"Path"`
	Description string `json:"Description"`
}

type EmailNotification

type EmailNotification struct {
	Enable     bool     `json:" Enable"`
	Targets    []string `json:" Targets"`
	OtherUsers []User   `json:" OtherUsers"`
}

type Env

type Env struct {
	Vars []*Var `json:"Vars,omitempty"`
}

type GetPipelineRecordRequest

type GetPipelineRecordRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	PipelineId  string `json:"PipelineId"`
	Id          string `json:"Id"`
}

type GetPipelineRecordResponse

type GetPipelineRecordResponse struct {
	PipelineRecord
}

type GetPipelineRequest

type GetPipelineRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	Id          string `json:"Id"`
}

type GetPipelineResponse

type GetPipelineResponse struct {
	Pipeline
}

type KVPair

type KVPair struct {
	Key   string `json:"Key"`
	Value string `json:"Value"`
}

type LastStageStatus

type LastStageStatus struct {
	Name      string    `json:" Name"`
	Status    string    `json:" Status"`
	TaskNames []string  `json:" TaskNames,omitempty"`
	Infos     []*KVPair `json:" Infos,omitempty"`
}

type ListPipelineRecordsRequest

type ListPipelineRecordsRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	PipelineId  string `json:"PipelineId"`
	Page
	Desc   bool                  `json:"Desc,omitempty"`
	Filter *PipelineRecordFilter `json:"Filter,omitempty"`
}

type ListPipelineRecordsResponse

type ListPipelineRecordsResponse struct {
	Total int64            `json:"Total"`
	Items []PipelineRecord `json:"Items"`
}

type ListPipelinesRequest

type ListPipelinesRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	Page
	Filter  *PipelineFilter `json:"Filter,omitempty"`
	Desc    bool            `json:"Desc,omitempty"`
	OrderBy string          `json:"OrderBy,omitempty"`
}

type ListPipelinesResponse

type ListPipelinesResponse struct {
	Total int64      `json:"Total"`
	Items []Pipeline `json:"Items"`
}

type Notification

type Notification struct {
	Events              []string               `json:"Events"`
	EnableStationLetter string                 `json:"EnableStationLetter,omitempty"`
	Sms                 []*SmsNotification     `json:"Sms,omitempty"`
	Email               []*EmailNotification   `json:"Email,omitempty"`
	Webhook             []*WebhookNotification `json:"Webhook,omitempty"`
	CustomContent       string                 `json:"CustomContent,omitempty"`
}

type Page

type Page struct {
	PageNumber int64 `json:"PageNumber,omitempty"`
	PageSize   int64 `json:"PageSize,omitempty"`
}

type Pipeline

type Pipeline struct {
	Id               string             `json:"Id,omitempty"`
	Name             string             `json:"Name"`
	ClusterPool      string             `json:"ClusterPool"`
	Scm              SCM                `json:"Scm"`
	Trigger          *Trigger           `json:"Trigger,omitempty"`
	Env              *Env               `json:"Env,omitempty"`
	Stages           []Stage            `json:"Stages"`
	CreateTime       string             `json:"CreateTime,omitempty"`
	UpdateTime       string             `json:"UpdateTime,omitempty"`
	LastStatus       string             `json:"LastStatus,omitempty"`
	LastStagesStatus []*LastStageStatus `json:"LastStagesStatus,omitempty"`
	Triggerer        string             `json:"Triggerer,omitempty"`
	LastTriggerTime  string             `json:"LastTriggerTime,omitempty"`
	Language         string             `json:"Language"`
	TemplateId       string             `json:"TemplateId,omitempty"`
	CustomTemplate   bool               `json:"CustomTemplate,omitempty"`
	Cache            *Cache             `json:"Cache,omitempty"`
	Notification     *Notification      `json:"Notification,omitempty"`
	CleaningCache    bool               `json:"CleaningCache,omitempty"`
	ClusterId        string             `json:"ClusterId,omitempty"`
}

type PipelineFilter

type PipelineFilter struct {
	Name string `json:"Name,omitempty"`
}

type PipelineRecord

type PipelineRecord struct {
	Id          string                `json:"Id"`
	Status      string                `json:"Status"`
	Creator     string                `json:"Creator"`
	StartTime   string                `json:"StartTime"`
	EndTime     string                `json:"EndTime,omitempty"`
	TriggerMode string                `json:"TriggerMode"`
	DynamicEnvs []*KVPair             `json:"DynamicEnvs,omitempty"`
	Description string                `json:"Description,omitempty"`
	WebhookUrl  string                `json:"WebhookUrl,omitempty"`
	Stages      []PipelineRecordStage `json:"Stages"`
	LogStatus   bool                  `json:"LogStatus"`
	ClusterPool string                `json:"ClusterPool"`
	ClusterId   string                `json:"ClusterId"`
}

type PipelineRecordFilter

type PipelineRecordFilter struct {
	Statuses string `json:"Name,omitempty"`
}

type PipelineRecordStage

type PipelineRecordStage struct {
	Name   string               `json:"Name"`
	Id     string               `json:"Id"`
	Status string               `json:"Status"`
	Infos  []KVPair             `json:"Infos,omitempty"`
	Tasks  []PipelineRecordTask `json:"Tasks"`
}

type PipelineRecordStep

type PipelineRecordStep struct {
	Name                string               `json:"Name"`
	Id                  string               `json:"Id"`
	Status              string               `json:"Status"`
	StartTime           string               `json:"StartTime,omitempty"`
	EndTime             string               `json:"EndTime,omitempty"`
	Type                string               `json:"Type"`
	ApprovalStatus      *ApprovalStatus      `json:"ApprovalStatus,omitempty"`
	RollingUpdateStatus *RollingUpdateStatus `json:"RollingUpdateStatus,omitempty"`
	RollbackTrigger     *RollbackTrigger     `json:"RollbackTrigger,omitempty"`
	UpdateImageStatus   string               `json:"UpdateImageStatus,omitempty"`
	Result              []KVPair             `json:"Result"`
	Params              []KVPair             `json:"Params"`
	CustomParams        []*KVPair            `json:"CustomParams,omitempty"`
	TotalRetryNumber    int8                 `json:"TotalRetryNumber"`
}

type PipelineRecordTask

type PipelineRecordTask struct {
	Name             string               `json:"Name"`
	Id               string               `json:"Id"`
	Status           string               `json:"Status"`
	StartTime        string               `json:"StartTime,omitempty"`
	EndTime          string               `json:"EndTime,omitempty"`
	Type             string               `json:"Type"`
	Steps            []PipelineRecordStep `json:"Steps"`
	TotalRetryNumber int8                 `json:"TotalRetryNumber"`
}

type RetryPipelineRecordRequest

type RetryPipelineRecordRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	PipelineId  string `json:"PipelineId"`
	Id          string `json:"Id"`
}

type RetryPipelineRecordResponse

type RetryPipelineRecordResponse struct {
}

type RollbackTrigger

type RollbackTrigger struct {
	AccountId int64  `json:"AccountId,omitempty"`
	UserId    int64  `json:"UserId,omitempty"`
	Name      string `json:"Name"`
}

type RollingUpdateConfig

type RollingUpdateConfig struct {
	Cluster       string `json:"Cluster"`
	Namespace     string `json:"Namespace"`
	Kind          string `json:"Kind"`
	Name          string `json:"Name"`
	ContainerName string `json:"ContainerName"`
	UpdateImage   string `json:"UpdateImage"`
	Batch         int8   `json:"Batch"`
	BatchPercent  []int8 `json:"BatchPercent"`
	Timeout       string `json:"Timeout"`
}

type RollingUpdateStatus

type RollingUpdateStatus struct {
	RollingUpdateConfig RollingUpdateConfig `json:"RollingUpdateConfig"`
	BatchStatus         []string            `json:"BatchStatus"`
	Status              string              `json:"Status"`
}

type RunPipelineRequest

type RunPipelineRequest struct {
	WorkspaceId string    `json:"WorkspaceId"`
	Id          string    `json:"Id"`
	Branch      string    `json:"Branch,omitempty"`
	DynamicEnvs []*KVPair `json:"DynamicEnvs,omitempty"`
	Description string    `json:"Description,omitempty"`
}

type RunPipelineResponse

type RunPipelineResponse struct {
	RecordId string `json:"RecordId"`
}

type SCM

type SCM struct {
	Id            string   `json:"Id,omitempty"`
	Type          string   `json:"Type,omitempty"`
	Server        string   `json:"Server,omitempty"`
	DefaultBranch string   `json:"DefaultBranch,omitempty"`
	Disabled      bool     `json:"Disabled,omitempty"`
	Webhook       *Webhook `json:"Webhook,omitempty"`
}

type Scheduled

type Scheduled struct {
	Type string `json:"Type"`
	At   string `json:"At"`
}

type SmsNotification

type SmsNotification struct {
	Enable     bool     `json:" Enable"`
	Targets    []string `json:" Targets"`
	OtherUsers []User   `json:" OtherUsers"`
}

type Stage

type Stage struct {
	Id    string  `json:"Id,omitempty"`
	Name  string  `json:"Name"`
	Tasks []*Task `json:"Tasks"`
}

type Step

type Step struct {
	Id             string          `json:"Id,omitempty"`
	Name           string          `json:"Name"`
	Language       string          `json:"Language,omitempty"`
	Type           string          `json:"Type"`
	ApprovalConfig *ApprovalConfig `json:"ApprovalConfig,omitempty"`
	Params         []KVPair        `json:"Params"`
	CustomParams   []*KVPair       `json:"CustomParams,omitempty"`
}

type StopPipelineRecordRequest

type StopPipelineRecordRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	PipelineId  string `json:"PipelineId"`
	Id          string `json:"Id"`
}

type StopPipelineRecordResponse

type StopPipelineRecordResponse struct {
}

type Task

type Task struct {
	Id      string       `json:"Id,omitempty"`
	Name    string       `json:"Name"`
	Type    string       `json:"Type"`
	Steps   []Step       `json:"Steps"`
	Webhook *TaskWebhook `json:"Webhook,omitempty"`
}

type TaskWebhook

type TaskWebhook struct {
	Events []string `json:"Events"`
	WebhookNotification
}

type Trigger

type Trigger struct {
	Scheduled *Scheduled `json:"Scheduled,omitempty"`
}

type UpdatePipelinePropertiesRequest

type UpdatePipelinePropertiesRequest struct {
	WorkspaceId string `json:"WorkspaceId"`
	Id          string `json:"Id"`
	Name        string `json:"Name"`
}

type UpdatePipelinePropertiesResponse

type UpdatePipelinePropertiesResponse struct {
}

type UpdatePipelineRequest

type UpdatePipelineRequest struct {
	WorkspaceId string   `json:"WorkspaceId"`
	Id          string   `json:"Id"`
	Item        Pipeline `json:"Item"`
}

type UpdatePipelineResponse

type UpdatePipelineResponse struct {
}

type User

type User struct {
	AccountId int64  `json:"AccountId,omitempty"`
	UserId    int64  `json:"UserId,omitempty"`
	Name      string `json:"Name"`
}

type Var

type Var struct {
	Key     string `json:"Key"`
	Dynamic bool   `json:"Dynamic"`
	Secret  bool   `json:"Secret"`
	Value   string `json:"Value"`
}

type Webhook

type Webhook struct {
	Events  []string  `json:"Events,omitempty"`
	Filters []*KVPair `json:"Filters,omitempty"`
	Url     string    `json:"Url,omitempty"`
}

type WebhookNotification

type WebhookNotification struct {
	Enable bool   `json:" Enable"`
	Url    string `json:" Url"`
	Token  string `json:" Token,omitempty"`
	Type   string `json:" Type"`
}