constant

package
v6.39.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2018 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package constant contains types and constants used by the ccv3 package.

Constant Naming Conventions:

The standard naming for a constant is <Constant Type><Enum Name>. The only exception is 'state' types, where the word 'state' is omitted.

For Example:

Constant Type: PackageType
Enum Name: Bits
Enum Value: "bits"
const PackageTypeBits PackageType = "bits"

Constant Type: PackageState
Enum Name: Expired
Enum Value: "EXPIRED"
const PackageExpired PackageState = "EXPIRED"

Index

Constants

View Source
const ProcessTypeWeb = "web"

ProcessTypeWeb represents the "web" process type.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppLifecycleType

type AppLifecycleType string

AppLifecycleType informs the platform of how to build droplets and run apps.

const (
	// AppLifecycleTypeBuildpack will use a droplet and a rootfs to run the app.
	AppLifecycleTypeBuildpack AppLifecycleType = "buildpack"
	// AppLifecycleTypeDocker will pull a docker image from a registry to run an
	// app.
	AppLifecycleTypeDocker AppLifecycleType = "docker"
)

type ApplicationState

type ApplicationState string

ApplicationState represents the current desired state of the app.

const (
	// ApplicationStopped is a desired 'stopped' state.
	ApplicationStopped ApplicationState = "STOPPED"
	// ApplicationStarted is a desired 'started' state.
	ApplicationStarted ApplicationState = "STARTED"
)

type BuildState

type BuildState string

BuildState represents the current state of the build.

const (
	// BuildFailed is when the build has failed/erred during staging.
	BuildFailed BuildState = "FAILED"
	// BuildStaged is when the build has successfully been staged.
	BuildStaged BuildState = "STAGED"
	// BuildStaging is when the build is in the process of being staged.
	BuildStaging BuildState = "STAGING"
)

type DropletState

type DropletState string

DropletState is the state of the droplet.

const (
	// DropletStaged is a droplet that has been properly processed.
	DropletStaged DropletState = "STAGED"
	// DropletFailed is a droplet that had failed the staging process.
	DropletFailed DropletState = "FAILED"
	// DropletCopying is a droplet that's being copied from another droplet.
	DropletCopying DropletState = "COPYING"
	// DropletExpired is a droplet that has expired and is no longer in the
	// system.
	DropletExpired DropletState = "EXPIRED"
)

type JobState

type JobState string

JobState is the current state of a job.

const (
	// JobComplete is when the job is no longer and it was successful.
	JobComplete JobState = "COMPLETE"
	// JobFailed is when the job is no longer running due to a failure.
	JobFailed JobState = "FAILED"
	// JobProcessing is when the job is waiting to be run.
	JobProcessing JobState = "PROCESSING"
)

type PackageState

type PackageState string

PackageState represents the state of a package.

const (
	// PackageProcessingUpload is a package that's being process by the CC.
	PackageProcessingUpload PackageState = "PROCESSING_UPLOAD"
	// PackageReady is a package that's ready to use.
	PackageReady PackageState = "READY"
	// PackageFailed is a package that has failed to be constructed.
	PackageFailed PackageState = "FAILED"
	// PackageAwaitingUpload is a package that does not have any bits or settings
	// yet.
	PackageAwaitingUpload PackageState = "AWAITING_UPLOAD"
	// PackageCopying is a package that's being copied from another package.
	PackageCopying PackageState = "COPYING"
	// PackageExpired is a package that has expired and is no longer in the
	// system.
	PackageExpired PackageState = "EXPIRED"
)

type PackageType

type PackageType string

PackageType represents the type of package.

const (
	// PackageTypeBits is used to upload source code for an app.
	PackageTypeBits PackageType = "bits"
	// PackageTypeDocker references a docker image from a registry.
	PackageTypeDocker PackageType = "docker"
)

type ProcessInstanceState

type ProcessInstanceState string

ProcessInstanceState is the state of a given process.

const (
	// ProcessInstanceRunning is when the process is running normally.
	ProcessInstanceRunning ProcessInstanceState = "RUNNING"
	// ProcessInstanceCrashed is when the process has crashed.
	ProcessInstanceCrashed ProcessInstanceState = "CRASHED"
	// ProcessInstanceStarting is when the process is starting up.
	ProcessInstanceStarting ProcessInstanceState = "STARTING"
	// ProcessInstanceDown is when the process has gone down.
	ProcessInstanceDown ProcessInstanceState = "DOWN"
)

type RelationshipType

type RelationshipType string

RelationshipType represetns the Cloud Controller To-One resource targetted by a relationship.

const (
	// RelationshipTypeApplication is a relationship with a Cloud Controller
	// application.
	RelationshipTypeApplication RelationshipType = "app"

	// RelationshipTypeSpace is a relationship with a CloudController space.
	RelationshipTypeSpace RelationshipType = "space"
)

type TaskState

type TaskState string

TaskState represents the state of the task

const (
	// TaskPending is when the task is pending.
	TaskPending TaskState = "PENDING"
	// TaskRunning is when the task is running.
	TaskRunning TaskState = "RUNNING"
	// TaskSucceeded is when the task succeeded.
	TaskSucceeded TaskState = "SUCCEEDED"
	// TaskCanceling is when the task is canceling.
	TaskCanceling TaskState = "CANCELING"
	// TaskFailed is when the task Failed.
	TaskFailed TaskState = "FAILED"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL