Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Application ¶
type Application struct {
// Registration registration details
Registration ApplicationRegistration `json:"registration"`
}
Application details of an application
type ApplicationBuilder ¶
type ApplicationBuilder interface {
WithName(string) ApplicationBuilder
Build() *Application
}
ApplicationBuilder Handles construction of application detail
func NewApplicationBuilder ¶
func NewApplicationBuilder() ApplicationBuilder
NewApplicationBuilder Constructor
type ApplicationRegistration ¶
type ApplicationRegistration struct {
// Name the unique name of the Radix application
Name string `json:"name"`
SharedSecret *string `json:"sharedSecret"`
}
ApplicationRegistration ApplicationRegistration describe an application
type ApplicationSummary ¶
type ApplicationSummary struct {
// Name the name of the application
Name string `json:"name"`
}
ApplicationSummary describe an application
type JobSummary ¶
type JobSummary struct {
// Name of the job
Name string `json:"name"`
// AppName of the application
AppName string `json:"appName"`
// Branch to build from
Branch string `json:"branch"`
// GitRef Branch or tag to build from
//
// example: master
GitRef string `json:"gitRef,omitempty"`
// GitRefType When the pipeline job should be built from branch or tag specified in GitRef:
// - branch
// - tag
// - <empty> - either branch or tag
//
// example: "branch"
GitRefType string `json:"gitRefType,omitempty"`
// CommitID the commit ID of the branch to build
CommitID string `json:"commitID"`
// TriggeredBy of the job
TriggeredBy string `json:"triggeredBy"`
}
JobSummary holds general information about job
func (JobSummary) GetGitRefOrDefault ¶
func (jobSummary JobSummary) GetGitRefOrDefault() string
GetGitRefOrDefault returns the GitRef if set, otherwise returns the Branch
func (JobSummary) GetGitRefTypeOrDefault ¶
func (jobSummary JobSummary) GetGitRefTypeOrDefault() string
GetGitRefTypeOrDefault returns the GitRefType if set, otherwise returns the Branch
type PipelineParameters ¶
type PipelineParameters struct {
// Branch the branch to build
//
// required: true
// example: master
Branch string `json:"branch"`
// CommitID the commit ID of the branch to build
//
// required: true
// example: 4faca8595c5283a9d0f17a623b9255a0d9866a2e
CommitID string `json:"commitID"`
// TriggeredBy creator of job
//
// required: true
// example: 4faca8595c5283a9d0f17a623b9255a0d9866a2e
TriggeredBy string `json:"triggeredBy"`
// GitRef Branch or tag to build from
//
// required: false
// example: master
GitRef string `json:"gitRef,omitempty"`
// GitRefType When the pipeline job should be built from branch or tag specified in GitRef:
// - branch
// - tag
// - <empty> - either branch or tag
//
// required false
// enum: branch,tag,""
// example: "branch"
GitRefType string `json:"gitRefType,omitempty"`
}
PipelineParameters describe branch to build and its commit ID
Click to show internal directories.
Click to hide internal directories.