v3_helpers

package
v0.0.0-...-2594583 Latest Latest
Warning

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

Go to latest
Published: Dec 11, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const (
	FAILED string = "FAILED"
	STAGED string = "STAGED"
)
View Source
const (
	V3_DEFAULT_MEMORY_LIMIT = "256"
	V3_JAVA_MEMORY_LIMIT    = "1024"
)

Variables

This section is empty.

Functions

func AssignDropletToApp

func AssignDropletToApp(appGUID, dropletGUID string)

func CancelDeployment

func CancelDeployment(deploymentGUID string)

func ContinueDeployment

func ContinueDeployment(deploymentGUID string)

func CreateAndAssociateNewDroplet

func CreateAndAssociateNewDroplet(appGUID, assetPath string, buildpacks ...string) string

func CreateAndMapRoute

func CreateAndMapRoute(appGUID, spaceGUID, domainGUID, host string)

func CreateAndMapRouteWithPort

func CreateAndMapRouteWithPort(appGUID, spaceGUID, domainGUID, host string, port int)

func CreateApp

func CreateApp(appName, spaceGUID, environmentVariables string) string

func CreateDeployment

func CreateDeployment(appGUID, strategy string, max_in_flight int) string

func CreateDeploymentForDroplet

func CreateDeploymentForDroplet(appGUID, dropletGUID, strategy string) string

func CreateDockerApp

func CreateDockerApp(appName, spaceGUID, environmentVariables string) string

func CreatePackage

func CreatePackage(appGUID string) string

func CreateRoute

func CreateRoute(spaceGUID, domainGUID, host string) string

func CreateRouteWithPath

func CreateRouteWithPath(spaceGUID, domainGUID, host, path string) string

func CreateSidecar

func CreateSidecar(name string, processTypes []string, command string, memoryLimit int, appGuid string) string

func DeleteApp

func DeleteApp(appGUID string)

func DeleteOrgQuota

func DeleteOrgQuota(orgQuotaGUID string)

func DeleteRoute

func DeleteRoute(routeGUID string)

func DownloadAppDroplet

func DownloadAppDroplet(appGuid string, dropletPath string, token string) *Session

func EnableRevisions

func EnableRevisions(appGuid string)

func GetAppGUID

func GetAppGUID(appName string) string

func GetAuthToken

func GetAuthToken() string

func GetBuildError

func GetBuildError(buildGUID string) string

func GetDomainGUIDFromName

func GetDomainGUIDFromName(name string) string

func GetDropletFromApp

func GetDropletFromApp(appGUID string) string

func GetDropletFromBuild

func GetDropletFromBuild(buildGUID string) string

func GetGuidFromResponse

func GetGuidFromResponse(response []byte) string

func GetJobErrors

func GetJobErrors(jobPath string) []jobError

func GetJobPath

func GetJobPath(response []byte) string

func GetOrgGUIDFromName

func GetOrgGUIDFromName(name string) string

func GetProcessGuidsForType

func GetProcessGuidsForType(appGUID string, processType string) []string

func GetRouteGUIDFromAppGuid

func GetRouteGUIDFromAppGuid(appGuid string) string

func GetRunningInstancesStats

func GetRunningInstancesStats(processGUID string) int

func GetSpaceGuidFromName

func GetSpaceGuidFromName(name string) string

func HandleAsyncRequest

func HandleAsyncRequest(path string, method string)

func InsertDestinations

func InsertDestinations(routeGUID string, destinations []Destination) []string

func PollJob

func PollJob(jobPath string)

func PollJobAsFailed

func PollJobAsFailed(jobPath string)

func RestartApp

func RestartApp(appGUID string)

func RollbackDeployment

func RollbackDeployment(appGUID, revisionGUID string) string

func ScaleApp

func ScaleApp(appGUID string, instances int)

func ScaleProcess

func ScaleProcess(appGUID, processType, memoryInMb string)

func SetCommandOnProcess

func SetCommandOnProcess(appGUID, processType, command string)

func SetDefaultOrgQuota

func SetDefaultOrgQuota(orgGUID string)

func SetHealthCheckTimeoutOnProcess

func SetHealthCheckTimeoutOnProcess(appGUID, processType string, healthCheckTimeout int)

func StagePackage

func StagePackage(packageGUID string, lifecycle string, buildpacks ...string) string

func StartApp

func StartApp(appGUID string)

func StopApp

func StopApp(appGUID string)

func UnmapAllRoutes

func UnmapAllRoutes(appGUID string)

func UpdateEnvironmentVariables

func UpdateEnvironmentVariables(appGUID, envVars string)

func UploadPackage

