cfclient

package module
v0.0.0-...-9c4e6c5 Latest Latest
Warning

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

Go to latest
Published: Sep 30, 2022 License: MIT Imports: 22 Imported by: 287

README

go-cfclient

build workflow GoDoc Report card

Overview

cfclient is a package to assist you in writing apps that need to interact with Cloud Foundry. It provides functions and structures to retrieve and update

Usage

go get github.com/cloudfoundry-community/go-cfclient

NOTE: Currently this project is not versioning its releases and so breaking changes might be introduced. Whilst hopefully notifications of breaking changes are made via commit messages, ideally your project will use a local vendoring system to lock in a version of go-cfclient that is known to work for you. This will allow you to control the timing and maintenance of upgrades to newer versions of this library.

Some example code:

package main

import (
	"fmt"

	"github.com/cloudfoundry-community/go-cfclient"
)

func main() {
	c := &cfclient.Config{
		ApiAddress: "https://api.10.244.0.34.xip.io",
		Username:   "admin",
		Password:   "secret",
	}
	client, _ := cfclient.NewClient(c)
	apps, _ := client.ListApps()
	fmt.Println(apps)
}
Paging Results

The API supports paging results via query string parameters. All of the v3 ListV3*ByQuery functions support paging. Only a subset of v2 function calls support paging the results:

  • ListSpacesByQuery
  • ListOrgsByQuery
  • ListAppsByQuery
  • ListServiceInstancesByQuery
  • ListUsersByQuery

You can iterate over the results page-by-page using a function similar to this one:

func processSpacesOnePageAtATime(client *cfclient.Client) error {
	page := 1
	pageSize := 50

	q := url.Values{}
	q.Add("results-per-page", strconv.Itoa(pageSize))

	for {
		// get the current page of spaces
		q.Set("page", strconv.Itoa(page))
		spaces, err := client.ListSpacesByQuery(q)
		if err != nil {
			fmt.Printf("Error getting spaces by query: %s", err)
			return err
		}

		// do something with each space
		fmt.Printf("Page %d:\n", page)
		for _, s := range spaces {
			fmt.Println("  " + s.Name)
		}

		// if we hit an empty page or partial page, that means we're done
		if len(spaces) < pageSize {
			break
		}

		// next page
		page++
	}
	return nil
}

Development

make all
Errors

If the Cloud Foundry error definitions change at https://github.com/cloudfoundry/cloud_controller_ng/blob/master/vendor/errors/v2.yml then the error predicate functions in this package need to be regenerated.

To do this, simply use Go to regenerate the code:

make generate

Contributing

Pull requests welcome. Please ensure you run all the unit tests, go fmt the code, and golangci-lint via make all

Documentation

Index

Constants

View Source
const (
	AppCrash      = "app.crash"
	AppStart      = "audit.app.start"
	AppStop       = "audit.app.stop"
	AppUpdate     = "audit.app.update"
	AppCreate     = "audit.app.create"
	AppDelete     = "audit.app.delete-request"
	AppSSHAuth    = "audit.app.ssh-authorized"
	AppSSHUnauth  = "audit.app.ssh-unauthorized"
	AppRestage    = "audit.app.restage"
	AppMapRoute   = "audit.app.map-route"
	AppUnmapRoute = "audit.app.unmap-route"
)

Exported event constants

View Source
const (
	FilterTimestamp = "timestamp"
	FilterActee     = "actee"
)

Exported filter constants

Variables

View Source
var ErrPreventRedirect = errors.New("prevent-redirect")
View Source
var MinStagingSpacesVersion *semver.Version = getMinStagingSpacesVersion()
View Source
var ValidOperators = []string{":", ">=", "<=", "<", ">", "IN"}

ValidOperators global variable for all valid operators in a query

Functions

func IsAnnotationLimitExceededError

func IsAnnotationLimitExceededError(err error) bool

IsAnnotationLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390023 - HTTP code: 422 - message: "Failed to add %d annotations because it would exceed maximum of %d"

func IsAppBitsCopyInvalidError

func IsAppBitsCopyInvalidError(err error) bool

IsAppBitsCopyInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 160002 - HTTP code: 400 - message: "The app copy is invalid: %s"

func IsAppBitsUploadInvalidError

func IsAppBitsUploadInvalidError(err error) bool

IsAppBitsUploadInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 160001 - HTTP code: 400 - message: "The app upload is invalid: %s"

func IsAppInvalidError

func IsAppInvalidError(err error) bool

IsAppInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100001 - HTTP code: 400 - message: "The app is invalid: %s"

func IsAppMemoryInsufficientForSidecarsError

func IsAppMemoryInsufficientForSidecarsError(err error) bool

IsAppMemoryInsufficientForSidecarsError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100009 - HTTP code: 400 - message: "The requested memory allocation is not large enough to run all of your sidecar processes."

func IsAppMemoryInvalidError

func IsAppMemoryInvalidError(err error) bool

IsAppMemoryInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100006 - HTTP code: 400 - message: "You have specified an invalid amount of memory for your application."

func IsAppMemoryQuotaExceededError

func IsAppMemoryQuotaExceededError(err error) bool

IsAppMemoryQuotaExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100005 - HTTP code: 400 - message: "You have exceeded your organization's memory limit: %s"

func IsAppNameTakenError

func IsAppNameTakenError(err error) bool

IsAppNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100002 - HTTP code: 400 - message: "The app name is taken: %s"

func IsAppNotFoundError

func IsAppNotFoundError(err error) bool

IsAppNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100004 - HTTP code: 404 - message: "The app could not be found: %s"

func IsAppPackageInvalidError

func IsAppPackageInvalidError(err error) bool

IsAppPackageInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150001 - HTTP code: 400 - message: "The app package is invalid: %s"

func IsAppPackageNotFoundError

func IsAppPackageNotFoundError(err error) bool

IsAppPackageNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150002 - HTTP code: 404 - message: "The app package could not be found: %s"

func IsAppPortMappingRequiresDiegoError

func IsAppPortMappingRequiresDiegoError(err error) bool

IsAppPortMappingRequiresDiegoError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60022 - HTTP code: 400 - message: "App ports are supported for Diego apps only."

func IsAppRecursiveDeleteFailedError

func IsAppRecursiveDeleteFailedError(err error) bool

IsAppRecursiveDeleteFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150009 - HTTP code: 502 - message: "Deletion of app %s failed because one or more associated resources could not be deleted.\n\n%s"

func IsAppResourcesFileModeInvalidError

func IsAppResourcesFileModeInvalidError(err error) bool

IsAppResourcesFileModeInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 160003 - HTTP code: 400 - message: "The resource file mode is invalid: %s"

func IsAppResourcesFilePathInvalidError

func IsAppResourcesFilePathInvalidError(err error) bool

IsAppResourcesFilePathInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 160004 - HTTP code: 400 - message: "The resource file path is invalid: %s"

func IsAppStoppedStatsError

func IsAppStoppedStatsError(err error) bool

IsAppStoppedStatsError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 200003 - HTTP code: 400 - message: "Could not fetch stats for stopped app: %s"

func IsAssociationNotEmptyError

func IsAssociationNotEmptyError(err error) bool

IsAssociationNotEmptyError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10006 - HTTP code: 400 - message: "Please delete the %s associations for your %s."

func IsAsyncServiceBindingOperationInProgressError

func IsAsyncServiceBindingOperationInProgressError(err error) bool

IsAsyncServiceBindingOperationInProgressError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90008 - HTTP code: 409 - message: "An operation for the service binding between app %s and service instance %s is in progress."

func IsAsyncServiceInstanceOperationInProgressError

func IsAsyncServiceInstanceOperationInProgressError(err error) bool

IsAsyncServiceInstanceOperationInProgressError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60016 - HTTP code: 409 - message: "An operation for service instance %s is in progress."

func IsBackendSelectionNotAuthorizedError

func IsBackendSelectionNotAuthorizedError(err error) bool

IsBackendSelectionNotAuthorizedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 320005 - HTTP code: 403 - message: "You cannot select the backend on which to run this application"

func IsBadQueryParameterError

func IsBadQueryParameterError(err error) bool

IsBadQueryParameterError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10005 - HTTP code: 400 - message: "The query parameter is invalid: %s"

func IsBadRequestError

func IsBadRequestError(err error) bool

IsBadRequestError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 1004 - HTTP code: 400 - message: "Bad request: %s"

func IsBitsServiceError

func IsBitsServiceError(err error) bool

IsBitsServiceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290012 - HTTP code: 500 - message: "The bits service returned an error: %s"

func IsBlobstoreError

func IsBlobstoreError(err error) bool

IsBlobstoreError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150007 - HTTP code: 500 - message: "Failed to perform blobstore operation after three retries."

func IsBlobstoreNotLocalError

func IsBlobstoreNotLocalError(err error) bool

IsBlobstoreNotLocalError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150005 - HTTP code: 400 - message: "Downloading blobs can only be done directly to the blobstore."

func IsBlobstoreUnavailableError

func IsBlobstoreUnavailableError(err error) bool

IsBlobstoreUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150006 - HTTP code: 502 - message: "Failed to perform operation due to blobstore unavailability."

func IsBuildpackBitsUploadInvalidError

func IsBuildpackBitsUploadInvalidError(err error) bool

IsBuildpackBitsUploadInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290002 - HTTP code: 400 - message: "The buildpack upload is invalid: %s"

func IsBuildpackCompileFailedError

func IsBuildpackCompileFailedError(err error) bool

IsBuildpackCompileFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170004 - HTTP code: 400 - message: "App staging failed in the buildpack compile phase"

func IsBuildpackInvalidError

func IsBuildpackInvalidError(err error) bool

IsBuildpackInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290003 - HTTP code: 400 - message: "Buildpack is invalid: %s"

func IsBuildpackLockedError

func IsBuildpackLockedError(err error) bool

IsBuildpackLockedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290005 - HTTP code: 409 - message: "The buildpack is locked"

func IsBuildpackNameStackTakenError

func IsBuildpackNameStackTakenError(err error) bool

IsBuildpackNameStackTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290000 - HTTP code: 422 - message: "The buildpack name %s is already in use for the stack %s"

func IsBuildpackNameTakenError

func IsBuildpackNameTakenError(err error) bool

IsBuildpackNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290001 - HTTP code: 400 - message: "The buildpack name is already in use: %s"

func IsBuildpackReleaseFailedError

func IsBuildpackReleaseFailedError(err error) bool

IsBuildpackReleaseFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170005 - HTTP code: 400 - message: "App staging failed in the buildpack release phase"

func IsBuildpackStackDoesNotExistError

func IsBuildpackStackDoesNotExistError(err error) bool

IsBuildpackStackDoesNotExistError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390012 - HTTP code: 422 - message: "Uploaded buildpack stack (%s) does not exist"

func IsBuildpackStacksDontMatchError

func IsBuildpackStacksDontMatchError(err error) bool

IsBuildpackStacksDontMatchError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390011 - HTTP code: 422 - message: "Uploaded buildpack stack (%s) does not match %s"

func IsBuildpackZipError

func IsBuildpackZipError(err error) bool

IsBuildpackZipError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390013 - HTTP code: 422 - message: "Buildpack zip error: %s"

func IsCustomBuildpacksDisabledError

func IsCustomBuildpacksDisabledError(err error) bool

IsCustomBuildpacksDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290004 - HTTP code: 400 - message: "Custom buildpacks are disabled"

func IsDatabaseError

func IsDatabaseError(err error) bool

IsDatabaseError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10011 - HTTP code: 500 - message: "Database error"

func IsDeploymentsDisabledError

func IsDeploymentsDisabledError(err error) bool

IsDeploymentsDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390014 - HTTP code: 403 - message: "Deployments cannot be created due to manifest property 'temporary_disable_deployments'"

func IsDiegoDisabledError

func IsDiegoDisabledError(err error) bool

IsDiegoDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 320001 - HTTP code: 400 - message: "Diego has not been enabled."

func IsDiegoDockerBuildpackConflictError

func IsDiegoDockerBuildpackConflictError(err error) bool

IsDiegoDockerBuildpackConflictError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 320002 - HTTP code: 400 - message: "You cannot specify a custom buildpack and a docker image at the same time."

func IsDockerAppToDeaError

func IsDockerAppToDeaError(err error) bool

IsDockerAppToDeaError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60026 - HTTP code: 400 - message: "Docker apps cannot run on DEAs"

func IsDockerDisabledError

func IsDockerDisabledError(err error) bool

IsDockerDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 320003 - HTTP code: 400 - message: "Docker support has not been enabled."

func IsDockerImageMissingError

func IsDockerImageMissingError(err error) bool

IsDockerImageMissingError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150008 - HTTP code: 400 - message: "Docker credentials can only be supplied for apps with a 'docker_image'"

func IsDomainInvalidError

func IsDomainInvalidError(err error) bool

IsDomainInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130001 - HTTP code: 400 - message: "The domain is invalid: %s"

func IsDomainNameTakenError

func IsDomainNameTakenError(err error) bool

IsDomainNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130003 - HTTP code: 400 - message: "The domain name is taken: %s"

func IsDomainNotFoundError

func IsDomainNotFoundError(err error) bool

IsDomainNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130002 - HTTP code: 404 - message: "The domain could not be found: %s"

func IsDropletUploadInvalidError

func IsDropletUploadInvalidError(err error) bool

IsDropletUploadInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 380002 - HTTP code: 400 - message: "The droplet upload is invalid: %s"

func IsEiriniLRPError

func IsEiriniLRPError(err error) bool

IsEiriniLRPError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 410001 - HTTP code: 422 - message: "Failed to %s LRP resource: '%s'"

func IsEnvironmentVariableGroupInvalidError

func IsEnvironmentVariableGroupInvalidError(err error) bool

IsEnvironmentVariableGroupInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 380001 - HTTP code: 400 - message: "The Environment Variable Group is invalid: %s"

func IsEventNotFoundError

func IsEventNotFoundError(err error) bool

IsEventNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 230002 - HTTP code: 404 - message: "Event could not be found: %s"

func IsFeatureDisabledError

func IsFeatureDisabledError(err error) bool

IsFeatureDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 330002 - HTTP code: 403 - message: "Feature Disabled: %s"

