Documentation ¶
Index ¶
- Constants
- type Build
- type BuildID
- type BuildState
- type BuildStatus
- type ContainerBuild
- type ContainerBuildFailureInfo
- type ContainerBuildID
- type ContainerBuildPhase
- type ContainerBuildState
- type ContainerBuildStatus
- type ContainerLogOptions
- type Deploy
- type DeployID
- type DeployState
- type DeployStatus
- type Error
- func NewConflictError() *Error
- func NewError(code ErrorCode) *Error
- func NewInvalidBuildIDError() *Error
- func NewInvalidDeployIDError() *Error
- func NewInvalidInstanceError() *Error
- func NewInvalidJobIDError() *Error
- func NewInvalidPathError() *Error
- func NewInvalidSecretError() *Error
- func NewInvalidServiceIDError() *Error
- func NewInvalidSidecarError() *Error
- func NewInvalidSystemIDError() *Error
- func NewInvalidSystemOptionsError() *Error
- func NewInvalidTeardownIDError() *Error
- func NewInvalidVersionError() *Error
- func NewSystemAlreadyExistsError() *Error
- func NewSystemDeletingError() *Error
- func NewSystemFailedError() *Error
- func NewSystemPendingError() *Error
- func NewUnknownError() *Error
- type ErrorCode
- type Job
- type JobID
- type JobState
- type JobStatus
- type LatticeID
- type NodePool
- type NodePoolFailureInfo
- type NodePoolState
- type NodePoolStatus
- type Secret
- type Service
- type ServiceFailureInfo
- type ServiceID
- type ServiceState
- type ServiceStatus
- type System
- type SystemID
- type SystemState
- type SystemStatus
- type Teardown
- type TeardownID
- type TeardownState
- type TeardownStatus
- type Version
- type WorkloadBuild
Constants ¶
View Source
const ( ContainerBuildPhasePullingGitRepository ContainerBuildPhase = "pulling git repository" ContainerBuildPhasePullingDockerImage ContainerBuildPhase = "pulling docker image" ContainerBuildPhaseBuildingDockerImage ContainerBuildPhase = "building docker image" ContainerBuildPhasePushingDockerImage ContainerBuildPhase = "pushing docker image" ContainerBuildStatePending ContainerBuildState = "pending" ContainerBuildStateQueued ContainerBuildState = "queued" ContainerBuildStateRunning ContainerBuildState = "running" ContainerBuildStateSucceeded ContainerBuildState = "succeeded" ContainerBuildStateFailed ContainerBuildState = "failed" )
View Source
const ( NodePoolStatePending = "pending" NodePoolStateDeleting = "deleting" NodePoolStateStable = "stable" NodePoolStateScaling = "scaling" NodePoolStateUpdating = "updating" NodePoolStateFailed = "failed" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Build ¶
type Build struct { ID BuildID `json:"id"` Path *tree.Path `json:"path,omitempty"` Version *Version `json:"version,omitempty"` Status BuildStatus `json:"status"` }
type BuildState ¶
type BuildState string
const ( BuildStatePending BuildState = "pending" BuildStateAccepted BuildState = "accepted" // FIXME(kevindrosendahl): should probably standardize on running vs in progress BuildStateRunning BuildState = "running" BuildStateSucceeded BuildState = "succeeded" BuildStateFailed BuildState = "failed" )
type BuildStatus ¶
type BuildStatus struct { State BuildState `json:"state"` Message string `json:"message,omitempty"` StartTimestamp *time.Time `json:"startTimestamp,omitempty"` CompletionTimestamp *time.Time `json:"completionTimestamp,omitempty"` Path *tree.Path `json:"path,omitempty"` Version *Version `json:"version,omitempty"` // Workloads maps component paths (e.g. /foo/bar/buzz) to the // status of the build for that service in the Build. Workloads map[tree.Path]WorkloadBuild `json:"workloads"` }
type ContainerBuild ¶
type ContainerBuild struct { ID ContainerBuildID `json:"id"` Status ContainerBuildStatus `json:"status"` }
type ContainerBuildID ¶
type ContainerBuildID string
type ContainerBuildPhase ¶
type ContainerBuildPhase string
type ContainerBuildState ¶
type ContainerBuildState string
type ContainerBuildStatus ¶
type ContainerBuildStatus struct { State ContainerBuildState `json:"state"` StartTimestamp *time.Time `json:"startTimestamp,omitempty"` CompletionTimestamp *time.Time `json:"completionTimestamp,omitempty"` LastObservedPhase *ContainerBuildPhase `json:"lastObservedPhase,omitempty"` FailureMessage *string `json:"failureMessage,omitempty"` }
type ContainerLogOptions ¶
type ContainerLogOptions struct { Follow bool `json:"follow,omitempty"` Tail *int64 `json:"tail,omitempty"` Previous bool `json:"previous,omitempty"` Since string `json:"since,omitempty"` SinceTime string `json:"sinceTime,omitempty"` Timestamps bool `json:"timestamps,omitempty"` }
ContainerLogOptions represents options for retrieving log files
type DeployState ¶
type DeployState string
const ( DeployStatePending DeployState = "pending" DeployStateAccepted DeployState = "accepted" DeployStateInProgress DeployState = "in progress" DeployStateSucceeded DeployState = "succeeded" DeployStateFailed DeployState = "failed" )
type DeployStatus ¶
type DeployStatus struct { State DeployState `json:"state"` Message string `json:"message,omitempty"` Build *BuildID `json:"build,omitempty"` Path *tree.Path `json:"path,omitempty"` Version *Version `json:"version,omitempty"` StartTimestamp *time.Time `json:"startTimestamp,omitempty"` CompletionTimestamp *time.Time `json:"completionTimestamp,omitempty"` }
type Error ¶
type Error struct {
Code ErrorCode `json:"code"`
}
func NewConflictError ¶
func NewConflictError() *Error
func NewInvalidBuildIDError ¶
func NewInvalidBuildIDError() *Error
func NewInvalidDeployIDError ¶
func NewInvalidDeployIDError() *Error
func NewInvalidInstanceError ¶
func NewInvalidInstanceError() *Error
func NewInvalidJobIDError ¶
func NewInvalidJobIDError() *Error
func NewInvalidPathError ¶
func NewInvalidPathError() *Error
func NewInvalidSecretError ¶
func NewInvalidSecretError() *Error
func NewInvalidServiceIDError ¶
func NewInvalidServiceIDError() *Error
func NewInvalidSidecarError ¶
func NewInvalidSidecarError() *Error
func NewInvalidSystemIDError ¶
func NewInvalidSystemIDError() *Error
func NewInvalidSystemOptionsError ¶
func NewInvalidSystemOptionsError() *Error
func NewInvalidTeardownIDError ¶
func NewInvalidTeardownIDError() *Error
func NewInvalidVersionError ¶
func NewInvalidVersionError() *Error
func NewSystemAlreadyExistsError ¶
func NewSystemAlreadyExistsError() *Error
func NewSystemDeletingError ¶
func NewSystemDeletingError() *Error
func NewSystemFailedError ¶
func NewSystemFailedError() *Error
func NewSystemPendingError ¶
func NewSystemPendingError() *Error
func NewUnknownError ¶
func NewUnknownError() *Error
type ErrorCode ¶
type ErrorCode string
const ( ErrorCodeUnknown ErrorCode = "UNKNOWN" ErrorCodeConflict ErrorCode = "CONFLICT" ErrorCodeInvalidBuildID ErrorCode = "INVALID_BUILD_ID" ErrorCodeInvalidDeployID ErrorCode = "INVALID_DEPLOY_ID" ErrorCodeInvalidJobID ErrorCode = "INVALID_JOB_ID" ErrorCodeInvalidSecret ErrorCode = "INVALID_SECRET" ErrorCodeInvalidServiceID ErrorCode = "INVALID_SERVICE_ID" ErrorCodeSystemAlreadyExists ErrorCode = "SYSTEM_ALREADY_EXISTS" ErrorCodeInvalidSystemID ErrorCode = "INVALID_SYSTEM_ID" ErrorCodeSystemDeleting ErrorCode = "SYSTEM_DELETING" ErrorCodeSystemFailed ErrorCode = "SYSTEM_FAILED" ErrorCodeSystemPending ErrorCode = "SYSTEM_PENDING" ErrorCodeInvalidSystemOptions ErrorCode = "INVALID_SYSTEM_OPTIONS" ErrorCodeInvalidTeardownID ErrorCode = "INVALID_TEARDOWN_ID" ErrorCodeInvalidInstance ErrorCode = "INVALID_INSTANCE" ErrorCodeInvalidPath ErrorCode = "INVALID_PATH" ErrorCodeInvalidSidecar ErrorCode = "INVALID_SIDECAR" ErrorCodeInvalidVersion ErrorCode = "INVALID_VERSION" )
type NodePool ¶
type NodePool struct { ID string `json:"id"` Path tree.PathSubcomponent `json:"path"` InstanceType string `json:"instanceType"` NumInstances int32 `json:"numInstances"` Status NodePoolStatus `json:"status"` }
type NodePoolFailureInfo ¶
type NodePoolState ¶
type NodePoolState string
type NodePoolStatus ¶
type NodePoolStatus struct { State NodePoolState `json:"state"` FailureInfo *NodePoolFailureInfo `json:"failureInfo,omitempty"` // FIXME: how to deal with epochs? InstanceType string `json:"instanceType"` NumInstances int32 `json:"numInstances"` }
type Secret ¶
type Secret struct { Path tree.PathSubcomponent `json:"path"` Value string `json:"value"` }
type Service ¶
type Service struct { ID ServiceID `json:"id"` Path tree.Path `json:"path"` Status ServiceStatus `json:"status"` }
type ServiceFailureInfo ¶
type ServiceState ¶
type ServiceState string
const ( ServiceStatePending ServiceState = "pending" ServiceStateDeleting ServiceState = "deleting" ServiceStateScaling ServiceState = "scaling" ServiceStateUpdating ServiceState = "updating" ServiceStateStable ServiceState = "stable" ServiceStateFailed ServiceState = "failed" )
type ServiceStatus ¶
type ServiceStatus struct { State ServiceState `json:"state"` Message *string `json:"message,omitempty"` FailureInfo *ServiceFailureInfo `json:"failureInfo,omitempty"` AvailableInstances int32 `json:"availableInstances"` UpdatedInstances int32 `json:"updatedInstances"` StaleInstances int32 `json:"staleInstances"` TerminatingInstances int32 `json:"terminatingInstances"` Ports map[int32]string `json:"ports"` Instances []string `json:"instances"` }
type System ¶
type System struct { ID SystemID `json:"id"` DefinitionURL string `json:"definitionUrl"` Status SystemStatus `json:"status"` }
type SystemState ¶
type SystemState string
const ( SystemStatePending SystemState = "pending" SystemStateFailed SystemState = "failed" SystemStateDeleting SystemState = "deleting" SystemStateStable SystemState = "stable" SystemStateDegraded SystemState = "degraded" SystemStateScaling SystemState = "scaling" SystemStateUpdating SystemState = "updating" )
type SystemStatus ¶
type Teardown ¶
type Teardown struct { ID TeardownID `json:"id"` Status TeardownStatus `json:"status"` }
type TeardownID ¶
type TeardownID string
type TeardownState ¶
type TeardownState string
const ( TeardownStatePending TeardownState = "pending" TeardownStateInProgress TeardownState = "in progress" TeardownStateSucceeded TeardownState = "succeeded" TeardownStateFailed TeardownState = "failed" )
type TeardownStatus ¶
type WorkloadBuild ¶
type WorkloadBuild struct { ContainerBuild Sidecars map[string]ContainerBuild `json:"sidecars,omitempty"` }
Source Files ¶
Click to show internal directories.
Click to hide internal directories.