func UploadPackage(uploadURL, packageZipPath string)

func WaitForAppToStop

func WaitForAppToStop(appGUID string)

func WaitForBuildToFail

func WaitForBuildToFail(buildGUID string)

func WaitForBuildToStage

func WaitForBuildToStage(buildGUID string)

func WaitForDropletToCopy

func WaitForDropletToCopy(dropletGUID string)

func WaitForPackageToBeReady

func WaitForPackageToBeReady(packageGUID string)

func WaitUntilDeploymentReachesStatus

func WaitUntilDeploymentReachesStatus(deploymentGUID, statusValue, statusReason string)

Types

type App

type App struct {
	GUID    string              `json:"guid"`
	Process *DestinationProcess `json:"process,omitempty"`
}

type Destination

type Destination struct {
	GUID   string `json:"guid,omitempty"`
	App    App    `json:"app"`
	Port   int    `json:"port,omitempty"`
	Weight int    `json:"weight,omitempty"`
}

type DestinationProcess

type DestinationProcess struct {
	Type string `json:"type"`
}

type Destinations

type Destinations struct {
	Destinations []Destination `json:"destinations"`
}

func ReplaceDestinations

func ReplaceDestinations(routeGUID string, destinations []Destination) Destinations

type Droplet

type Droplet struct {
	GUID      string `json:"guid"`
	State     string `json:"state"`
	Image     string `json:"image"`
	Lifecycle struct {
		Type string   `json:"type"`
		Data struct{} `json:"data"`
	} `json:"lifecycle"`
}

func GetDroplet

func GetDroplet(dropletGUID string) Droplet

type Process

type Process struct {
	Guid          string `json:"guid"`
	Instances     int    `json:"instances"`
	Type          string `json:"type"`
	Command       string `json:"command"`
	Name          string `json:"-"`
	Relationships struct {
		Revision struct {
			Data struct {
				Guid string `json:"guid"`
			} `json:"data"`
		} `json:"revision"`
	} `json:"relationships"`
}

func GetFirstProcessByType

func GetFirstProcessByType(processes []Process, processType string) Process

func GetProcessByGuid

func GetProcessByGuid(processGUID string) Process

func GetProcesses

func GetProcesses(appGUID, appName string) []Process

type ProcessAppUsageEvent

type ProcessAppUsageEvent struct {
	Guid    string `json:"guid"`
	Process struct {
		ProcessType string `json:"type"`
		Guid        string `json:"guid"`
	} `json:"process"`
	State struct {
		Current  string `json:"current"`
		Previous string `json:"previous"`
	} `json:"state"`
}

func GetLastAppUseEventForProcess

func GetLastAppUseEventForProcess(processType string, state string, afterGUID string) (bool, ProcessAppUsageEvent)

type ProcessAppUsageEvents

type ProcessAppUsageEvents struct {
	Resources []ProcessAppUsageEvent `struct:"resources"`
}

type ProcessList

type ProcessList struct {
	Processes []Process `json:"resources"`
}

type Quota

type Quota struct {
	Name string `json:"name"`
	GUID string `json:"guid"`
	Apps struct {
		TotalInstances int `json:"total_instances"`
	} `json:"apps"`
}

func CreateOrgQuota

func CreateOrgQuota(name string, orgGUID string, totalInstances int) Quota

func CreateSpaceQuota

func CreateSpaceQuota(name string, spaceGUID string, orgGUID string, totalInstances int) Quota

type Revision

type Revision struct {
	Guid    string `json:"guid"`
	Version int    `json:"version"`
	Droplet struct {
		Guid string `json:"guid"`
	} `json:"droplet"`
	Processes map[string]map[string]string `json:"processes"`
	Sidecars  []Sidecar                    `json: "sidecars"`
}

func GetNewestRevision

func GetNewestRevision(appGuid string) Revision

func GetRevision

func GetRevision(revisionGuid string) Revision

func GetRevisions

func GetRevisions(appGuid string) []Revision

type RevisionEnvVars

type RevisionEnvVars struct {
	Var map[string]string `json:"var"`
}

func GetRevisionEnvVars

func GetRevisionEnvVars(revisionGuid string) RevisionEnvVars

type RevisionList

type RevisionList struct {
	Revisions []Revision `json:"resources"`
}

type Sidecar

type Sidecar struct {
	Name         string   `json:"name"`
	Command      string   `json:"command"`
	ProcessTypes []string `json:"process_types"`
	MemoryInMb   int      `json:"memory_in_mb"`
}

func GetAppSidecars

func GetAppSidecars(appGuid string) []Sidecar

Jump to

Keyboard shortcuts

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