func IsFeatureFlagInvalidError

func IsFeatureFlagInvalidError(err error) bool

IsFeatureFlagInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 330001 - HTTP code: 400 - message: "The feature flag is invalid: %s"

func IsFeatureFlagNotFoundError

func IsFeatureFlagNotFoundError(err error) bool

IsFeatureFlagNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 330000 - HTTP code: 404 - message: "The feature flag could not be found: %s"

func IsFileError

func IsFileError(err error) bool

IsFileError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 190001 - HTTP code: 400 - message: "File error: %s"

func IsFrameworkInvalidError

func IsFrameworkInvalidError(err error) bool

IsFrameworkInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 80001 - HTTP code: 400 - message: "The framework is invalid: %s"

func IsFrameworkNameTakenError

func IsFrameworkNameTakenError(err error) bool

IsFrameworkNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 80002 - HTTP code: 400 - message: "The framework name is taken: %s"

func IsFrameworkNotFoundError

func IsFrameworkNotFoundError(err error) bool

IsFrameworkNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 80003 - HTTP code: 404 - message: "The framework could not be found: %s"

func IsIPBasedRateLimitExceededError

func IsIPBasedRateLimitExceededError(err error) bool

IsIPBasedRateLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10014 - HTTP code: 429 - message: "Rate Limit Exceeded: Unauthenticated requests from this IP address have exceeded the limit. Please log in."

func IsInstancesError

func IsInstancesError(err error) bool

IsInstancesError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 220001 - HTTP code: 400 - message: "Instances error: %s"

func IsInstancesUnavailableError

func IsInstancesUnavailableError(err error) bool

IsInstancesUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 220002 - HTTP code: 503 - message: "Instances information unavailable: %s"

func IsInsufficientResourcesError

func IsInsufficientResourcesError(err error) bool

IsInsufficientResourcesError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170008 - HTTP code: 400 - message: "Insufficient resources"

func IsInsufficientRunningResourcesAvailableError

func IsInsufficientRunningResourcesAvailableError(err error) bool

IsInsufficientRunningResourcesAvailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150003 - HTTP code: 503 - message: "One or more instances could not be started because of insufficient running resources."

func IsInsufficientScopeError

func IsInsufficientScopeError(err error) bool

IsInsufficientScopeError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10007 - HTTP code: 403 - message: "Your token lacks the necessary scopes to access this resource."

func IsInternalDomainCannotBeDeletedError

func IsInternalDomainCannotBeDeletedError(err error) bool

IsInternalDomainCannotBeDeletedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130009 - HTTP code: 422 - message: "The domain '%s' cannot be deleted. It is reserved by the platform."

func IsInvalidAuthTokenError

func IsInvalidAuthTokenError(err error) bool

IsInvalidAuthTokenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 1000 - HTTP code: 401 - message: "Invalid Auth Token"

func IsInvalidContentTypeError

func IsInvalidContentTypeError(err error) bool

IsInvalidContentTypeError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 1003 - HTTP code: 400 - message: "Invalid content type, expected: %s"

func IsInvalidLoggingServiceBindingError

func IsInvalidLoggingServiceBindingError(err error) bool

IsInvalidLoggingServiceBindingError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90006 - HTTP code: 502 - message: "The service is attempting to stream logs from your application, but is not registered as a logging service. Please contact the service provider."

func IsInvalidRelationError

func IsInvalidRelationError(err error) bool

IsInvalidRelationError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 1002 - HTTP code: 400 - message: "%s"

func IsInvalidRequestError

func IsInvalidRequestError(err error) bool

IsInvalidRequestError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10004 - HTTP code: 400 - message: "The request is invalid"

func IsInvalidTaskAddressError

func IsInvalidTaskAddressError(err error) bool

IsInvalidTaskAddressError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170018 - HTTP code: 500 - message: "Invalid config: %s"

func IsInvalidTaskRequestError

func IsInvalidTaskRequestError(err error) bool

IsInvalidTaskRequestError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170021 - HTTP code: 422 - message: "The task request is invalid: %s"

func IsJobTimeoutError

func IsJobTimeoutError(err error) bool

IsJobTimeoutError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290006 - HTTP code: 524 - message: "The job execution has timed out."

func IsKpackBuilderError

func IsKpackBuilderError(err error) bool

IsKpackBuilderError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 400003 - HTTP code: 422 - message: "Failed to %s Builder resource: '%s'"

func IsKpackImageError

func IsKpackImageError(err error) bool

IsKpackImageError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 400002 - HTTP code: 422 - message: "Failed to %s Image resource for staging: '%s'"

func IsKubernetesRouteResourceError

func IsKubernetesRouteResourceError(err error) bool

IsKubernetesRouteResourceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 400001 - HTTP code: 422 - message: "Failed to create/update/delete Route resource with guid '%s' on Kubernetes"

func IsLabelLimitExceededError

func IsLabelLimitExceededError(err error) bool

IsLabelLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390020 - HTTP code: 422 - message: "Failed to add %d labels because it would exceed maximum of %d"

func IsLastBillingManagerInOrgError

func IsLastBillingManagerInOrgError(err error) bool

IsLastBillingManagerInOrgError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 30005 - HTTP code: 403 - message: "Cannot remove last Billing Manager in org"

func IsLastManagerInOrgError

func IsLastManagerInOrgError(err error) bool

IsLastManagerInOrgError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 30004 - HTTP code: 403 - message: "Cannot remove last Org Manager in org"

func IsLastUserInOrgError

func IsLastUserInOrgError(err error) bool

IsLastUserInOrgError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 30006 - HTTP code: 403 - message: "Cannot remove last User in org"

func IsLegacyApiWithoutDefaultSpaceError

func IsLegacyApiWithoutDefaultSpaceError(err error) bool

IsLegacyApiWithoutDefaultSpaceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 140001 - HTTP code: 400 - message: "A legacy api call requiring a default app space was called, but no default app space is set for the user."

func IsMaintenanceInfoConflictError

func IsMaintenanceInfoConflictError(err error) bool

IsMaintenanceInfoConflictError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390009 - HTTP code: 422 - message: "maintenance_info.version requested is invalid. Please ensure the catalog is up to date and you are providing a version supported by this service plan."

func IsMaintenanceInfoNotSemverError

func IsMaintenanceInfoNotSemverError(err error) bool

IsMaintenanceInfoNotSemverError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390007 - HTTP code: 422 - message: "maintenance_info.version should be a semantic version."

func IsMaintenanceInfoNotSupportedError

func IsMaintenanceInfoNotSupportedError(err error) bool

IsMaintenanceInfoNotSupportedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390006 - HTTP code: 422 - message: "The service broker does not support upgrades for service instances created from this plan."

func IsMaintenanceInfoNotUpdatableWhenChangingPlanError

func IsMaintenanceInfoNotUpdatableWhenChangingPlanError(err error) bool

IsMaintenanceInfoNotUpdatableWhenChangingPlanError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390008 - HTTP code: 422 - message: "maintenance_info should not be changed when switching to different plan."

func IsManagedServiceInstanceNotFoundError

func IsManagedServiceInstanceNotFoundError(err error) bool

IsManagedServiceInstanceNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60028 - HTTP code: 404 - message: "The service instance could not be found: %s"

func IsMessageParseError

func IsMessageParseError(err error) bool

IsMessageParseError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 1001 - HTTP code: 400 - message: "Request invalid due to parse error: %s"

func IsMultipleAppPortsMappedDiegoToDeaError

func IsMultipleAppPortsMappedDiegoToDeaError(err error) bool

IsMultipleAppPortsMappedDiegoToDeaError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60024 - HTTP code: 400 - message: "The app has routes mapped to multiple ports. Multiple ports are supported for Diego only. Please unmap routes from all but one app port. Multiple routes can be mapped to the same port if desired."

func IsNoAppDetectedError

func IsNoAppDetectedError(err error) bool

IsNoAppDetectedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170003 - HTTP code: 400 - message: "An app was not successfully detected by any available buildpack"

func IsNoBuildpacksFoundError

func IsNoBuildpacksFoundError(err error) bool

IsNoBuildpacksFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170006 - HTTP code: 400 - message: "There are no buildpacks available"

func IsNoCompatibleCellError

func IsNoCompatibleCellError(err error) bool

IsNoCompatibleCellError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170009 - HTTP code: 400 - message: "Found no compatible cell"

func IsNoCurrentEncryptionKeyError

func IsNoCurrentEncryptionKeyError(err error) bool

IsNoCurrentEncryptionKeyError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390015 - HTTP code: 422 - message: "Please set the desired encryption key in the manifest at ‘cc.database_encryption.current_key_label’"

func IsNonrecursiveSpaceDeletionFailedError

func IsNonrecursiveSpaceDeletionFailedError(err error) bool

IsNonrecursiveSpaceDeletionFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290011 - HTTP code: 400 - message: "Resource inside space %s must first be deleted, or specify recursive delete."

func IsNotAuthenticatedError

func IsNotAuthenticatedError(err error) bool

IsNotAuthenticatedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10002 - HTTP code: 401 - message: "Authentication error"

func IsNotAuthorizedError

func IsNotAuthorizedError(err error) bool

IsNotAuthorizedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10003 - HTTP code: 403 - message: "You are not authorized to perform the requested action"

func IsNotFoundError

func IsNotFoundError(err error) bool

IsNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10000 - HTTP code: 404 - message: "Unknown request"

func IsNotStagedError

func IsNotStagedError(err error) bool

IsNotStagedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170002 - HTTP code: 400 - message: "App has not finished staging"

func IsOrderByParameterInvalidError

func IsOrderByParameterInvalidError(err error) bool

IsOrderByParameterInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10012 - HTTP code: 500 - message: "Cannot order by: %s"

func IsOrgQuotaTotalReservedRoutePortsExceededError

func IsOrgQuotaTotalReservedRoutePortsExceededError(err error) bool

IsOrgQuotaTotalReservedRoutePortsExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310009 - HTTP code: 400 - message: "You have exceeded the total reserved route ports for your organization's quota."

func IsOrgQuotaTotalRoutesExceededError

func IsOrgQuotaTotalRoutesExceededError(err error) bool

IsOrgQuotaTotalRoutesExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310006 - HTTP code: 400 - message: "You have exceeded the total routes for your organization's quota."

func IsOrganizationAlreadySetError

func IsOrganizationAlreadySetError(err error) bool

IsOrganizationAlreadySetError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 30007 - HTTP code: 400 - message: "Cannot change organization"

func IsOrganizationDeleteTimeoutError

func IsOrganizationDeleteTimeoutError(err error) bool

IsOrganizationDeleteTimeoutError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290009 - HTTP code: 524 - message: "Delete of organization %s timed out before all resources within could be deleted"

func IsOrganizationDeletionFailedError

func IsOrganizationDeletionFailedError(err error) bool

IsOrganizationDeletionFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290010 - HTTP code: 502 - message: "Deletion of organization %s failed because one or more resources within could not be deleted.\n\n%s"

func IsOrganizationInvalidError

func IsOrganizationInvalidError(err error) bool

IsOrganizationInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 30001 - HTTP code: 400 - message: "The organization info is invalid: %s"

func IsOrganizationNameTakenError

func IsOrganizationNameTakenError(err error) bool

IsOrganizationNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 30002 - HTTP code: 400 - message: "The organization name is taken: %s"

func IsOrganizationNotFoundError

func IsOrganizationNotFoundError(err error) bool

IsOrganizationNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 30003 - HTTP code: 404 - message: "The organization could not be found: %s"

func IsOrganizationRolesDeletionFailedError

func IsOrganizationRolesDeletionFailedError(err error) bool

IsOrganizationRolesDeletionFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290014 - HTTP code: 502 - message: "Failed to delete one or more roles for organization %s"

func IsOutOfRouterGroupPortsError

func IsOutOfRouterGroupPortsError(err error) bool

IsOutOfRouterGroupPortsError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 21008 - HTTP code: 403 - message: "There are no more ports available for router group: %s. Please contact your administrator for more information."

func IsPackageBitsAlreadyUploadedError

func IsPackageBitsAlreadyUploadedError(err error) bool

IsPackageBitsAlreadyUploadedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 150004 - HTTP code: 400 - message: "Bits may be uploaded only once. Create a new package to upload different bits."

func IsPathInvalidError

func IsPathInvalidError(err error) bool

IsPathInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130004 - HTTP code: 400 - message: "The path is invalid: %s"

func IsPreviouslyUsedAs_ServiceInstancePaidQuotaExceededError

func IsPreviouslyUsedAs_ServiceInstancePaidQuotaExceededError(err error) bool

IsPreviouslyUsedAs_ServiceInstancePaidQuotaExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60006 - HTTP code: 400 - message: "You have exceeded your organization's services limit."

func IsProcessInvalidError

func IsProcessInvalidError(err error) bool

IsProcessInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 350001 - HTTP code: 400 - message: "The process is invalid: %s"

func IsProcessNotFoundError

func IsProcessNotFoundError(err error) bool

IsProcessNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 350003 - HTTP code: 404 - message: "The process could not be found: %s"

func IsProcessUpdateDisabledDuringDeploymentError

func IsProcessUpdateDisabledDuringDeploymentError(err error) bool

IsProcessUpdateDisabledDuringDeploymentError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390017 - HTTP code: 422 - message: "Cannot update this process while a deployment is in flight."

func IsQuotaDefinitionInvalidError

func IsQuotaDefinitionInvalidError(err error) bool

IsQuotaDefinitionInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 240003 - HTTP code: 400 - message: "Quota Definition is invalid: %s"

func IsQuotaDefinitionMemoryLimitInvalidError

func IsQuotaDefinitionMemoryLimitInvalidError(err error) bool

IsQuotaDefinitionMemoryLimitInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 240004 - HTTP code: 400 - message: "Quota Definition memory limit cannot be less than -1"

func IsQuotaDefinitionNameTakenError

func IsQuotaDefinitionNameTakenError(err error) bool

IsQuotaDefinitionNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 240002 - HTTP code: 400 - message: "Quota Definition is taken: %s"

func IsQuotaDefinitionNotFoundError

func IsQuotaDefinitionNotFoundError(err error) bool

IsQuotaDefinitionNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 240001 - HTTP code: 404 - message: "Quota Definition could not be found: %s"

func IsQuotaInstanceLimitExceededError

func IsQuotaInstanceLimitExceededError(err error) bool

IsQuotaInstanceLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100008 - HTTP code: 400 - message: "You have exceeded the instance limit for your organization's quota."

func IsQuotaInstanceMemoryLimitExceededError

func IsQuotaInstanceMemoryLimitExceededError(err error) bool

IsQuotaInstanceMemoryLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 100007 - HTTP code: 400 - message: "You have exceeded the instance memory limit for your organization's quota."

func IsRateLimitExceededError

func IsRateLimitExceededError(err error) bool

IsRateLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10013 - HTTP code: 429 - message: "Rate Limit Exceeded"

func IsResourceNotFoundError

func IsResourceNotFoundError(err error) bool

IsResourceNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10010 - HTTP code: 404 - message: "%s"

func IsRevisionsEnabledError

func IsRevisionsEnabledError(err error) bool

IsRevisionsEnabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 320006 - HTTP code: 400 - message: "V2 restaging is disabled when your app has revisions enabled"

func IsRouteAlreadyBoundToServiceInstanceError

func IsRouteAlreadyBoundToServiceInstanceError(err error) bool

IsRouteAlreadyBoundToServiceInstanceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130007 - HTTP code: 400 - message: "A route may only be bound to a single service instance"

func IsRouteHostTakenError

func IsRouteHostTakenError(err error) bool

IsRouteHostTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210003 - HTTP code: 400 - message: "The host is taken: %s"

func IsRouteInvalidError

func IsRouteInvalidError(err error) bool

IsRouteInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210001 - HTTP code: 400 - message: "The route is invalid: %s"

func IsRouteMappingNotFoundError

func IsRouteMappingNotFoundError(err error) bool

IsRouteMappingNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210007 - HTTP code: 404 - message: "The route mapping could not be found: %s"

func IsRouteMappingTakenError

func IsRouteMappingTakenError(err error) bool

IsRouteMappingTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210006 - HTTP code: 400 - message: "The route mapping is taken: %s"

func IsRouteNotFoundError

func IsRouteNotFoundError(err error) bool

IsRouteNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210002 - HTTP code: 404 - message: "The route could not be found: %s"

func IsRoutePathTakenError

func IsRoutePathTakenError(err error) bool

IsRoutePathTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210004 - HTTP code: 400 - message: "The path is taken: %s"

func IsRoutePortNotEnabledOnAppError

func IsRoutePortNotEnabledOnAppError(err error) bool

IsRoutePortNotEnabledOnAppError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60023 - HTTP code: 400 - message: "Routes can only be mapped to ports already enabled for the application."

func IsRoutePortTakenError

func IsRoutePortTakenError(err error) bool

IsRoutePortTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210005 - HTTP code: 400 - message: "The port is taken: %s"

func IsRouteServiceCannotBeBoundToInternalRouteError

func IsRouteServiceCannotBeBoundToInternalRouteError(err error) bool

IsRouteServiceCannotBeBoundToInternalRouteError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130010 - HTTP code: 400 - message: "Route services cannot be bound to internal routes."

func IsRouterGroupNotFoundError

func IsRouterGroupNotFoundError(err error) bool

IsRouterGroupNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 210009 - HTTP code: 404 - message: "The router group could not be found: %s"

func IsRoutingApiDisabledError

func IsRoutingApiDisabledError(err error) bool

IsRoutingApiDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 370003 - HTTP code: 403 - message: "Routing API is disabled"

func IsRoutingApiUnavailableError

func IsRoutingApiUnavailableError(err error) bool

IsRoutingApiUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 370001 - HTTP code: 503 - message: "The Routing API is currently unavailable"

func IsRunnerError

func IsRunnerError(err error) bool

IsRunnerError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170016 - HTTP code: 500 - message: "Runner error: %s"

func IsRunnerInvalidRequestError

func IsRunnerInvalidRequestError(err error) bool

IsRunnerInvalidRequestError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170014 - HTTP code: 500 - message: "Runner invalid request: %s"

func IsRunnerUnavailableError

func IsRunnerUnavailableError(err error) bool

IsRunnerUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170015 - HTTP code: 503 - message: "Runner is unavailable: %s"

func IsRuntimeInvalidError

func IsRuntimeInvalidError(err error) bool

IsRuntimeInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 70001 - HTTP code: 400 - message: "The runtime is invalid: %s"

func IsRuntimeNameTakenError

func IsRuntimeNameTakenError(err error) bool

IsRuntimeNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 70002 - HTTP code: 400 - message: "The runtime name is taken: %s"

func IsRuntimeNotFoundError

func IsRuntimeNotFoundError(err error) bool

IsRuntimeNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 70003 - HTTP code: 404 - message: "The runtime could not be found: %s"

func IsSDSNotAvailableError

func IsSDSNotAvailableError(err error) bool

IsSDSNotAvailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 180004 - HTTP code: 501 - message: "No serialization service backends available"

func IsScaleDisabledDuringDeploymentError

func IsScaleDisabledDuringDeploymentError(err error) bool

IsScaleDisabledDuringDeploymentError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390016 - HTTP code: 422 - message: "Cannot scale this process while a deployment is in flight."

func IsSecurityGroupInvalidError

func IsSecurityGroupInvalidError(err error) bool

IsSecurityGroupInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 300001 - HTTP code: 400 - message: "The security group is invalid: %s"

func IsSecurityGroupNameTakenError

func IsSecurityGroupNameTakenError(err error) bool

IsSecurityGroupNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 300005 - HTTP code: 400 - message: "The security group name is taken: %s"

func IsSecurityGroupNotFoundError

func IsSecurityGroupNotFoundError(err error) bool

IsSecurityGroupNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 300002 - HTTP code: 404 - message: "The security group could not be found: %s"

func IsSecurityGroupRunningDefaultInvalidError

func IsSecurityGroupRunningDefaultInvalidError(err error) bool

IsSecurityGroupRunningDefaultInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 300004 - HTTP code: 400 - message: "The security group could not be found: %s"

func IsSecurityGroupStagingDefaultInvalidError

func IsSecurityGroupStagingDefaultInvalidError(err error) bool

IsSecurityGroupStagingDefaultInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 300003 - HTTP code: 400 - message: "The security group could not be found: %s"

func IsServerError

func IsServerError(err error) bool

IsServerError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10001 - HTTP code: 500 - message: "Server error"

func IsServiceBindingAppServiceTakenError

func IsServiceBindingAppServiceTakenError(err error) bool

IsServiceBindingAppServiceTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90003 - HTTP code: 400 - message: "%s"

func IsServiceBindingDifferentSpacesError

func IsServiceBindingDifferentSpacesError(err error) bool

IsServiceBindingDifferentSpacesError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90002 - HTTP code: 400 - message: "The app and the service are not in the same app space: %s"

func IsServiceBindingInvalidError

func IsServiceBindingInvalidError(err error) bool

IsServiceBindingInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90001 - HTTP code: 400 - message: "The service binding is invalid: %s"

func IsServiceBindingNotFoundError

func IsServiceBindingNotFoundError(err error) bool

IsServiceBindingNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90004 - HTTP code: 404 - message: "The service binding could not be found: %s"

func IsServiceBrokerAsyncRequiredError

func IsServiceBrokerAsyncRequiredError(err error) bool

IsServiceBrokerAsyncRequiredError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270014 - HTTP code: 400 - message: "This service plan requires client support for asynchronous service operations."

func IsServiceBrokerCatalogIncompatibleError

func IsServiceBrokerCatalogIncompatibleError(err error) bool

IsServiceBrokerCatalogIncompatibleError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270019 - HTTP code: 502 - message: "Service broker catalog is incompatible: %s"

func IsServiceBrokerCatalogInvalidError

func IsServiceBrokerCatalogInvalidError(err error) bool

IsServiceBrokerCatalogInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270012 - HTTP code: 502 - message: "Service broker catalog is invalid: %s"

func IsServiceBrokerConcurrencyError

func IsServiceBrokerConcurrencyError(err error) bool

IsServiceBrokerConcurrencyError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270018 - HTTP code: 422 - message: "The service broker could not perform this operation in parallel with other running operations"

func IsServiceBrokerDashboardClientFailureError

func IsServiceBrokerDashboardClientFailureError(err error) bool

IsServiceBrokerDashboardClientFailureError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270013 - HTTP code: 502 - message: "Service broker dashboard clients could not be modified: %s"

func IsServiceBrokerInvalidError

func IsServiceBrokerInvalidError(err error) bool

IsServiceBrokerInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270001 - HTTP code: 400 - message: "Service broker is invalid: %s"

func IsServiceBrokerNameTakenError

func IsServiceBrokerNameTakenError(err error) bool

IsServiceBrokerNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270002 - HTTP code: 400 - message: "The service broker name is taken"

func IsServiceBrokerNotFoundError

func IsServiceBrokerNotFoundError(err error) bool

IsServiceBrokerNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270004 - HTTP code: 404 - message: "The service broker was not found: %s"

func IsServiceBrokerNotRemovableError

func IsServiceBrokerNotRemovableError(err error) bool

IsServiceBrokerNotRemovableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270010 - HTTP code: 400 - message: "Can not remove brokers that have associated service instances: %s"

func IsServiceBrokerRateLimitExceededError

func IsServiceBrokerRateLimitExceededError(err error) bool

IsServiceBrokerRateLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10016 - HTTP code: 429 - message: "Service broker concurrent request limit exceeded"

func IsServiceBrokerRequestMalformedError

func IsServiceBrokerRequestMalformedError(err error) bool

IsServiceBrokerRequestMalformedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270021 - HTTP code: 502 - message: "The service broker returned an invalid response: expected valid JSON object in body. Please check that the URL points to a valid service broker."

func IsServiceBrokerRequestRejectedError

func IsServiceBrokerRequestRejectedError(err error) bool

IsServiceBrokerRequestRejectedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270020 - HTTP code: 502 - message: "The service broker rejected the request. Status Code: %s. Please check that the URL points to a valid service broker."

func IsServiceBrokerRespondedAsyncWhenNotAllowedError

func IsServiceBrokerRespondedAsyncWhenNotAllowedError(err error) bool

IsServiceBrokerRespondedAsyncWhenNotAllowedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270017 - HTTP code: 502 - message: "The service broker responded asynchronously to a request, but the accepts_incomplete query parameter was false or not given."

func IsServiceBrokerUrlBasicAuthNotSupportedError

func IsServiceBrokerUrlBasicAuthNotSupportedError(err error) bool

IsServiceBrokerUrlBasicAuthNotSupportedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270016 - HTTP code: 400 - message: "User name and password fields in the broker URI are not supported"

func IsServiceBrokerUrlInvalidError

func IsServiceBrokerUrlInvalidError(err error) bool

IsServiceBrokerUrlInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270011 - HTTP code: 400 - message: "%s is not a valid URL"

func IsServiceBrokerUrlTakenError

func IsServiceBrokerUrlTakenError(err error) bool

IsServiceBrokerUrlTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270003 - HTTP code: 400 - message: "The service broker url is taken: %s"

func IsServiceDashboardClientMissingUrlError

func IsServiceDashboardClientMissingUrlError(err error) bool

IsServiceDashboardClientMissingUrlError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 270015 - HTTP code: 502 - message: "Service broker returned dashboard client configuration without a dashboard URL"

func IsServiceDoesNotSupportRoutesError

func IsServiceDoesNotSupportRoutesError(err error) bool

IsServiceDoesNotSupportRoutesError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130006 - HTTP code: 400 - message: "This service does not support route binding."

func IsServiceFetchBindingParametersNotSupportedError

func IsServiceFetchBindingParametersNotSupportedError(err error) bool

IsServiceFetchBindingParametersNotSupportedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90007 - HTTP code: 400 - message: "This service does not support fetching service binding parameters."

func IsServiceFetchInstanceParametersNotSupportedError

func IsServiceFetchInstanceParametersNotSupportedError(err error) bool

IsServiceFetchInstanceParametersNotSupportedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 120004 - HTTP code: 400 - message: "This service does not support fetching service instance parameters."

func IsServiceGatewayError

func IsServiceGatewayError(err error) bool

IsServiceGatewayError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 180002 - HTTP code: 503 - message: "Service gateway internal error: %s"

func IsServiceInstanceAlreadyBoundToSameRouteError

func IsServiceInstanceAlreadyBoundToSameRouteError(err error) bool

IsServiceInstanceAlreadyBoundToSameRouteError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130008 - HTTP code: 400 - message: "The route and service instance are already bound."

func IsServiceInstanceDeletionSharesExistsError

func IsServiceInstanceDeletionSharesExistsError(err error) bool

IsServiceInstanceDeletionSharesExistsError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390002 - HTTP code: 422 - message: "Service instances must be unshared before they can be deleted. Unsharing %s will automatically delete any bindings that have been made to applications in other spaces."

func IsServiceInstanceDeprovisionFailedError

func IsServiceInstanceDeprovisionFailedError(err error) bool

IsServiceInstanceDeprovisionFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60011 - HTTP code: 409 - message: "The service broker reported an error during deprovisioning: %s"

func IsServiceInstanceDuplicateNotAllowedError

func IsServiceInstanceDuplicateNotAllowedError(err error) bool

IsServiceInstanceDuplicateNotAllowedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60008 - HTTP code: 400 - message: "An instance of this service is already present in this space. Some services only support one instance per space."

func IsServiceInstanceInvalidError

func IsServiceInstanceInvalidError(err error) bool

IsServiceInstanceInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60003 - HTTP code: 400 - message: "The service instance is invalid: %s"

func IsServiceInstanceNameEmptyError

func IsServiceInstanceNameEmptyError(err error) bool

IsServiceInstanceNameEmptyError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60001 - HTTP code: 400 - message: "Service instance name is required."

func IsServiceInstanceNameTakenError

func IsServiceInstanceNameTakenError(err error) bool

IsServiceInstanceNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60002 - HTTP code: 400 - message: "The service instance name is taken: %s"

func IsServiceInstanceNameTooLongError

func IsServiceInstanceNameTooLongError(err error) bool

