constant

package
v6.36.2+incompatible Latest Latest
Warning

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

Go to latest
Published: May 16, 2018 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package constant contains types and constants used by the ccv2 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"

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationHealthCheckType

type ApplicationHealthCheckType string

ApplicationHealthCheckType is the method to reach the applications health check

const (
	ApplicationHealthCheckPort    ApplicationHealthCheckType = "port"
	ApplicationHealthCheckHTTP    ApplicationHealthCheckType = "http"
	ApplicationHealthCheckProcess ApplicationHealthCheckType = "process"
)

type ApplicationInstanceState

type ApplicationInstanceState string

ApplicationInstanceState reflects the state of the individual app instance.

const (
	// ApplicationInstanceCrashed represents an application instance in the
	// crashed state.
	ApplicationInstanceCrashed ApplicationInstanceState = "CRASHED"
	// ApplicationInstanceDown represents an application instance in the down
	// state.
	ApplicationInstanceDown ApplicationInstanceState = "DOWN"
	// ApplicationInstanceFlapping represents an application instance that keeps
	// failing after it starts.
	ApplicationInstanceFlapping ApplicationInstanceState = "FLAPPING"
	// ApplicationInstanceRunning represents an application instance that is
	// currently running.
	ApplicationInstanceRunning ApplicationInstanceState = "RUNNING"
	// ApplicationInstanceStarting represents an application that is the process
	// of starting.
	ApplicationInstanceStarting ApplicationInstanceState = "STARTING"
	// ApplicationInstanceUnknown represents a state that cannot be determined.
	ApplicationInstanceUnknown ApplicationInstanceState = "UNKNOWN"
)

type ApplicationPackageState

type ApplicationPackageState string

ApplicationPackageState is the staging state of application bits.

const (
	ApplicationPackageStaged  ApplicationPackageState = "STAGED"
	ApplicationPackagePending ApplicationPackageState = "PENDING"
	ApplicationPackageFailed  ApplicationPackageState = "FAILED"
	ApplicationPackageUnknown ApplicationPackageState = "UNKNOWN"
)

type ApplicationState

type ApplicationState string

ApplicationState is the running state of an application.

const (
	ApplicationStarted ApplicationState = "STARTED"
	ApplicationStopped ApplicationState = "STOPPED"
)

type DomainType

type DomainType string
const (
	PrivateDomain DomainType = "private"
	SharedDomain  DomainType = "shared"
)

type FeatureFlagName

type FeatureFlagName string

FeatureFlagName is the name of the feature flag given by the Cloud Controller.

const (
	// FeatureFlagServiceInstanceSharing is the name of the service instance
	// sharing feature flag.
	FeatureFlagServiceInstanceSharing FeatureFlagName = "service_instance_sharing"
)

type FilterOperator

type FilterOperator string

FilterOperator is the type of operation a Filter uses.

const (
	// EqualOperator is the Filter's equal operator.
	EqualOperator FilterOperator = ":"

	// InOperator is the Filter's "IN" operator.
	InOperator FilterOperator = " IN "
)

type FilterType

type FilterType string

FilterType is the type of filter a Filter uses.

const (
	// AppGUIDFilter is the name of the 'app_guid' filter.
	AppGUIDFilter FilterType = "app_guid"
	// DomainGUIDFilter is the name of the 'domain_guid' filter.
	DomainGUIDFilter FilterType = "domain_guid"
	// OrganizationGUIDFilter is the name of the 'organization_guid' filter.
	OrganizationGUIDFilter FilterType = "organization_guid"
	// RouteGUIDFilter is the name of the 'route_guid' filter.
	RouteGUIDFilter FilterType = "route_guid"
	// ServiceInstanceGUIDFilter is the name of the 'service_instance_guid' filter.
	ServiceInstanceGUIDFilter FilterType = "service_instance_guid"
	// SpaceGUIDFilter is the name of the 'space_guid' filter.
	SpaceGUIDFilter FilterType = "space_guid"

	// NameFilter is the name of the 'name' filter.
	NameFilter FilterType = "name"
	// HostFilter is the name of the 'host' filter.
	HostFilter FilterType = "host"
	// PathFilter is the name of the 'path' filter.
	PathFilter FilterType = "path"
	// PortFilter is the name of the 'port' filter.
	PortFilter FilterType = "port"
)

type JobStatus

type JobStatus string

JobStatus is the current state of a job.

const (
	// JobStatusFailed is when the job is no longer running due to a failure.
	JobStatusFailed JobStatus = "failed"

	// JobStatusFinished is when the job is no longer and it was successful.
	JobStatusFinished JobStatus = "finished"

	// JobStatusQueued is when the job is waiting to be run.
	JobStatusQueued JobStatus = "queued"

	// JobStatusRunning is when the job is running.
	JobStatusRunning JobStatus = "running"
)

type RouterGroupType

type RouterGroupType string

RouterGroupType is an enumeration of all possible router group types.

const (
	// TCPRouterGroup represents a TCP router group.
	TCPRouterGroup RouterGroupType = "tcp"
	// HTTPRouterGroup represents a HTTP router group.
	HTTPRouterGroup RouterGroupType = "http"
)

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 ServiceInstanceType

type ServiceInstanceType string
const (
	// UserProvidedService is a Service Instance that is created by a user.
	ServiceInstanceTypeUserProvidedService ServiceInstanceType = "user_provided_service_instance"

	// ManagedService is a Service Instance that is managed by a service broker.
	ServiceInstanceTypeManagedService ServiceInstanceType = "managed_service_instance"
)

Jump to

Keyboard shortcuts

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