Documentation
¶
Index ¶
- type ApplicationUpdate
- type ApplicationUpdateExactVersion
- type ApplicationUpdateInput
- type ApplicationUpdateProgress
- type CaughtEmail
- type CaughtEmailList
- type CommandCronjobExecution
- type Cronjob
- type CronjobJob
- type Empty
- type Envelope
- type Header
- type InitStep
- type InitializationProgress
- type Mail
- type SoftwareRef
- type SoftwareVersionRef
- type Space
- type SpaceDeclaration
- type SpaceName
- type SpacePaymentLink
- type SpacePaymentLinkInput
- type SpacesClient
- type Stage
- type StageDeclaration
- type StageRef
- type TeamRef
- type VersionRef
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplicationUpdate ¶ added in v1.2.0
type ApplicationUpdate struct {
ID string `json:"id"`
StartedAt time.Time `json:"startedAt"`
CompletedAt time.Time `json:"completedAt"`
Status string `json:"status"`
VersionConstraint string `json:"versionConstraint"`
ExactVersion ApplicationUpdateExactVersion `json:"exactVersion"`
Progress ApplicationUpdateProgress `json:"progress"`
SourceStage StageRef `json:"sourceStage"`
TargetStage StageRef `json:"targetStage"`
}
type ApplicationUpdateExactVersion ¶ added in v1.2.0
type ApplicationUpdateExactVersion struct {
Number string `json:"number"`
}
type ApplicationUpdateInput ¶ added in v1.2.0
type ApplicationUpdateProgress ¶ added in v1.2.0
type CaughtEmail ¶ added in v1.5.0
type CaughtEmail struct {
ID string `json:"id"`
Envelope Envelope `json:"envelope"`
Date time.Time `json:"date"`
Mail Mail `json:"mail"`
}
func (*CaughtEmail) Header ¶ added in v1.5.0
func (c *CaughtEmail) Header(name string) string
func (*CaughtEmail) Headers ¶ added in v1.5.0
func (c *CaughtEmail) Headers(name string) []string
type CaughtEmailList ¶ added in v1.5.0
type CaughtEmailList []CaughtEmail
func (CaughtEmailList) ByID ¶ added in v1.5.0
func (l CaughtEmailList) ByID(id string) *CaughtEmail
type CommandCronjobExecution ¶ added in v1.1.0
type Cronjob ¶ added in v1.1.0
type Cronjob struct {
ID string `json:"id,omitempty"`
Schedule string `json:"schedule"`
AllowParallel bool `json:"allowParallel"`
Job CronjobJob `json:"job"`
Timezone string `json:"timezone"`
}
type CronjobJob ¶ added in v1.1.0
type CronjobJob struct {
Type string `json:"type"`
Command string `json:"command,omitempty"`
Arguments []string `json:"arguments,omitempty"`
WorkingDirectory string `json:"workingDirectory,omitempty"`
NextExecution *CommandCronjobExecution `json:"nextExecution,omitempty"`
LastExecution *CommandCronjobExecution `json:"lastExecution,omitempty"`
}
type InitializationProgress ¶ added in v1.5.0
type SoftwareRef ¶
type SoftwareVersionRef ¶ added in v1.3.0
type SoftwareVersionRef struct {
Software SoftwareRef `json:"software"`
VersionConstraint string `json:"versionConstraint"`
UserData interface{} `json:"userData,omitempty"`
}
type Space ¶
type Space struct {
ID string `json:"id"`
Links lowlevel.LinkList `json:"_links"`
Name SpaceName `json:"name"`
CreatedAt time.Time `json:"createdAt"`
Status string `json:"status"`
DNSNames []string `json:"dnsNames"`
Stages []Stage `json:"stages"`
Team TeamRef `json:"team"`
Running bool `json:"running"`
}
func (Space) StagesCount ¶
func (Space) StagesNames ¶
type SpaceDeclaration ¶
type SpaceDeclaration struct {
Name SpaceName `json:"name"`
Stages []StageDeclaration `json:"stages"`
}
type SpacePaymentLink ¶ added in v1.4.0
type SpacePaymentLink struct {
Plan payment.Plan `json:"plan"`
PaymentProfile payment.PaymentProfile `json:"paymentProfile"`
}
type SpacePaymentLinkInput ¶ added in v1.4.0
type SpacePaymentLinkInput struct {
Plan payment.PlanReferenceInput `json:"plan"`
PaymentProfile payment.PaymentProfileReferenceInput `json:"paymentProfile"`
}
type SpacesClient ¶
type SpacesClient interface {
List() ([]Space, error)
ListByTeam(teamID string) ([]Space, error)
Declare(teamID string, declaration *SpaceDeclaration) (*Space, error)
GetByID(spaceID string) (*Space, error)
GetByTeamAndName(teamIDOrName string, spaceIDOrName string) (*Space, error)
Delete(spaceID string) error
UpdateApplication(spaceID, stage, targetStage, version string) (*ApplicationUpdate, error)
ListApplicationUpdatesByStage(spaceID, stage string) ([]ApplicationUpdate, error)
ListApplicationUpdatesBySpace(spaceID string) ([]ApplicationUpdate, error)
GetPaymentLink(spaceID string) (*SpacePaymentLink, error)
ConnectWithPaymentProfile(spaceID string, paymentProfileID string, planID string) (*SpacePaymentLink, error)
ListCaughtEmails(spaceID string) (CaughtEmailList, error)
}
func NewSpacesClient ¶
func NewSpacesClient(client *lowlevel.SpacesLowlevelClient, logger *log.Logger) SpacesClient
type Stage ¶
type Stage struct {
Links lowlevel.LinkList `json:"_links"`
Actions lowlevel.LinkList `json:"_actions"`
Name string `json:"name"`
Application SoftwareRef `json:"application"`
Cronjobs []Cronjob `json:"cronjobs"`
Version VersionRef `json:"version"`
VersionConstraint string `json:"versionConstraint"`
UserData interface{} `json:"userData"`
DNSNames []string `json:"dnsNames"`
Status string `json:"status"`
Running bool `json:"running"`
Initialization InitializationProgress `json:"initializationProgress"`
}
type StageDeclaration ¶
type StageDeclaration struct {
Name string `json:"name"`
Application SoftwareRef `json:"application"`
Databases []SoftwareVersionRef `json:"databases"`
Cronjobs []Cronjob `json:"cronjobs"`
VersionConstraint string `json:"versionConstraint"`
UserData interface{} `json:"userData"`
}
type VersionRef ¶
type VersionRef struct {
Number string `json:"number"`
}
Click to show internal directories.
Click to hide internal directories.