IsServiceInstanceNameTooLongError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60009 - HTTP code: 400 - message: "You have requested an invalid service instance name. Names are limited to 255 characters."

func IsServiceInstanceNotFoundError

func IsServiceInstanceNotFoundError(err error) bool

IsServiceInstanceNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60004 - HTTP code: 404 - message: "The service instance could not be found: %s"

func IsServiceInstanceOrganizationNotAuthorizedError

func IsServiceInstanceOrganizationNotAuthorizedError(err error) bool

IsServiceInstanceOrganizationNotAuthorizedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60010 - HTTP code: 403 - message: "A service instance for the selected plan cannot be created in this organization. The plan is visible because another organization you belong to has access to it."

func IsServiceInstanceProvisionFailedError

func IsServiceInstanceProvisionFailedError(err error) bool

IsServiceInstanceProvisionFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60030 - HTTP code: 400 - message: "The service broker reported an error during provisioning: %s"

func IsServiceInstanceQuotaExceededError

func IsServiceInstanceQuotaExceededError(err error) bool

IsServiceInstanceQuotaExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60005 - HTTP code: 400 - message: "You have exceeded your organization's services limit."

func IsServiceInstanceRecursiveDeleteFailedError

func IsServiceInstanceRecursiveDeleteFailedError(err error) bool

IsServiceInstanceRecursiveDeleteFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60027 - HTTP code: 502 - message: "Deletion of service instance %s failed because one or more associated resources could not be deleted.\n\n%s"

func IsServiceInstanceRouteBindingSpaceMismatchError

func IsServiceInstanceRouteBindingSpaceMismatchError(err error) bool

IsServiceInstanceRouteBindingSpaceMismatchError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60017 - HTTP code: 400 - message: "The service instance and the route are in different spaces."

func IsServiceInstanceRouteServiceDisabledError

func IsServiceInstanceRouteServiceDisabledError(err error) bool

IsServiceInstanceRouteServiceDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60021 - HTTP code: 403 - message: "Support for route services is disabled"

func IsServiceInstanceRouteServiceRequiresDiegoError

func IsServiceInstanceRouteServiceRequiresDiegoError(err error) bool

IsServiceInstanceRouteServiceRequiresDiegoError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60020 - HTTP code: 400 - message: "Route services are only supported for apps on Diego. Unbind the service instance from the route or enable Diego for the app."

func IsServiceInstanceRouteServiceURLInvalidError

func IsServiceInstanceRouteServiceURLInvalidError(err error) bool

IsServiceInstanceRouteServiceURLInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60019 - HTTP code: 400 - message: "The route service URL is invalid: %s"

func IsServiceInstanceServicePlanNotAllowedBySpaceQuotaError

func IsServiceInstanceServicePlanNotAllowedBySpaceQuotaError(err error) bool

IsServiceInstanceServicePlanNotAllowedBySpaceQuotaError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60013 - HTTP code: 400 - message: "The service instance cannot be created because paid service plans are not allowed for your space."

func IsServiceInstanceServicePlanNotAllowedError

func IsServiceInstanceServicePlanNotAllowedError(err error) bool

IsServiceInstanceServicePlanNotAllowedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60007 - HTTP code: 400 - message: "The service instance cannot be created because paid service plans are not allowed."

func IsServiceInstanceSpaceChangeNotAllowedError

func IsServiceInstanceSpaceChangeNotAllowedError(err error) bool

IsServiceInstanceSpaceChangeNotAllowedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60014 - HTTP code: 400 - message: "Cannot update space for service instance."

func IsServiceInstanceSpaceNotAuthorizedError

func IsServiceInstanceSpaceNotAuthorizedError(err error) bool

IsServiceInstanceSpaceNotAuthorizedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60018 - HTTP code: 403 - message: "A service instance for the selected plan cannot be created in this space."

func IsServiceInstanceSpaceQuotaExceededError

func IsServiceInstanceSpaceQuotaExceededError(err error) bool

IsServiceInstanceSpaceQuotaExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60012 - HTTP code: 400 - message: "You have exceeded your space's services limit."

func IsServiceInstanceTagsTooLongError

func IsServiceInstanceTagsTooLongError(err error) bool

IsServiceInstanceTagsTooLongError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60015 - HTTP code: 400 - message: "Combined length of tags for service %s must be 2048 characters or less."

func IsServiceInstanceUnshareFailedError

func IsServiceInstanceUnshareFailedError(err error) bool

IsServiceInstanceUnshareFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390001 - HTTP code: 502 - message: "Unshare of service instance failed: \n\n%s"

func IsServiceInstanceWithInaccessiblePlanNotUpdateableError

func IsServiceInstanceWithInaccessiblePlanNotUpdateableError(err error) bool

IsServiceInstanceWithInaccessiblePlanNotUpdateableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60029 - HTTP code: 403 - message: "Cannot update %s of a service instance that belongs to inaccessible plan"

func IsServiceInvalidError

func IsServiceInvalidError(err error) bool

IsServiceInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 120001 - HTTP code: 400 - message: "The service is invalid: %s"

func IsServiceKeyCredentialStoreUnavailableError

func IsServiceKeyCredentialStoreUnavailableError(err error) bool

IsServiceKeyCredentialStoreUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 360005 - HTTP code: 503 - message: "Credential store is unavailable"

func IsServiceKeyInvalidError

func IsServiceKeyInvalidError(err error) bool

IsServiceKeyInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 360002 - HTTP code: 400 - message: "The service key is invalid: %s"

func IsServiceKeyNameTakenError

func IsServiceKeyNameTakenError(err error) bool

IsServiceKeyNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 360001 - HTTP code: 400 - message: "The service key name is taken: %s"

func IsServiceKeyNotFoundError

func IsServiceKeyNotFoundError(err error) bool

IsServiceKeyNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 360003 - HTTP code: 404 - message: "The service key could not be found: %s"

func IsServiceKeyNotSupportedError

func IsServiceKeyNotSupportedError(err error) bool

IsServiceKeyNotSupportedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 360004 - HTTP code: 400 - message: "%s"

func IsServiceLabelTakenError

func IsServiceLabelTakenError(err error) bool

IsServiceLabelTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 120002 - HTTP code: 400 - message: "The service label is taken: %s"

func IsServiceNotFoundError

func IsServiceNotFoundError(err error) bool

IsServiceNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 120003 - HTTP code: 404 - message: "The service could not be found: %s"

func IsServiceNotImplementedError

func IsServiceNotImplementedError(err error) bool

IsServiceNotImplementedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 180003 - HTTP code: 501 - message: "Operation not supported for service"

func IsServicePlanInvalidError

func IsServicePlanInvalidError(err error) bool

IsServicePlanInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 110001 - HTTP code: 400 - message: "The service plan is invalid: %s"

func IsServicePlanNameTakenError

func IsServicePlanNameTakenError(err error) bool

IsServicePlanNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 110002 - HTTP code: 400 - message: "The service plan name is taken: %s"

func IsServicePlanNotFoundError

func IsServicePlanNotFoundError(err error) bool

IsServicePlanNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 110003 - HTTP code: 404 - message: "The service plan could not be found: %s"

func IsServicePlanNotUpdateableError

func IsServicePlanNotUpdateableError(err error) bool

IsServicePlanNotUpdateableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 110004 - HTTP code: 400 - message: "The service does not support changing plans."

func IsServicePlanVisibilityAlreadyExistsError

func IsServicePlanVisibilityAlreadyExistsError(err error) bool

IsServicePlanVisibilityAlreadyExistsError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 260002 - HTTP code: 400 - message: "This combination of ServicePlan and Organization is already taken: %s"

func IsServicePlanVisibilityInvalidError

func IsServicePlanVisibilityInvalidError(err error) bool

IsServicePlanVisibilityInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 260001 - HTTP code: 400 - message: "Service Plan Visibility is invalid: %s"

func IsServicePlanVisibilityNotFoundError

func IsServicePlanVisibilityNotFoundError(err error) bool

IsServicePlanVisibilityNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 260003 - HTTP code: 404 - message: "The service plan visibility could not be found: %s"

func IsServiceUnavailableError

func IsServiceUnavailableError(err error) bool

IsServiceUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10015 - HTTP code: 503 - message: "%s"

func IsSharedServiceInstanceCannotBeRenamedError

func IsSharedServiceInstanceCannotBeRenamedError(err error) bool

IsSharedServiceInstanceCannotBeRenamedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390003 - HTTP code: 422 - message: "Service instances that have been shared cannot be renamed"

func IsSharedServiceInstanceNotDeletableInTargetSpaceError

func IsSharedServiceInstanceNotDeletableInTargetSpaceError(err error) bool

IsSharedServiceInstanceNotDeletableInTargetSpaceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390005 - HTTP code: 403 - message: "You cannot delete service instances that have been shared with you"

func IsSharedServiceInstanceNotUpdatableInTargetSpaceError

func IsSharedServiceInstanceNotUpdatableInTargetSpaceError(err error) bool

IsSharedServiceInstanceNotUpdatableInTargetSpaceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390004 - HTTP code: 403 - message: "You cannot update service instances that have been shared with you"

func IsSpaceDeleteTimeoutError

func IsSpaceDeleteTimeoutError(err error) bool

IsSpaceDeleteTimeoutError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290007 - HTTP code: 524 - message: "Deletion of space %s timed out before all resources within could be deleted"

func IsSpaceDeletionFailedError

func IsSpaceDeletionFailedError(err error) bool

IsSpaceDeletionFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290008 - HTTP code: 502 - message: "Deletion of space %s failed because one or more resources within could not be deleted.\n\n%s"

func IsSpaceInvalidError

func IsSpaceInvalidError(err error) bool

IsSpaceInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 40001 - HTTP code: 400 - message: "The app space info is invalid: %s"

func IsSpaceNameTakenError

func IsSpaceNameTakenError(err error) bool

IsSpaceNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 40002 - HTTP code: 400 - message: "The app space name is taken: %s"

func IsSpaceNotFoundError

func IsSpaceNotFoundError(err error) bool

IsSpaceNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 40004 - HTTP code: 404 - message: "The app space could not be found: %s"

func IsSpaceQuotaDefinitionInvalidError

func IsSpaceQuotaDefinitionInvalidError(err error) bool

IsSpaceQuotaDefinitionInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310001 - HTTP code: 400 - message: "Space Quota Definition is invalid: %s"

func IsSpaceQuotaDefinitionNameTakenError

func IsSpaceQuotaDefinitionNameTakenError(err error) bool

IsSpaceQuotaDefinitionNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310002 - HTTP code: 400 - message: "The space quota definition name is taken: %s"

func IsSpaceQuotaDefinitionNotFoundError

func IsSpaceQuotaDefinitionNotFoundError(err error) bool

IsSpaceQuotaDefinitionNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310007 - HTTP code: 404 - message: "Space Quota Definition could not be found: %s"

func IsSpaceQuotaInstanceLimitExceededError

func IsSpaceQuotaInstanceLimitExceededError(err error) bool

IsSpaceQuotaInstanceLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310008 - HTTP code: 400 - message: "You have exceeded the instance limit for your space's quota."

func IsSpaceQuotaInstanceMemoryLimitExceededError

func IsSpaceQuotaInstanceMemoryLimitExceededError(err error) bool

IsSpaceQuotaInstanceMemoryLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310004 - HTTP code: 400 - message: "You have exceeded the instance memory limit for your space's quota."

func IsSpaceQuotaMemoryLimitExceededError

func IsSpaceQuotaMemoryLimitExceededError(err error) bool

IsSpaceQuotaMemoryLimitExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310003 - HTTP code: 400 - message: "You have exceeded your space's memory limit: %s"

func IsSpaceQuotaTotalReservedRoutePortsExceededError

func IsSpaceQuotaTotalReservedRoutePortsExceededError(err error) bool

IsSpaceQuotaTotalReservedRoutePortsExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310010 - HTTP code: 400 - message: "You have exceeded the total reserved route ports for your space's quota."

func IsSpaceQuotaTotalRoutesExceededError

func IsSpaceQuotaTotalRoutesExceededError(err error) bool

IsSpaceQuotaTotalRoutesExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 310005 - HTTP code: 400 - message: "You have exceeded the total routes for your space's quota."

func IsSpaceRolesDeletionFailedError

func IsSpaceRolesDeletionFailedError(err error) bool

IsSpaceRolesDeletionFailedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290016 - HTTP code: 502 - message: "Failed to delete one or more roles for space %s"

func IsSpaceRolesDeletionTimeoutError

func IsSpaceRolesDeletionTimeoutError(err error) bool

IsSpaceRolesDeletionTimeoutError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 290013 - HTTP code: 524 - message: "Deletion of roles for space %s timed out before all roles could be deleted"

func IsSpaceUserNotInOrgError

func IsSpaceUserNotInOrgError(err error) bool

IsSpaceUserNotInOrgError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 40003 - HTTP code: 400 - message: "The app space and the user are not in the same org: %s"

func IsStackInvalidError

func IsStackInvalidError(err error) bool

IsStackInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 250001 - HTTP code: 400 - message: "The stack is invalid: %s"

func IsStackNameTakenError

func IsStackNameTakenError(err error) bool

IsStackNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 250002 - HTTP code: 400 - message: "The stack name is taken: %s"

func IsStackNotFoundError

func IsStackNotFoundError(err error) bool

IsStackNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 250003 - HTTP code: 404 - message: "The stack could not be found: %s"

func IsStagerError

func IsStagerError(err error) bool

IsStagerError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170011 - HTTP code: 500 - message: "Stager error: %s"

func IsStagerUnavailableError

func IsStagerUnavailableError(err error) bool

IsStagerUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170010 - HTTP code: 503 - message: "Stager is unavailable: %s"

func IsStagingBackendInvalidError

func IsStagingBackendInvalidError(err error) bool

IsStagingBackendInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 320004 - HTTP code: 403 - message: "The request staging completion endpoint only handles apps desired to stage on the Diego backend."

func IsStagingError

func IsStagingError(err error) bool

IsStagingError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170001 - HTTP code: 400 - message: "Staging error: %s"

func IsStagingInProgressError

func IsStagingInProgressError(err error) bool

IsStagingInProgressError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170017 - HTTP code: 422 - message: "Only one build can be STAGING at a time per application."

