constant

package
v7.1.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 9, 2020 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 (
	// AutodetectBuildpackValueDefault is used to unset the buildpack values on
	// an application.
	AutodetectBuildpackValueDefault = "default"
	// AutodetectBuildpackValueNull is used to unset the buildpack values on an
	// application.
	AutodetectBuildpackValueNull = "null"
)
View Source
const (
	// BuildpackAwaitingUpload represents the awaiting upload state of a buildpack.
	BuildpackAwaitingUpload = "AWAITING_UPLOAD"
	// BuildpackReady represents the ready state of a buildpack.
	BuildpackReady = "READY"
)
View Source
const DefaultOriginUaa = "uaa"

DefaultOriginUaa is the default origin used for looking up users by username when no origin is given.

View Source
const MaxNumberOfResourcesForMatching = 5000

MaxNumberOfResourcesForMatching is the maximum number of resources that can be sent to the /v3/resource_match endpoint.

View Source
const ProcessHealthCheckEndpointDefault = "/"

ProcessHealthCheckEndpointDefault is the default HTTP endpoint used for the HTTP health check in the runtime.

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 ApplicationAction

type ApplicationAction string

ApplicationAction represents the action being taken on an application

const (
	// ApplicationStarting indicates that the app is being started
	ApplicationStarting ApplicationAction = "Starting"
	// ApplicationRestarting indicates that the app is being restarted
	ApplicationRestarting ApplicationAction = "Restarting"
)

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 DeploymentState

type DeploymentState string

DeploymentState describes the states a zero down time deployment used to push new apps without restart can be in.

const (
	// DeploymentDeploying means the deployment is in state 'DEPLOYING'
	DeploymentDeploying DeploymentState = "DEPLOYING"

	// DeploymentCanceled means the deployment is in state 'CANCELED'
	DeploymentCanceled DeploymentState = "CANCELED"

	// DeploymentDeployed means the deployment is in state 'DEPLOYED'
	DeploymentDeployed DeploymentState = "DEPLOYED"

	// DeploymentCanceled means the deployment is in state 'CANCELING'
	DeploymentCanceling DeploymentState = "CANCELING"

	// DeploymentFailing means the deployment is in state 'FAILING'
	DeploymentFailing DeploymentState = "FAILING"

	// DeploymentFailed means the deployment is in state 'FAILED'
	DeploymentFailed DeploymentState = "FAILED"
)

type DeploymentStatusReason

type DeploymentStatusReason string

DeploymentStatusReason describes the status reasons a deployment can have

const (
	// DeploymentStatusReasonDeployed means the deployment's status.value is
	// 'DEPLOYED'
	DeploymentStatusReasonDeployed DeploymentStatusReason = "DEPLOYED"

	// DeploymentStatusReasonCanceled means the deployment's status.value is
	// 'CANCELED'
	DeploymentStatusReasonCanceled DeploymentStatusReason = "CANCELED"

	// DeploymentStatusReasonSuperseded means the deployment's status.value is
	// 'SUPERSEDED'
	DeploymentStatusReasonSuperseded DeploymentStatusReason = "SUPERSEDED"
)

type DeploymentStatusValue

type DeploymentStatusValue string

DeploymentStatusValue describes the status values a deployment can have

const (
	// DeploymentStatusValueActive means the deployment's status.value is
	// 'ACTIVE'
	DeploymentStatusValueActive DeploymentStatusValue = "ACTIVE"

	// DeploymentStatusValueFinalized means the deployment's status.value is
	// 'FINALIZED'
	DeploymentStatusValueFinalized DeploymentStatusValue = "FINALIZED"
)

type DeploymentStrategy

type DeploymentStrategy string

DeploymentStrategy is the strategy used to push an application.

const (
	// Default means app will be stopped and started with new droplet.
	DeploymentStrategyDefault DeploymentStrategy = ""

	// Rolling means a new web process will be created for the app and instances will roll from the old one to the new one.
	DeploymentStrategyRolling DeploymentStrategy = "rolling"
)

type DropletState

type DropletState string

DropletState is the state of the droplet.

const (
	// DropletAwaitingUpload is a droplet that has been created without a package.
	DropletAwaitingUpload DropletState = "AWAITING_UPLOAD"
	// 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 EnvironmentVariableGroupName

type EnvironmentVariableGroupName string
const (
	StagingEnvironmentVariableGroup EnvironmentVariableGroupName = "staging"
	RunningEnvironmentVariableGroup EnvironmentVariableGroupName = "running"
)

type HealthCheckType

type HealthCheckType string

HealthCheckType is the manner in which Cloud Foundry verifies the app's status.

const (
	// HTTP means that CF will make a GET request to the configured HTTP endpoint on the app's default port. Useful if the app can provide an HTTP 200 response.
	HTTP HealthCheckType = "http"
	// Port means that CF will make a TCP connection to the port of ports configured. Useful if the app can receive TCP connections.
	Port HealthCheckType = "port"
	// Process means that Diego ensures that the process(es) stay running. Useful if the app cannot support TCP connections.
	Process HealthCheckType = "process"
)

type IncludedType

type IncludedType string

IncludedType represents the additional resources queried from CloudController using the include parameter

const (
	IncludedTypeUsers IncludedType = "users"
)

type JobErrorCode

type JobErrorCode int64

JobErrorCode is the numeric code for a particular error.

const (
	JobErrorCodeBuildpackAlreadyExistsForStack JobErrorCode = 290000
	JobErrorCodeBuildpackInvalid               JobErrorCode = 290003
	JobErrorCodeBuildpackStacksDontMatch       JobErrorCode = 390011
	JobErrorCodeBuildpackStackDoesNotExist     JobErrorCode = 390012
	JobErrorCodeBuildpackZipInvalid            JobErrorCode = 390013
)

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 represents the Cloud Controller To-One resource targeted by a relationship.

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

	// RelationshipTypeSpace is a relationship with a Cloud Controller space.
	RelationshipTypeSpace RelationshipType = "space"

	// RelationshipTypeOrganization is a relationship with a Cloud Controller
	// organization.
	RelationshipTypeOrganization RelationshipType = "organization"

	// RelationshipTypeUser is a relationship with a Cloud Controller user.
	RelationshipTypeUser RelationshipType = "user"

	// RelationshipTypeQuota is a relationship with a Cloud Controller quota (org quota or space quota).
	RelationshipTypeQuota RelationshipType = "quota"
)

type RoleType

type RoleType string

RoleType is the type of a CCV3 role resource.

const (
	OrgUserRole           RoleType = "organization_user"
	OrgAuditorRole        RoleType = "organization_auditor"
	OrgManagerRole        RoleType = "organization_manager"
	OrgBillingManagerRole RoleType = "organization_billing_manager"
	SpaceDeveloperRole    RoleType = "space_developer"
	SpaceAuditorRole      RoleType = "space_auditor"
	SpaceManagerRole      RoleType = "space_manager"
)

type SecurityGroupLifecycle

type SecurityGroupLifecycle string

SecurityGroupLifecycle represents the lifecycle phase of a security group binding.

const (
	// SecurityGroupLifecycleRunning indicates the lifecycle phase running.
	SecurityGroupLifecycleRunning SecurityGroupLifecycle = "running"

	// SecurityGroupLifecycleStaging indicates the lifecycle phase staging.
	SecurityGroupLifecycleStaging SecurityGroupLifecycle = "staging"
)

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