func IsStagingTimeExpiredError

func IsStagingTimeExpiredError(err error) bool

IsStagingTimeExpiredError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170007 - HTTP code: 504 - message: "Staging time expired: %s"

func IsStatsError

func IsStatsError(err error) bool

IsStatsError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 200001 - HTTP code: 400 - message: "Stats error: %s"

func IsStatsUnavailableError

func IsStatsUnavailableError(err error) bool

IsStatsUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 200002 - HTTP code: 503 - message: "Stats unavailable: %s"

func IsStopDisabledDuringDeploymentError

func IsStopDisabledDuringDeploymentError(err error) bool

IsStopDisabledDuringDeploymentError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390024 - HTTP code: 422 - message: "Cannot stop the app while it is deploying, please cancel the deployment before stopping the app."

func IsTaskError

func IsTaskError(err error) bool

IsTaskError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170019 - HTTP code: 500 - message: "Task failed: %s"

func IsTaskWorkersUnavailableError

func IsTaskWorkersUnavailableError(err error) bool

IsTaskWorkersUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 170020 - HTTP code: 503 - message: "Task workers are unavailable: %s"

func IsTotalPrivateDomainsExceededError

func IsTotalPrivateDomainsExceededError(err error) bool

IsTotalPrivateDomainsExceededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 130005 - HTTP code: 400 - message: "The number of private domains exceeds the quota for organization: %s"

func IsUaaEndpointDisabledError

func IsUaaEndpointDisabledError(err error) bool

IsUaaEndpointDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 20005 - HTTP code: 501 - message: "The UAA endpoint needed is disabled"

func IsUaaIdTakenError

func IsUaaIdTakenError(err error) bool

IsUaaIdTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 20002 - HTTP code: 400 - message: "The UAA ID is taken: %s"

func IsUaaUnavailableError

func IsUaaUnavailableError(err error) bool

IsUaaUnavailableError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 20004 - HTTP code: 503 - message: "The UAA service is currently unavailable"

func IsUnableToDeleteError

func IsUnableToDeleteError(err error) bool

IsUnableToDeleteError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 350002 - HTTP code: 400 - message: "Unable to perform delete action: %s"

func IsUnableToPerformError

func IsUnableToPerformError(err error) bool

IsUnableToPerformError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10009 - HTTP code: 400 - message: "%s could not be completed: %s"

func IsUnbindableServiceError

func IsUnbindableServiceError(err error) bool

IsUnbindableServiceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 90005 - HTTP code: 400 - message: "The service instance doesn't support binding."

func IsUnprocessableEntityError

func IsUnprocessableEntityError(err error) bool

IsUnprocessableEntityError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 10008 - HTTP code: 422 - message: "%s"

func IsUserInvalidError

func IsUserInvalidError(err error) bool

IsUserInvalidError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 20001 - HTTP code: 400 - message: "The user info is invalid: %s"

func IsUserIsInMultipleOriginsError

func IsUserIsInMultipleOriginsError(err error) bool

IsUserIsInMultipleOriginsError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 20006 - HTTP code: 400 - message: "The user exists in multiple origins. Specify an origin for the requested user from: %s"

func IsUserNotFoundError

func IsUserNotFoundError(err error) bool

IsUserNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 20003 - HTTP code: 404 - message: "The user could not be found: %s"

func IsUserProvidedServiceInstanceHandlerNeededError

func IsUserProvidedServiceInstanceHandlerNeededError(err error) bool

IsUserProvidedServiceInstanceHandlerNeededError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 340002 - HTTP code: 400 - message: "Please use the User Provided Services API to manage this resource."

func IsUserProvidedServiceInstanceNotFoundError

func IsUserProvidedServiceInstanceNotFoundError(err error) bool

IsUserProvidedServiceInstanceNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 340001 - HTTP code: 404 - message: "The service instance could not be found: %s"

func IsUserWithOriginNotFoundError

func IsUserWithOriginNotFoundError(err error) bool

IsUserWithOriginNotFoundError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 20007 - HTTP code: 404 - message: "The user could not be found, %s"

func IsVolumeMountServiceDisabledError

func IsVolumeMountServiceDisabledError(err error) bool

IsVolumeMountServiceDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 60025 - HTTP code: 403 - message: "Support for volume mount services is disabled"

Types

type App

type App struct {
	Guid                     string                 `json:"guid"`
	CreatedAt                string                 `json:"created_at"`
	UpdatedAt                string                 `json:"updated_at"`
	Name                     string                 `json:"name"`
	Memory                   int                    `json:"memory"`
	Instances                int                    `json:"instances"`
	DiskQuota                int                    `json:"disk_quota"`
	SpaceGuid                string                 `json:"space_guid"`
	StackGuid                string                 `json:"stack_guid"`
	State                    string                 `json:"state"`
	PackageState             string                 `json:"package_state"`
	Command                  string                 `json:"command"`
	Buildpack                string                 `json:"buildpack"`
	DetectedBuildpack        string                 `json:"detected_buildpack"`
	DetectedBuildpackGuid    string                 `json:"detected_buildpack_guid"`
	HealthCheckHttpEndpoint  string                 `json:"health_check_http_endpoint"`
	HealthCheckType          string                 `json:"health_check_type"`
	HealthCheckTimeout       int                    `json:"health_check_timeout"`
	Diego                    bool                   `json:"diego"`
	EnableSSH                bool                   `json:"enable_ssh"`
	DetectedStartCommand     string                 `json:"detected_start_command"`
	DockerImage              string                 `json:"docker_image"`
	DockerCredentialsJSON    map[string]interface{} `json:"docker_credentials_json"`
	DockerCredentials        DockerCredentials      `json:"docker_credentials"`
	Environment              map[string]interface{} `json:"environment_json"`
	StagingFailedReason      string                 `json:"staging_failed_reason"`
	StagingFailedDescription string                 `json:"staging_failed_description"`
	Ports                    []int                  `json:"ports"`
	SpaceURL                 string                 `json:"space_url"`
	SpaceData                SpaceResource          `json:"space"`
	PackageUpdatedAt         string                 `json:"package_updated_at"`
	// contains filtered or unexported fields
}

func (*App) Space

func (a *App) Space() (Space, error)

func (*App) Summary

func (a *App) Summary() (AppSummary, error)

type AppCreateRequest

type AppCreateRequest struct {
	Name      string `json:"name"`
	SpaceGuid string `json:"space_guid"`
	// Memory for the app, in MB
	Memory int `json:"memory,omitempty"`
	// Instances to startup
	Instances int `json:"instances,omitempty"`
	// Disk quota in MB
	DiskQuota int    `json:"disk_quota,omitempty"`
	StackGuid string `json:"stack_guid,omitempty"`
	// Desired state of the app. Either "STOPPED" or "STARTED"
	State AppState `json:"state,omitempty"`
	// Command to start an app
	Command string `json:"command,omitempty"`
	// Buildpack to build the app. Three options:
	// 1. Blank for autodetection
	// 2. GIT url
	// 3. Name of an installed buildpack
	Buildpack string `json:"buildpack,omitempty"`
	// Endpoint to check if an app is healthy
	HealthCheckHttpEndpoint string `json:"health_check_http_endpoint,omitempty"`
	// How to check if an app is healthy. Defaults to HEALTH_PORT if not specified
	HealthCheckType    HealthCheckType        `json:"health_check_type,omitempty"`
	HealthCheckTimeout int                    `json:"health_check_timeout,omitempty"`
	Diego              bool                   `json:"diego,omitempty"`
	EnableSSH          bool                   `json:"enable_ssh,omitempty"`
	DockerImage        string                 `json:"docker_image,omitempty"`
	DockerCredentials  DockerCredentials      `json:"docker_credentials,omitempty"`
	Environment        map[string]interface{} `json:"environment_json,omitempty"`
}

type AppEnv

type AppEnv struct {
	// These can have arbitrary JSON so need to map to interface{}
	Environment    map[string]interface{} `json:"environment_json"`
	StagingEnv     map[string]interface{} `json:"staging_env_json"`
	RunningEnv     map[string]interface{} `json:"running_env_json"`
	SystemEnv      map[string]interface{} `json:"system_env_json"`
	ApplicationEnv map[string]interface{} `json:"application_env_json"`
}

type AppEventEntity

type AppEventEntity struct {
	// EventTypes are app.crash, audit.app.start, audit.app.stop, audit.app.update, audit.app.create, audit.app.delete-request
	EventType string `json:"type"`
	// The GUID of the actor.
	Actor string `json:"actor"`
	// The actor type, user or app
	ActorType string `json:"actor_type"`
	// The name of the actor.
	ActorName string `json:"actor_name"`
	// The GUID of the actee.
	Actee string `json:"actee"`
	// The actee type, space, app or v3-app
	ActeeType string `json:"actee_type"`
	// The name of the actee.
	ActeeName string `json:"actee_name"`
	// Timestamp format "2016-02-26T13:29:44Z". The event creation time.
	Timestamp time.Time `json:"timestamp"`
	MetaData  struct {
		// app.crash event fields
		ExitDescription string `json:"exit_description,omitempty"`
		ExitReason      string `json:"reason,omitempty"`
		ExitStatus      string `json:"exit_status,omitempty"`

		Request struct {
			Name              string  `json:"name,omitempty"`
			Instances         float64 `json:"instances,omitempty"`
			State             string  `json:"state,omitempty"`
			Memory            float64 `json:"memory,omitempty"`
			EnvironmentVars   string  `json:"environment_json,omitempty"`
			DockerCredentials string  `json:"docker_credentials_json,omitempty"`
			// audit.app.create event fields
			Console            bool    `json:"console,omitempty"`
			Buildpack          string  `json:"buildpack,omitempty"`
			Space              string  `json:"space_guid,omitempty"`
			HealthcheckType    string  `json:"health_check_type,omitempty"`
			HealthcheckTimeout float64 `json:"health_check_timeout,omitempty"`
			Production         bool    `json:"production,omitempty"`
			// app.crash event fields
			Index float64 `json:"index,omitempty"`
		} `json:"request"`
	} `json:"metadata"`
}

The AppEventEntity the actual app event body

type AppEventQuery

type AppEventQuery struct {
	Filter   string
	Operator string
	Value    string
}

AppEventQuery a struct for defining queries like 'q=filter>value' or 'q=filter IN a,b,c'

type AppEventResource

type AppEventResource struct {
	Meta   Meta           `json:"metadata"`
	Entity AppEventEntity `json:"entity"`
}

AppEventResource the event resources

type AppEventResponse

type AppEventResponse struct {
	Results   int                `json:"total_results"`
	Pages     int                `json:"total_pages"`
	PrevURL   string             `json:"prev_url"`
	NextURL   string             `json:"next_url"`
	Resources []AppEventResource `json:"resources"`
}

AppEventResponse the entire response

type AppInstance

type AppInstance struct {
	State string    `json:"state"`
	Since sinceTime `json:"since"`
}

type AppResource

type AppResource struct {
	Meta   Meta `json:"metadata"`
	Entity App  `json:"entity"`
}

type AppResponse

type AppResponse struct {
	Count     int           `json:"total_results"`
	Pages     int           `json:"total_pages"`
	NextUrl   string        `json:"next_url"`
	Resources []AppResource `json:"resources"`
}

type AppState

type AppState string
const (
	APP_STOPPED AppState = "STOPPED"
	APP_STARTED AppState = "STARTED"
)

type AppStats

type AppStats struct {
	State string `json:"state"`
	Stats struct {
		Name      string   `json:"name"`
		Uris      []string `json:"uris"`
		Host      string   `json:"host"`
		Port      int      `json:"port"`
		Uptime    int      `json:"uptime"`
		MemQuota  int      `json:"mem_quota"`
		DiskQuota int      `json:"disk_quota"`
		FdsQuota  int      `json:"fds_quota"`
		Usage     struct {
			Time statTime `json:"time"`
			CPU  float64  `json:"cpu"`
			Mem  int      `json:"mem"`
			Disk int      `json:"disk"`
		} `json:"usage"`
	} `json:"stats"`
}

type AppSummary

type AppSummary struct {
	Guid                     string                 `json:"guid"`
	Name                     string                 `json:"name"`
	ServiceCount             int                    `json:"service_count"`
	RunningInstances         int                    `json:"running_instances"`
	SpaceGuid                string                 `json:"space_guid"`
	StackGuid                string                 `json:"stack_guid"`
	Buildpack                string                 `json:"buildpack"`
	DetectedBuildpack        string                 `json:"detected_buildpack"`
	Environment              map[string]interface{} `json:"environment_json"`
	Memory                   int                    `json:"memory"`
	Instances                int                    `json:"instances"`
	DiskQuota                int                    `json:"disk_quota"`
	State                    string                 `json:"state"`
	Command                  string                 `json:"command"`
	PackageState             string                 `json:"package_state"`
	HealthCheckType          string                 `json:"health_check_type"`
	HealthCheckTimeout       int                    `json:"health_check_timeout"`
	StagingFailedReason      string                 `json:"staging_failed_reason"`
	StagingFailedDescription string                 `json:"staging_failed_description"`
	Diego                    bool                   `json:"diego"`
	DockerImage              string                 `json:"docker_image"`
	DetectedStartCommand     string                 `json:"detected_start_command"`
	EnableSSH                bool                   `json:"enable_ssh"`
	DockerCredentials        map[string]interface{} `json:"docker_credentials_json"`
}

type AppUpdateResource

type AppUpdateResource struct {
	Name                     string                 `json:"name,omitempty"`
	Memory                   int                    `json:"memory,omitempty"`
	Instances                int                    `json:"instances,omitempty"`
	DiskQuota                int                    `json:"disk_quota,omitempty"`
	SpaceGuid                string                 `json:"space_guid,omitempty"`
	StackGuid                string                 `json:"stack_guid,omitempty"`
	State                    AppState               `json:"state,omitempty"`
	Command                  string                 `json:"command,omitempty"`
	Buildpack                string                 `json:"buildpack,omitempty"`
	HealthCheckHttpEndpoint  string                 `json:"health_check_http_endpoint,omitempty"`
	HealthCheckType          string                 `json:"health_check_type,omitempty"`
	HealthCheckTimeout       int                    `json:"health_check_timeout,omitempty"`
	Diego                    bool                   `json:"diego,omitempty"`
	EnableSSH                bool                   `json:"enable_ssh,omitempty"`
	DockerImage              string                 `json:"docker_image,omitempty"`
	DockerCredentials        map[string]interface{} `json:"docker_credentials_json,omitempty"`
	Environment              map[string]interface{} `json:"environment_json,omitempty"`
	StagingFailedReason      string                 `json:"staging_failed_reason,omitempty"`
	StagingFailedDescription string                 `json:"staging_failed_description,omitempty"`
	Ports                    []int                  `json:"ports,omitempty"`
}

type AppUsageEvent

type AppUsageEvent struct {
	GUID                          string `json:"guid"`
	CreatedAt                     string `json:"created_at"`
	State                         string `json:"state"`
	PreviousState                 string `json:"previous_state"`
	MemoryInMbPerInstance         int    `json:"memory_in_mb_per_instance"`
	PreviousMemoryInMbPerInstance int    `json:"previous_memory_in_mb_per_instance"`
	InstanceCount                 int    `json:"instance_count"`
	PreviousInstanceCount         int    `json:"previous_instance_count"`
	AppGUID                       string `json:"app_guid"`
	SpaceGUID                     string `json:"space_guid"`
	SpaceName                     string `json:"space_name"`
	OrgGUID                       string `json:"org_guid"`
	BuildpackGUID                 string `json:"buildpack_guid"`
	BuildpackName                 string `json:"buildpack_name"`
	PackageState                  string `json:"package_state"`
	PreviousPackageState          string `json:"previous_package_state"`
	ParentAppGUID                 string `json:"parent_app_guid"`
	ParentAppName                 string `json:"parent_app_name"`
	ProcessType                   string `json:"process_type"`
	TaskName                      string `json:"task_name"`
	TaskGUID                      string `json:"task_guid"`
	// contains filtered or unexported fields
}

type AppUsageEventResource

type AppUsageEventResource struct {
	Meta   Meta          `json:"metadata"`
	Entity AppUsageEvent `json:"entity"`
}

type AppUsageEventsResponse

type AppUsageEventsResponse struct {
	TotalResults int                     `json:"total_results"`
	Pages        int                     `json:"total_pages"`
	NextURL      string                  `json:"next_url"`
	Resources    []AppUsageEventResource `json:"resources"`
}

type Buildpack

type Buildpack struct {
	Guid      string `json:"guid"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	Name      string `json:"name"`
	Enabled   bool   `json:"enabled"`
	Locked    bool   `json:"locked"`
	Position  int    `json:"position"`
	Filename  string `json:"filename"`
	Stack     string `json:"stack"`
	// contains filtered or unexported fields
}

func (*Buildpack) Update

func (b *Buildpack) Update(bpr *BuildpackRequest) error

func (*Buildpack) Upload

func (b *Buildpack) Upload(file io.Reader, fileName string) error

type BuildpackRequest

type BuildpackRequest struct {
	// These are all pointers to the values so that we can tell
	// whether people wanted position 0, or enable/unlock values,
	// vs whether they didn't specify them and want them unchanged/default.
	Name     *string `json:"name,omitempty"`
	Enabled  *bool   `json:"enabled,omitempty"`
	Locked   *bool   `json:"locked,omitempty"`
	Position *int    `json:"position,omitempty"`
	Stack    *string `json:"stack,omitempty"`
}

func (*BuildpackRequest) Disable

func (bpr *BuildpackRequest) Disable()

func (*BuildpackRequest) Enable

func (bpr *BuildpackRequest) Enable()

func (*BuildpackRequest) Lock

func (bpr *BuildpackRequest) Lock()

func (*BuildpackRequest) SetName

func (bpr *BuildpackRequest) SetName(s string)

func (*BuildpackRequest) SetPosition

func (bpr *BuildpackRequest) SetPosition(i int)

func (*BuildpackRequest) SetStack

func (bpr *BuildpackRequest) SetStack(s string)

func (*BuildpackRequest) Unlock

func (bpr *BuildpackRequest) Unlock()

type BuildpackResource

type BuildpackResource struct {
	Meta   Meta      `json:"metadata"`
	Entity Buildpack `json:"entity"`
}

type BuildpackResponse

type BuildpackResponse struct {
	Count     int                 `json:"total_results"`
	Pages     int                 `json:"total_pages"`
	NextUrl   string              `json:"next_url"`
	Resources []BuildpackResource `json:"resources"`
}

type Client

type Client struct {
	Config   Config
	Endpoint Endpoint
}

Client used to communicate with Cloud Foundry

func NewClient

func NewClient(config *Config) (client *Client, err error)

NewClient returns a new client

func (*Client) AddIsolationSegmentToOrg

func (c *Client) AddIsolationSegmentToOrg(isolationSegmentGUID, orgGUID string) error

func (*Client) AddIsolationSegmentToSpace

func (c *Client) AddIsolationSegmentToSpace(isolationSegmentGUID, spaceGUID string) error

func (*Client) AppByGuid

func (c *Client) AppByGuid(guid string) (App, error)

func (*Client) AppByName

func (c *Client) AppByName(appName, spaceGuid, orgGuid string) (App, error)

AppByName takes an appName, and GUIDs for a space and org, and performs the API lookup with those query parameters set to return you the desired App object.

func (*Client) AssignSpaceQuota

func (c *Client) AssignSpaceQuota(quotaGUID, spaceGUID string) error

func (*Client) AssociateOrgAuditor

func (c *Client) AssociateOrgAuditor(orgGUID, userGUID string) (Org, error)

func (*Client) AssociateOrgAuditorByUsername

func (c *Client) AssociateOrgAuditorByUsername(orgGUID, name string) (Org, error)

func (*Client) AssociateOrgAuditorByUsernameAndOrigin

func (c *Client) AssociateOrgAuditorByUsernameAndOrigin(orgGUID, name, origin string) (Org, error)

func (*Client) AssociateOrgBillingManager

func (c *Client) AssociateOrgBillingManager(orgGUID, userGUID string) (Org, error)

func (*Client) AssociateOrgBillingManagerByUsername

func (c *Client) AssociateOrgBillingManagerByUsername(orgGUID, name string) (Org, error)

func (*Client) AssociateOrgBillingManagerByUsernameAndOrigin

func (c *Client) AssociateOrgBillingManagerByUsernameAndOrigin(orgGUID, name, origin string) (Org, error)

func (*Client) AssociateOrgManager

func (c *Client) AssociateOrgManager(orgGUID, userGUID string) (Org, error)

func (*Client) AssociateOrgManagerByUsername

func (c *Client) AssociateOrgManagerByUsername(orgGUID, name string) (Org, error)

func (*Client) AssociateOrgManagerByUsernameAndOrigin

func (c *Client) AssociateOrgManagerByUsernameAndOrigin(orgGUID, name, origin string) (Org, error)

func (*Client) AssociateOrgUser

func (c *Client) AssociateOrgUser(orgGUID, userGUID string) (Org, error)

func (*Client) AssociateOrgUserByUsername

func (c *Client) AssociateOrgUserByUsername(orgGUID, name string) (Org, error)

func (*Client) AssociateOrgUserByUsernameAndOrigin

func (c *Client) AssociateOrgUserByUsernameAndOrigin(orgGUID, name, origin string) (Org, error)

func (*Client) AssociateSpaceAuditor

func (c *Client) AssociateSpaceAuditor(spaceGUID, userGUID string) (Space, error)

func (*Client) AssociateSpaceAuditorByUsername

func (c *Client) AssociateSpaceAuditorByUsername(spaceGUID, name string) (Space, error)

func (*Client) AssociateSpaceAuditorByUsernameAndOrigin

func (c *Client) AssociateSpaceAuditorByUsernameAndOrigin(spaceGUID, name, origin string) (Space, error)

func (*Client) AssociateSpaceDeveloper

func (c *Client) AssociateSpaceDeveloper(spaceGUID, userGUID string) (Space, error)

func (*Client) AssociateSpaceDeveloperByUsername

func (c *Client) AssociateSpaceDeveloperByUsername(spaceGUID, name string) (Space, error)

func (*Client) AssociateSpaceDeveloperByUsernameAndOrigin

func (c *Client) AssociateSpaceDeveloperByUsernameAndOrigin(spaceGUID, name, origin string) (Space, error)

func (*Client) AssociateSpaceManager

func (c *Client) AssociateSpaceManager(spaceGUID, userGUID string) (Space, error)

func (*Client) AssociateSpaceManagerByUsername

func (c *Client) AssociateSpaceManagerByUsername(spaceGUID, name string) (Space, error)

func (*Client) AssociateSpaceManagerByUsernameAndOrigin

func (c *Client) AssociateSpaceManagerByUsernameAndOrigin(spaceGUID, name, origin string) (Space, error)

func (*Client) BindRoute

func (c *Client) BindRoute(routeGUID, appGUID string) error

BindRoute associates the specified route with the application

func (*Client) BindRunningSecGroup

func (c *Client) BindRunningSecGroup(secGUID string) error

BindRunningSecGroup contacts the CF endpoint to associate a security group secGUID: identifies the security group to add a space to

func (*Client) BindSecGroup

func (c *Client) BindSecGroup(secGUID, spaceGUID string) error

BindSecGroup contacts the CF endpoint to associate a space with a security group secGUID: identifies the security group to add a space to spaceGUID: identifies the space to associate

func (*Client) BindStagingSecGroup

func (c *Client) BindStagingSecGroup(secGUID string) error

BindStagingSecGroup contacts the CF endpoint to associate a space with a security group secGUID: identifies the security group to add a space to

func (*Client) BindStagingSecGroupToSpace

func (c *Client) BindStagingSecGroupToSpace(secGUID, spaceGUID string) error

BindSpaceStagingSecGroup contacts the CF endpoint to associate a space with a security group for staging functions only secGUID: identifies the security group to add a space to spaceGUID: identifies the space to associate

func (*Client) CancelV3Deployment

func (c *Client) CancelV3Deployment(deploymentGUID string) error

func (*Client) CopyPackageV3

func (c *Client) CopyPackageV3(packageGUID, appGUID string) (*V3Package, error)

CopyPackageV3 makes a copy of a package that is associated with one app and associates the copy with a new app.

func (*Client) CreateApp

func (c *Client) CreateApp(req AppCreateRequest) (App, error)

CreateApp creates a new empty application that still needs it's app bit uploaded and to be started

func (*Client) CreateBuildpack

func (c *Client) CreateBuildpack(bpr *BuildpackRequest) (*Buildpack, error)

func (*Client) CreateDomain

func (c *Client) CreateDomain(name, orgGuid string) (*Domain, error)

func (*Client) CreateIsolationSegment

func (c *Client) CreateIsolationSegment(name string) (*IsolationSegment, error)

func (*Client) CreateOrg

func (c *Client) CreateOrg(req OrgRequest) (Org, error)

func (*Client) CreateOrgQuota

func (c *Client) CreateOrgQuota(orgQuote OrgQuotaRequest) (*OrgQuota, error)

func (*Client) CreateRoute

func (c *Client) CreateRoute(routeRequest RouteRequest) (Route, error)

CreateRoute creates a regular http route

func (*Client) CreateRouteServiceBinding

func (c *Client) CreateRouteServiceBinding(routeGUID, serviceInstanceGUID string) error

func (*Client) CreateSecGroup

func (c *Client) CreateSecGroup(name string, rules []SecGroupRule, spaceGuids []string) (*SecGroup, error)

CreateSecGroup contacts the CF endpoint for creating a new security group. name: the name to give to the created security group rules: A slice of rule objects that describe the rules that this security group enforces.

This can technically be nil or an empty slice - we won't judge you

spaceGuids: The security group will be associated with the spaces specified by the contents of this slice.

If nil, the security group will not be associated with any spaces initially.

func (*Client) CreateServiceBinding

func (c *Client) CreateServiceBinding(appGUID, serviceInstanceGUID string) (*ServiceBinding, error)

func (*Client) CreateServiceBroker

func (c *Client) CreateServiceBroker(csb CreateServiceBrokerRequest) (ServiceBroker, error)

func (*Client) CreateServiceInstance

func (c *Client) CreateServiceInstance(req ServiceInstanceRequest) (ServiceInstance, error)

func (*Client) CreateServiceKey

func (c *Client) CreateServiceKey(csr CreateServiceKeyRequest) (ServiceKey, error)

CreateServiceKey creates a service key from the request. If a service key exists already, it returns an error containing `CF-ServiceKeyNameTaken`

func (*Client) CreateServicePlanVisibility

func (c *Client) CreateServicePlanVisibility(servicePlanGuid string, organizationGuid string) (ServicePlanVisibility, error)

func (*Client) CreateServicePlanVisibilityByUniqueId

func (c *Client) CreateServicePlanVisibilityByUniqueId(uniqueId string, organizationGuid string) (ServicePlanVisibility, error)

a uniqueID is the id of the service in the catalog and not in cf internal db

func (*Client) CreateSharedDomain

func (c *Client) CreateSharedDomain(name string, internal bool, router_group_guid string) (*SharedDomain, error)

func (*Client) CreateSpace

func (c *Client) CreateSpace(req SpaceRequest) (Space, error)

func (*Client) CreateSpaceQuota

func (c *Client) CreateSpaceQuota(spaceQuote SpaceQuotaRequest) (*SpaceQuota, error)

func (*Client) CreateTask

func (c *Client) CreateTask(tr TaskRequest) (task Task, err error)

CreateTask creates a new task in CF system and returns its structure.

func (*Client) CreateTcpRoute

func (c *Client) CreateTcpRoute(routeRequest RouteRequest) (Route, error)

CreateTcpRoute creates a TCP route

func (*Client) CreateUser

func (c *Client) CreateUser(req UserRequest) (User, error)

func (*Client) CreateUserProvidedServiceInstance

func (c *Client) CreateUserProvidedServiceInstance(req UserProvidedServiceInstanceRequest) (*UserProvidedServiceInstance, error)

func (*Client) CreateV3App

func (c *Client) CreateV3App(r CreateV3AppRequest) (*V3App, error)

func (*Client) CreateV3Build

func (c *Client) CreateV3Build(packageGUID string, lifecycle *V3Lifecycle, metadata *V3Metadata) (*V3Build, error)

func (*Client) CreateV3Deployment

func (c *Client) CreateV3Deployment(appGUID string, optionalParams *CreateV3DeploymentOptionalParameters) (*V3Deployment, error)

func (*Client) CreateV3DockerPackage

func (c *Client) CreateV3DockerPackage(image string, appGUID string, dockerCredentials *DockerCredentials) (*V3Package, error)

CreateV3DockerPackage creates a Docker package

func (*Client) CreateV3Organization

func (c *Client) CreateV3Organization(r CreateV3OrganizationRequest) (*V3Organization, error)

func (*Client) CreateV3OrganizationRole

func (c *Client) CreateV3OrganizationRole(orgGUID, userGUID, roleType string) (*V3Role, error)

func (*Client) CreateV3Route

func (c *Client) CreateV3Route(
	spaceGUID string,
	domainGUID string,
	opt *CreateV3RouteOptionalParameters,
) (*V3Route, error)

func (*Client) CreateV3SecurityGroup

func (c *Client) CreateV3SecurityGroup(r CreateV3SecurityGroupRequest) (*V3SecurityGroup, error)

CreateV3SecurityGroup creates security group from CreateV3SecurityGroupRequest

func (*Client) CreateV3Space

func (c *Client) CreateV3Space(r CreateV3SpaceRequest) (*V3Space, error)

func (*Client) CreateV3SpaceRole

func (c *Client) CreateV3SpaceRole(spaceGUID, userGUID, roleType string) (*V3Role, error)

func (*Client) DefaultIsolationSegmentForOrg

func (c *Client) DefaultIsolationSegmentForOrg(orgGUID, isolationSegmentGUID string) error

func (*Client) DeleteApp

func (c *Client) DeleteApp(guid string) error

func (*Client) DeleteBuildpack

func (c *Client) DeleteBuildpack(guid string, async bool) error

func (*Client) DeleteDomain

func (c *Client) DeleteDomain(guid string) error

func (*Client) DeleteDroplet

func (c *Client) DeleteDroplet(dropletGUID string) error

func (*Client) DeleteIsolationSegmentByGUID

func (c *Client) DeleteIsolationSegmentByGUID(guid string) error

func (*Client) DeleteOrg

func (c *Client) DeleteOrg(guid string, recursive, async bool) error

func (*Client) DeleteOrgQuota

func (c *Client) DeleteOrgQuota(guid string, async bool) error

func (*Client) DeleteRoute

func (c *Client) DeleteRoute(guid string) error

func (*Client) DeleteRouteMapping

func (c *Client) DeleteRouteMapping(guid string) error

func (*Client) DeleteRouteServiceBinding

func (c *Client) DeleteRouteServiceBinding(routeGUID, serviceInstanceGUID string) error

func (*Client) DeleteSecGroup

func (c *Client) DeleteSecGroup(guid string) error

DeleteSecGroup contacts the CF endpoint to delete an existing security group. guid: Indentifies the security group to be deleted.

func (*Client) DeleteServiceBinding

func (c *Client) DeleteServiceBinding(guid string) error

func (*Client) DeleteServiceBroker

func (c *Client) DeleteServiceBroker(guid string) error

func (*Client) DeleteServiceInstance

func (c *Client) DeleteServiceInstance(guid string, recursive, async bool) error

func (*Client) DeleteServiceKey

func (c *Client) DeleteServiceKey(guid string) error

DeleteServiceKey removes a service key instance

func (*Client) DeleteServicePlanVisibility

func (c *Client) DeleteServicePlanVisibility(guid string, async bool) error

func (*Client) DeleteServicePlanVisibilityByPlanAndOrg

func (c *Client) DeleteServicePlanVisibilityByPlanAndOrg(servicePlanGuid string, organizationGuid string, async bool) error

func (*Client) DeleteSharedDomain

func (c *Client) DeleteSharedDomain(guid string, async bool) error

func (*Client) DeleteSpace

func (c *Client) DeleteSpace(guid string, recursive, async bool) error

func (*Client) DeleteUser

func (c *Client) DeleteUser(userGuid string) error

func (*Client) DeleteUserProvidedServiceInstance

func (c *Client) DeleteUserProvidedServiceInstance(guid string) error

func (*Client) DeleteV3App

func (c *Client) DeleteV3App(guid string) error

func (*Client) DeleteV3Organization

func (c *Client) DeleteV3Organization(organizationGUID string) error

func (*Client) DeleteV3Role

func (c *Client) DeleteV3Role(roleGUID string) error

func (*Client) DeleteV3SecurityGroup

func (c *Client) DeleteV3SecurityGroup(GUID string) error

DeleteV3SecurityGroup deletes security group by GUID

func (*Client) DeleteV3Space

func (c *Client) DeleteV3Space(spaceGUID string) error

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) DoRequest

func (c *Client) DoRequest(r *Request) (*http.Response, error)

DoRequest runs a request with our client

func (*Client) DoRequestWithoutRedirects

func (c *Client) DoRequestWithoutRedirects(r *Request) (*http.Response, error)

DoRequestWithoutRedirects executes the request without following redirects

func (*Client) GetAppBits

func (c *Client) GetAppBits(guid string) (io.ReadCloser, error)

GetAppBits downloads the application's bits as a tar file

func (*Client) GetAppByGuid

func (c *Client) GetAppByGuid(guid string) (App, error)

func (*Client) GetAppByGuidNoInlineCall

func (c *Client) GetAppByGuidNoInlineCall(guid string) (App, error)

GetAppByGuidNoInlineCall will fetch app info including space and orgs information Without using inline-relations-depth=2 call

func (*Client) GetAppEnv

func (c *Client) GetAppEnv(guid string) (AppEnv, error)

func (*Client) GetAppInstances

func (c *Client) GetAppInstances(guid string) (map[string]AppInstance, error)

func (*Client) GetAppRoutes

func (c *Client) GetAppRoutes(guid string) ([]Route, error)

func (*Client) GetAppStats

func (c *Client) GetAppStats(guid string) (map[string]AppStats, error)

func (*Client) GetBuildpackByGuid

func (c *Client) GetBuildpackByGuid(buildpackGUID string) (Buildpack, error)

func (*Client) GetCurrentDropletForV3App

func (c *Client) GetCurrentDropletForV3App(appGUID string) (*V3Droplet, error)

func (*Client) GetDomainByGuid

func (c *Client) GetDomainByGuid(guid string) (Domain, error)

func (*Client) GetDomainByName

func (c *Client) GetDomainByName(name string) (Domain, error)

func (*Client) GetDropletBits

func (c *Client) GetDropletBits(guid string) (io.ReadCloser, error)

GetDropletBits downloads the application's droplet bits as a tar file

func (*Client) GetInfo

func (c *Client) GetInfo() (*Info, error)

GetInfo retrieves Info from the Cloud Controller API

func (*Client) GetIsolationSegmentByGUID

func (c *Client) GetIsolationSegmentByGUID(guid string) (*IsolationSegment, error)

func (*Client) GetOrgByGuid

func (c *Client) GetOrgByGuid(guid string) (Org, error)

func (*Client) GetOrgByName

func (c *Client) GetOrgByName(name string) (Org, error)

func (*Client) GetOrgQuotaByName

func (c *Client) GetOrgQuotaByName(name string) (OrgQuota, error)

func (*Client) GetProcessStats

func (c *Client) GetProcessStats(processGUID string) ([]Stats, error)

func (*Client) GetRouteByGuid

func (c *Client) GetRouteByGuid(guid string) (Route, error)

func (*Client) GetRouteMappingByGuid

func (c *Client) GetRouteMappingByGuid(guid string) (*RouteMapping, error)

func (*Client) GetRunningEnvironmentVariableGroup

func (c *Client) GetRunningEnvironmentVariableGroup() (EnvironmentVariableGroup, error)

func (*Client) GetSSHCode

func (c *Client) GetSSHCode() (string, error)

func (*Client) GetSecGroup

func (c *Client) GetSecGroup(guid string) (*SecGroup, error)

GetSecGroup contacts the CF endpoint for fetching the info for a particular security group. guid: Identifies the security group to fetch information from

func (*Client) GetSecGroupByName

func (c *Client) GetSecGroupByName(name string) (secGroup SecGroup, err error)

func (*Client) GetServiceBindingByGuid

func (c *Client) GetServiceBindingByGuid(guid string) (ServiceBinding, error)

func (*Client) GetServiceBrokerByGuid

func (c *Client) GetServiceBrokerByGuid(guid string) (ServiceBroker, error)

func (*Client) GetServiceBrokerByName

func (c *Client) GetServiceBrokerByName(name string) (ServiceBroker, error)

func (*Client) GetServiceByGuid

func (c *Client) GetServiceByGuid(guid string) (Service, error)

func (*Client) GetServiceInstanceByGuid

func (c *Client) GetServiceInstanceByGuid(guid string) (ServiceInstance, error)

func (*Client) GetServiceInstanceParams

func (c *Client) GetServiceInstanceParams(guid string) (map[string]interface{}, error)

func (*Client) GetServiceKeyByGuid

func (c *Client) GetServiceKeyByGuid(guid string) (ServiceKey, error)

func (*Client) GetServiceKeyByInstanceGuid

func (c *Client) GetServiceKeyByInstanceGuid(guid string) (ServiceKey, error)

GetServiceKeyByInstanceGuid is deprecated in favor of GetServiceKeysByInstanceGuid

func (*Client) GetServiceKeyByName

func (c *Client) GetServiceKeyByName(name string) (ServiceKey, error)

func (*Client) GetServiceKeysByInstanceGuid

func (c *Client) GetServiceKeysByInstanceGuid(guid string) ([]ServiceKey, error)

GetServiceKeysByInstanceGuid returns the service keys for a service instance. If none are found, it returns an error.

func (*Client) GetServicePlanByGUID

func (c *Client) GetServicePlanByGUID(guid string) (*ServicePlan, error)

func (*Client) GetServicePlanVisibilityByGuid

func (c *Client) GetServicePlanVisibilityByGuid(guid string) (ServicePlanVisibility, error)

func (*Client) GetSharedDomainByGuid

func (c *Client) GetSharedDomainByGuid(guid string) (SharedDomain, error)

func (*Client) GetSharedDomainByName

func (c *Client) GetSharedDomainByName(name string) (SharedDomain, error)

func (*Client) GetSpaceByGuid

func (c *Client) GetSpaceByGuid(spaceGUID string) (Space, error)

func (*Client) GetSpaceByName

func (c *Client) GetSpaceByName(spaceName string, orgGuid string) (Space, error)

func (*Client) GetSpaceQuotaByName

func (c *Client) GetSpaceQuotaByName(name string) (SpaceQuota, error)

func (*Client) GetStackByGuid

func (c *Client) GetStackByGuid(stackGUID string) (Stack, error)

func (*Client) GetStagingEnvironmentVariableGroup

func (c *Client) GetStagingEnvironmentVariableGroup() (EnvironmentVariableGroup, error)

func (*Client) GetTaskByGuid

func (c *Client) GetTaskByGuid(guid string) (task Task, err error)

GetTaskByGuid returns a task structure by requesting it with the tasks GUID.

func (*Client) GetToken

func (c *Client) GetToken() (string, error)

func (*Client) GetUserByGUID

func (c *Client) GetUserByGUID(guid string) (User, error)

GetUserByGUID retrieves the user with the provided guid.

func (*Client) GetUserProvidedServiceInstanceByGuid

func (c *Client) GetUserProvidedServiceInstanceByGuid(guid string) (UserProvidedServiceInstance, error)

func (*Client) GetV3AppByGUID

func (c *Client) GetV3AppByGUID(guid string) (*V3App, error)

func (*Client) GetV3AppEnvironment

func (c *Client) GetV3AppEnvironment(appGUID string) (V3AppEnvironment, error)

func (*Client) GetV3BuildByGUID

func (c *Client) GetV3BuildByGUID(buildGUID string) (*V3Build, error)

func (*Client) GetV3Deployment

func (c *Client) GetV3Deployment(deploymentGUID string) (*V3Deployment, error)

func (*Client) GetV3OrganizationByGUID

func (c *Client) GetV3OrganizationByGUID(organizationGUID string) (*V3Organization, error)

func (*Client) GetV3SecurityGroupByGUID

func (c *Client) GetV3SecurityGroupByGUID(GUID string) (*V3SecurityGroup, error)

GetV3SecurityGroupByGUID retrieves security group base on provided GUID

func (*Client) GetV3ServiceCredentialBindingsByGUID

func (c *Client) GetV3ServiceCredentialBindingsByGUID(GUID string) (*V3ServiceCredentialBindings, error)

GetV3ServiceCredentialBindingsByGUID retrieves the service credential binding based on the provided guid

func (*Client) GetV3SpaceByGUID

func (c *Client) GetV3SpaceByGUID(spaceGUID string) (*V3Space, error)

func (*Client) IsolationSegmentForSpace

func (c *Client) IsolationSegmentForSpace(spaceGUID, isolationSegmentGUID string) error

func (*Client) KillAppInstance

func (c *Client) KillAppInstance(guid string, index string) error

func (*Client) ListAllProcesses

func (c *Client) ListAllProcesses() ([]Process, error)

ListAllProcesses will call the v3 processes api

func (*Client) ListAllProcessesByQuery

func (c *Client) ListAllProcessesByQuery(query url.Values) ([]Process, error)

ListAllProcessesByQuery will call the v3 processes api

func (*Client) ListAppEvents

func (c *Client) ListAppEvents(eventType string) ([]AppEventEntity, error)

ListAppEvents returns all app events based on eventType

func (*Client) ListAppEventsByQuery

func (c *Client) ListAppEventsByQuery(eventType string, queries []AppEventQuery) ([]AppEventEntity, error)

ListAppEventsByQuery returns all app events based on eventType and queries

func (*Client) ListAppUsageEvents

func (c *Client) ListAppUsageEvents() ([]AppUsageEvent, error)

ListAppUsageEvents lists all unfiltered events.

func (*Client) ListAppUsageEventsByQuery

func (c *Client) ListAppUsageEventsByQuery(query url.Values) ([]AppUsageEvent, error)

ListAppUsageEventsByQuery lists all events matching the provided query.

func (*Client) ListApps

func (c *Client) ListApps() ([]App, error)

func (*Client) ListAppsByQuery

func (c *Client) ListAppsByQuery(query url.Values) ([]App, error)

func (*Client) ListAppsByQueryWithLimits

func (c *Client) ListAppsByQueryWithLimits(query url.Values, totalPages int) ([]App, error)

ListAppsByQueryWithLimits queries totalPages app info. When totalPages is less and equal than 0, it queries all app info When there are no more than totalPages apps on server side, all apps info will be returned

func (*Client) ListAppsByRoute

func (c *Client) ListAppsByRoute(routeGuid string) ([]App, error)

func (*Client) ListAppsBySpaceGuid

func (c *Client) ListAppsBySpaceGuid(spaceGuid string) ([]App, error)

func (*Client) ListBuildpacks

func (c *Client) ListBuildpacks() ([]Buildpack, error)

func (*Client) ListDomains

func (c *Client) ListDomains() ([]Domain, error)

func (*Client) ListDomainsByQuery

func (c *Client) ListDomainsByQuery(query url.Values) ([]Domain, error)

func (*Client) ListEvents

func (c *Client) ListEvents() ([]Event, error)

ListEvents lists all unfiltered events.

func (*Client) ListEventsByQuery

func (c *Client) ListEventsByQuery(query url.Values) ([]Event, error)

ListEventsByQuery lists all events matching the provided query.

func (*Client) ListIsolationSegments

func (c *Client) ListIsolationSegments() ([]IsolationSegment, error)

func (*Client) ListIsolationSegmentsByQuery

func (c *Client) ListIsolationSegmentsByQuery(query url.Values) ([]IsolationSegment, error)

func (*Client) ListOrgAuditors

func (c *Client) ListOrgAuditors(orgGUID string) ([]User, error)

func (*Client) ListOrgAuditorsByQuery

func (c *Client) ListOrgAuditorsByQuery(orgGUID string, query url.Values) ([]User, error)

func (*Client) ListOrgBillingManagers

func (c *Client) ListOrgBillingManagers(orgGUID string) ([]User, error)

func (*Client) ListOrgBillingManagersByQuery

func (c *Client) ListOrgBillingManagersByQuery(orgGUID string, query url.Values) ([]User, error)

func (*Client) ListOrgManagers

func (c *Client) ListOrgManagers(orgGUID string) ([]User, error)

func (*Client) ListOrgManagersByQuery

func (c *Client) ListOrgManagersByQuery(orgGUID string, query url.Values) ([]User, error)

func (*Client) ListOrgPrivateDomains

func (c *Client) ListOrgPrivateDomains(orgGUID string) ([]Domain, error)

func (*Client) ListOrgQuotas

func (c *Client) ListOrgQuotas() ([]OrgQuota, error)

func (*Client) ListOrgQuotasByQuery

func (c *Client) ListOrgQuotasByQuery(query url.Values) ([]OrgQuota, error)

func (*Client) ListOrgSpaceQuotas

func (c *Client) ListOrgSpaceQuotas(orgGUID string) ([]SpaceQuota, error)

func (*Client) ListOrgUsers

func (c *Client) ListOrgUsers(orgGUID string) ([]User, error)

func (*Client) ListOrgUsersByQuery

func (c *Client) ListOrgUsersByQuery(orgGUID string, query url.Values) ([]User, error)

func (*Client) ListOrgs

func (c *Client) ListOrgs() ([]Org, error)

func (*Client) ListOrgsByQuery

func (c *Client) ListOrgsByQuery(query url.Values) ([]Org, error)

func (*Client) ListPackagesForAppV3

func (c *Client) ListPackagesForAppV3(appGUID string, query url.Values) ([]V3Package, error)

func (*Client) ListRouteMappings

func (c *Client) ListRouteMappings() ([]*RouteMapping, error)

func (*Client) ListRouteMappingsByQuery

func (c *Client) ListRouteMappingsByQuery(query url.Values) ([]*RouteMapping, error)

func (*Client) ListRoutes

func (c *Client) ListRoutes() ([]Route, error)

func (*Client) ListRoutesByQuery

func (c *Client) ListRoutesByQuery(query url.Values) ([]Route, error)

func (*Client) ListRunningSecGroups

func (c *Client) ListRunningSecGroups() ([]SecGroup, error)

func (*Client) ListSecGroups

func (c *Client) ListSecGroups() (secGroups []SecGroup, err error)

func (*Client) ListServiceBindings

func (c *Client) ListServiceBindings() ([]ServiceBinding, error)

func (*Client) ListServiceBindingsByQuery

func (c *Client) ListServiceBindingsByQuery(query url.Values) ([]ServiceBinding, error)

func (*Client) ListServiceBrokers

func (c *Client) ListServiceBrokers() ([]ServiceBroker, error)

func (*Client) ListServiceBrokersByQuery

func (c *Client) ListServiceBrokersByQuery(query url.Values) ([]ServiceBroker, error)

func (*Client) ListServiceInstances

func (c *Client) ListServiceInstances() ([]ServiceInstance, error)

func (*Client) ListServiceInstancesByQuery

func (c *Client) ListServiceInstancesByQuery(query url.Values) ([]ServiceInstance, error)

func (*Client) ListServiceKeys

func (c *Client) ListServiceKeys() ([]ServiceKey, error)

func (*Client) ListServiceKeysByQuery

func (c *Client) ListServiceKeysByQuery(query url.Values) ([]ServiceKey, error)

func (*Client) ListServicePlanVisibilities

func (c *Client) ListServicePlanVisibilities() ([]ServicePlanVisibility, error)

func (*Client) ListServicePlanVisibilitiesByQuery

func (c *Client) ListServicePlanVisibilitiesByQuery(query url.Values) ([]ServicePlanVisibility, error)

func (*Client) ListServicePlans

func (c *Client) ListServicePlans() ([]ServicePlan, error)

func (*Client) ListServicePlansByQuery

func (c *Client) ListServicePlansByQuery(query url.Values) ([]ServicePlan, error)

func (*Client) ListServiceUsageEvents

func (c *Client) ListServiceUsageEvents() ([]ServiceUsageEvent, error)

ListServiceUsageEvents lists all unfiltered events.

func (*Client) ListServiceUsageEventsByQuery

func (c *Client) ListServiceUsageEventsByQuery(query url.Values) ([]ServiceUsageEvent, error)

ListServiceUsageEventsByQuery lists all events matching the provided query.

func (*Client) ListServices

func (c *Client) ListServices() ([]Service, error)

func (*Client) ListServicesByQuery

func (c *Client) ListServicesByQuery(query url.Values) ([]Service, error)

func (*Client) ListSharedDomains

func (c *Client) ListSharedDomains() ([]SharedDomain, error)

func (*Client) ListSharedDomainsByQuery

func (c *Client) ListSharedDomainsByQuery(query url.Values) ([]SharedDomain, error)

func (*Client) ListSpaceAuditors

func (c *Client) ListSpaceAuditors(spaceGUID string) ([]User, error)

func (*Client) ListSpaceAuditorsByQuery

func (c *Client) ListSpaceAuditorsByQuery(spaceGUID string, query url.Values) ([]User, error)

func (*Client) ListSpaceDevelopers

func (c *Client) ListSpaceDevelopers(spaceGUID string) ([]User, error)

func (*Client) ListSpaceDevelopersByQuery

func (c *Client) ListSpaceDevelopersByQuery(spaceGUID string, query url.Values) ([]User, error)

func (*Client) ListSpaceManagers

func (c *Client) ListSpaceManagers(spaceGUID string) ([]User, error)

func (*Client) ListSpaceManagersByQuery

func (c *Client) ListSpaceManagersByQuery(spaceGUID string, query url.Values) ([]User, error)

func (*Client) ListSpaceQuotas

func (c *Client) ListSpaceQuotas() ([]SpaceQuota, error)

func (*Client) ListSpaceQuotasByQuery

func (c *Client) ListSpaceQuotasByQuery(query url.Values) ([]SpaceQuota, error)

func (*Client) ListSpaceSecGroups

func (c *Client) ListSpaceSecGroups(spaceGUID string) (secGroups []SecGroup, err error)

func (*Client) ListSpaceServiceInstances

func (c *Client) ListSpaceServiceInstances(spaceGUID string) ([]ServiceInstance, error)

func (*Client) ListSpaceServiceInstancesByQuery

func (c *Client) ListSpaceServiceInstancesByQuery(spaceGUID string, query url.Values) ([]ServiceInstance, error)

func (*Client) ListSpaces

func (c *Client) ListSpaces() ([]Space, error)

func (*Client) ListSpacesByOrgGuid

func (c *Client) ListSpacesByOrgGuid(orgGuid string) ([]Space, error)

func (*Client) ListSpacesByQuery

func (c *Client) ListSpacesByQuery(query url.Values) ([]Space, error)

func (*Client) ListStacks

func (c *Client) ListStacks() ([]Stack, error)

func (*Client) ListStacksByQuery

func (c *Client) ListStacksByQuery(query url.Values) ([]Stack, error)

func (*Client) ListStagingSecGroups

func (c *Client) ListStagingSecGroups() ([]SecGroup, error)

func (*Client) ListTasks

func (c *Client) ListTasks() ([]Task, error)

ListTasks returns all tasks the user has access to. See http://v3-apidocs.cloudfoundry.org/version/3.12.0/index.html#list-tasks

func (*Client) ListTasksByQuery

func (c *Client) ListTasksByQuery(query url.Values) ([]Task, error)

ListTasksByQuery returns all tasks the user has access to, with query parameters. See http://v3-apidocs.cloudfoundry.org/version/3.12.0/index.html#list-tasks

func (*Client) ListUserAuditedOrgs

func (c *Client) ListUserAuditedOrgs(userGuid string) ([]Org, error)

func (*Client) ListUserAuditedSpaces

func (c *Client) ListUserAuditedSpaces(userGuid string) ([]Space, error)

func (*Client) ListUserBillingManagedOrgs

func (c *Client) ListUserBillingManagedOrgs(userGuid string) ([]Org, error)

func (*Client) ListUserManagedOrgs

func (c *Client) ListUserManagedOrgs(userGuid string) ([]Org, error)

func (*Client) ListUserManagedSpaces

func (c *Client) ListUserManagedSpaces(userGuid string) ([]Space, error)

func (*Client) ListUserOrgs

func (c *Client) ListUserOrgs(userGuid string) ([]Org, error)

func (*Client) ListUserProvidedServiceInstances

func (c *Client) ListUserProvidedServiceInstances() ([]UserProvidedServiceInstance, error)

func (*Client) ListUserProvidedServiceInstancesByQuery

func (c *Client) ListUserProvidedServiceInstancesByQuery(query url.Values) ([]UserProvidedServiceInstance, error)

func (*Client) ListUserSpaces

func (c *Client) ListUserSpaces(userGuid string) ([]Space, error)

func (*Client) ListUsers

func (c *Client) ListUsers() (Users, error)

func (*Client) ListUsersByQuery

func (c *Client) ListUsersByQuery(query url.Values) (Users, error)

func (*Client) ListV3AppsByQuery

func (c *Client) ListV3AppsByQuery(query url.Values) ([]V3App, error)

func (*Client) ListV3Domains

func (c *Client) ListV3Domains(query url.Values) ([]V3Domain, error)

func (*Client) ListV3OrganizationRolesByGUID

func (c *Client) ListV3OrganizationRolesByGUID(orgGUID string) ([]V3Role, []V3User, error)

ListV3OrganizationRolesByGUID retrieves roles based on query

func (*Client) ListV3OrganizationRolesByGUIDAndType

func (c *Client) ListV3OrganizationRolesByGUIDAndType(orgGUID string, roleType string) ([]V3User, error)

ListV3SpaceRolesByGUIDAndType retrieves roles based on query

func (*Client) ListV3OrganizationsByQuery

func (c *Client) ListV3OrganizationsByQuery(query url.Values) ([]V3Organization, error)

func (*Client) ListV3RoleAndUsersByQuery

func (c *Client) ListV3RoleAndUsersByQuery(query url.Values) ([]V3Role, []V3User, error)

func (*Client) ListV3RoleUsersByQuery

func (c *Client) ListV3RoleUsersByQuery(query url.Values) ([]V3User, error)

func (*Client) ListV3RolesByQuery

func (c *Client) ListV3RolesByQuery(query url.Values) ([]V3Role, error)

ListV3RolesByQuery retrieves roles based on query

func (*Client) ListV3Routes

func (c *Client) ListV3Routes() ([]V3Route, error)

func (*Client) ListV3RoutesByQuery

func (c *Client) ListV3RoutesByQuery(query url.Values) ([]V3Route, error)

func (*Client) ListV3SecurityGroupsByQuery

func (c *Client) ListV3SecurityGroupsByQuery(query url.Values) ([]V3SecurityGroup, error)

ListV3SecurityGroupsByQuery retrieves security groups based on query

func (*Client) ListV3ServiceCredentialBindings

func (c *Client) ListV3ServiceCredentialBindings() ([]V3ServiceCredentialBindings, error)

ListV3ServiceCredentialBindings retrieves all service credential bindings

func (*Client) ListV3ServiceCredentialBindingsByQuery

func (c *Client) ListV3ServiceCredentialBindingsByQuery(query url.Values) ([]V3ServiceCredentialBindings, error)

ListV3ServiceCredentialBindingsByQuery retrieves service credential bindings using a query

func (*Client) ListV3ServiceInstances

func (c *Client) ListV3ServiceInstances() ([]V3ServiceInstance, error)

func (*Client) ListV3ServiceInstancesByQuery

func (c *Client) ListV3ServiceInstancesByQuery(query url.Values) ([]V3ServiceInstance, error)

func (*Client) ListV3SpaceRolesByGUID

func (c *Client) ListV3SpaceRolesByGUID(spaceGUID string) ([]V3Role, []V3User, error)

ListV3SpaceRolesByGUID retrieves roles based on query

func (*Client) ListV3SpaceRolesByGUIDAndType

func (c *Client) ListV3SpaceRolesByGUIDAndType(spaceGUID string, roleType string) ([]V3User, error)