cfclient

package module
v0.0.0-...-13bd91b Latest Latest
Warning

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

Go to latest
Published: Feb 28, 2018 License: MIT Imports: 20 Imported by: 0

README

go-cfclient · Travis-CI GoDoc Report card

Overview

cfclient is a package to assist you in writing apps that need information out of Cloud Foundry. It provides functions and structures to retrieve

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 (
	"github.com/cloudfoundry-community/go-cfclient"
)

func main() {
  c := &cfclient.Config{
    ApiAddress:   "https://api.10.244.0.34.xip.io",
    Username:     "admin",
    Password:     "admin",
  }
  client, _ := cfclient.NewClient(c)
  apps, _ := client.ListApps()
  fmt.Println(apps)
}
Development
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:

go generate
Contributing

Pull requests welcome.

Documentation

Index

Constants

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

Variables

View Source
var ValidOperators = []string{":", ">=", "<=", "<", ">", "IN"}

ValidOperators const for all valid operators in a query

Functions

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 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 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 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 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 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 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 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 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 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 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 IsInvalidServiceInstanceSharingTargetSpaceError

func IsInvalidServiceInstanceSharingTargetSpaceError(err error) bool

IsInvalidServiceInstanceSharingTargetSpaceError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390007 - HTTP code: 422 - message: "Service instances cannot be shared into the space where they were created"

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 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 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 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 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 IsQuotaDefinitionMemoryLimitNegativeError

func IsQuotaDefinitionMemoryLimitNegativeError(err error) bool

IsQuotaDefinitionMemoryLimitNegativeError 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 negative"

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 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 IsRouteServiceInstanceSharingNotSupportedError

func IsRouteServiceInstanceSharingNotSupportedError(err error) bool

IsRouteServiceInstanceSharingNotSupportedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390005 - HTTP code: 400 - message: "Route services cannot be shared"

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 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 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 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 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 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: 400 - 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 50 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 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 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 because one or more bindings could not be deleted.\n\n%s"

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 IsServiceShareIsDisabledError

func IsServiceShareIsDisabledError(err error) bool

IsServiceShareIsDisabledError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390003 - HTTP code: 400 - message: "The %s service does not support service instance sharing."

func IsSharedServiceInstanceNameTakenError

func IsSharedServiceInstanceNameTakenError(err error) bool

IsSharedServiceInstanceNameTakenError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390006 - HTTP code: 400 - message: "A service instance called %s already exists in %s"

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 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 IsUserProvidedServiceInstanceSharingNotSupportedError

func IsUserProvidedServiceInstanceSharingNotSupportedError(err error) bool

IsUserProvidedServiceInstanceSharingNotSupportedError returns a boolean indicating whether the error is known to report the Cloud Foundry error: - Cloud Foundry code: 390004 - HTTP code: 400 - message: "User-provided services cannot be shared"

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"`
	DockerCredentials        map[string]interface{} `json:"docker_credentials_json"`
	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)

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 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 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 BillingManagerResponse

type BillingManagerResponse struct {
	Count     int            `json:"total_results"`
	Pages     int            `json:"total_pages"`
	NextURL   string         `json:"next_url"`
	Resources []UserResource `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"`
	// 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"`
}

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) 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) AppByGuid

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

func (*Client) AppByName

func (c *Client) AppByName(appName, spaceGuid, orgGuid string) (app App, err 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) AssociateOrgAuditor

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

func (*Client) AssociateOrgAuditorByUsername

func (c *Client) AssociateOrgAuditorByUsername(orgGUID, name 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) AssociateOrgUser

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

func (*Client) AssociateOrgUserByUsername

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

func (*Client) AssociateSpaceAuditorByUsername

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

func (*Client) AssociateSpaceDeveloperByUsername

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

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) 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) 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) 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) CreateSpace

func (c *Client) CreateSpace(req SpaceRequest) (Space, 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)

func (*Client) CreateUser

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

func (*Client) DeleteApp

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

func (*Client) DeleteDomain

func (c *Client) DeleteDomain(guid 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) DeleteRoute

func (c *Client) DeleteRoute(guid 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) DeleteServiceBroker

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

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) DeleteSpace

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

func (*Client) DeleteUser

func (c *Client) DeleteUser(userGuid 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) 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) GetDomainByName

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

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) 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) 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) GetServicePlanVisibilityByGuid

func (c *Client) GetServicePlanVisibilityByGuid(guid string) (ServicePlanVisibility, 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 Space, err error)

func (*Client) GetSpaceQuotaByName

func (c *Client) GetSpaceQuotaByName(name string) (SpaceQuota, 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) KillAppInstance

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

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) ListBillingManagers

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

func (*Client) ListBillingManagersByQuery

func (c *Client) ListBillingManagersByQuery(orgGUID string, query url.Values) ([]User, 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) 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) 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) ListOrgQuotas

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

func (*Client) ListOrgQuotasByQuery

func (c *Client) ListOrgQuotasByQuery(query url.Values) ([]OrgQuota, 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) ListRoutes

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

func (*Client) ListRoutesByQuery

func (c *Client) ListRoutesByQuery(query url.Values) ([]Route, 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) 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) ListSpaces

func (c *Client) ListSpaces() ([]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) 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) NewRequest

func (c *Client) NewRequest(method, path string) *request

NewRequest is used to create a new request

func (*Client) NewRequestWithBody

func (c *Client) NewRequestWithBody(method, path string, body io.Reader) *request

NewRequestWithBody is used to create a new request with arbigtrary body io.Reader.

func (*Client) OrgSpaces

func (c *Client) OrgSpaces(guid string) ([]Space, error)

func (*Client) RemoveOrgAuditor

func (c *Client) RemoveOrgAuditor(orgGUID, userGUID string) error

func (*Client) RemoveOrgAuditorByUsername

func (c *Client) RemoveOrgAuditorByUsername(orgGUID, name string) error

func (*Client) RemoveOrgManager

func (c *Client) RemoveOrgManager(orgGUID, userGUID string) error

func (*Client) RemoveOrgManagerByUsername

func (c *Client) RemoveOrgManagerByUsername(orgGUID, name string) error

func (*Client) RemoveOrgUser

func (c *Client) RemoveOrgUser(orgGUID, userGUID string) error

func (*Client) RemoveOrgUserByUsername

func (c *Client) RemoveOrgUserByUsername(orgGUID, name string) error

func (*Client) RemoveSpaceAuditorByUsername

func (c *Client) RemoveSpaceAuditorByUsername(spaceGUID, name string) error

func (*Client) RemoveSpaceDeveloperByUsername

func (c *Client) RemoveSpaceDeveloperByUsername(spaceGUID, name string) error

func (*Client) ServiceBindingByGuid

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

func (*Client) ServiceInstanceByGuid

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

func (*Client) TaskByGuid

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

func (*Client) TasksByApp

func (c *Client) TasksByApp(guid string) ([]Task, error)

TasksByApp returns task structures which aligned to an app identified by the given guid. See: http://v3-apidocs.cloudfoundry.org/version/3.12.0/index.html#list-tasks-for-an-app

func (*Client) TasksByAppByQuery

func (c *Client) TasksByAppByQuery(guid string, query url.Values) ([]Task, error)

TasksByAppByQuery returns task structures which aligned to an app identified by the given guid and filtered by the given query parameters. See: http://v3-apidocs.cloudfoundry.org/version/3.12.0/index.html#list-tasks-for-an-app

func (*Client) TerminateTask

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

TerminateTask cancels a task identified by its GUID.

func (*Client) TotalEvents

func (c *Client) TotalEvents() (int, error)

TotalEvents returns the number of unfiltered events.

func (*Client) TotalEventsByQuery

func (c *Client) TotalEventsByQuery(query url.Values) (int, error)

TotalEventsByQuery returns the number of events matching the provided query.

func (*Client) UnbindSecGroup

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

UnbindSecGroup contacts the CF endpoint to dissociate a space from a security group secGUID: identifies the security group to remove a space from spaceGUID: identifies the space to dissociate from the security group

func (*Client) UpdateSecGroup

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

UpdateSecGroup contacts the CF endpoint to update an existing security group. guid: identifies the security group that you would like to update. name: the new name to give to the security group rules: A slice of rule objects that describe the rules that this security group enforces.

If this is left nil, the rules will not be changed.

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

If nil, the space associations will not be changed.

func (*Client) UpdateServiceBroker

func (c *Client) UpdateServiceBroker(guid string, usb UpdateServiceBrokerRequest) (ServiceBroker, error)

func (*Client) UpdateServicePlanVisibility

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

func (*Client) UserProvidedServiceInstanceByGuid

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

type CloudFoundryError

type CloudFoundryError struct {
	Code        int    `json:"code"`
	ErrorCode   string `json:"error_code"`
	Description string `json:"description"`
}

func (CloudFoundryError) Error

func (cfErr CloudFoundryError) Error() string

type CloudFoundryErrors

type CloudFoundryErrors struct {
	Errors []CloudFoundryError `json:"errors"`
}

func (CloudFoundryErrors) Error

func (cfErrs CloudFoundryErrors) Error() string

type Config

type Config struct {
	ApiAddress        string `json:"api_url"`
	Username          string `json:"user"`
	Password          string `json:"password"`
	ClientID          string `json:"client_id"`
	ClientSecret      string `json:"client_secret"`
	SkipSslValidation bool   `json:"skip_ssl_validation"`
	HttpClient        *http.Client
	Token             string `json:"auth_token"`
	TokenSource       oauth2.TokenSource

	UserAgent string `json:"user_agent"`
	// contains filtered or unexported fields
}

Config is used to configure the creation of a client

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig configuration for client Keep LoginAdress for backward compatibility Need to be remove in close future

type CreateServiceBrokerRequest

type CreateServiceBrokerRequest struct {
	Name      string `json:"name"`
	BrokerURL string `json:"broker_url"`
	Username  string `json:"auth_username"`
	Password  string `json:"auth_password"`
	SpaceGUID string `json:"space_guid,omitempty"`
}

type CreateServiceKeyRequest

type CreateServiceKeyRequest struct {
	Name                string      `json:"name"`
	ServiceInstanceGuid string      `json:"service_instance_guid"`
	Parameters          interface{} `json:"parameters,omitempty"`
}

type Domain

type Domain struct {
	Guid                   string `json:"guid"`
	Name                   string `json:"name"`
	OwningOrganizationGuid string `json:"owning_organization_guid"`
	OwningOrganizationUrl  string `json:"owning_organization_url"`
	SharedOrganizationsUrl string `json:"shared_organizations_url"`
	// contains filtered or unexported fields
}

type DomainResource

type DomainResource struct {
	Meta   Meta   `json:"metadata"`
	Entity Domain `json:"entity"`
}

type DomainsResponse

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

type Endpoint

type Endpoint struct {
	DopplerEndpoint string `json:"doppler_logging_endpoint"`
	LoggingEndpoint string `json:"logging_endpoint"`
	AuthEndpoint    string `json:"authorization_endpoint"`
	TokenEndpoint   string `json:"token_endpoint"`
}

func DefaultEndpoint

func DefaultEndpoint() *Endpoint

type Event

type Event struct {
	GUID             string `json:"guid"`
	Type             string `json:"type"`
	CreatedAt        string `json:"created_at"`
	Actor            string `json:"actor"`
	ActorType        string `json:"actor_type"`
	ActorName        string `json:"actor_name"`
	ActorUsername    string `json:"actor_username"`
	Actee            string `json:"actee"`
	ActeeType        string `json:"actee_type"`
	ActeeName        string `json:"actee_name"`
	OrganizationGUID string `json:"organization_guid"`
	SpaceGUID        string `json:"space_guid"`
	// contains filtered or unexported fields
}

Event is a type that contains event data.

type EventResource

type EventResource struct {
	Meta   Meta  `json:"metadata"`
	Entity Event `json:"entity"`
}

EventResource is a type that contains metadata and the entity for an event.

type EventsResponse

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

EventsResponse is a type that wraps a collection of event resources.

type IsolationSegementResponse

type IsolationSegementResponse struct {
	GUID      string    `json:"guid"`
	Name      string    `json:"name"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	Links     struct {
		Self struct {
			Href string `json:"href"`
		} `json:"self"`
		Spaces struct {
			Href string `json:"href"`
		} `json:"spaces"`
		Organizations struct {
			Href string `json:"href"`
		} `json:"organizations"`
	} `json:"links"`
}

type IsolationSegment

type IsolationSegment struct {
	GUID      string    `json:"guid"`
	Name      string    `json:"name"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	// contains filtered or unexported fields
}

func (*IsolationSegment) AddOrg

func (i *IsolationSegment) AddOrg(orgGuid string) error

func (*IsolationSegment) AddSpace

func (i *IsolationSegment) AddSpace(spaceGuid string) error

func (*IsolationSegment) Delete

func (i *IsolationSegment) Delete() error

func (*IsolationSegment) RemoveOrg

func (i *IsolationSegment) RemoveOrg(orgGuid string) error

func (*IsolationSegment) RemoveSpace

func (i *IsolationSegment) RemoveSpace(spaceGuid string) error

type LastOperation

type LastOperation struct {
	Type        string `json:"type"`
	State       string `json:"state"`
	Description string `json:"description"`
	UpdatedAt   string `json:"updated_at"`
	CreatedAt   string `json:"created_at"`
}

type ListIsolationSegmentsResponse

type ListIsolationSegmentsResponse struct {
	Pagination Pagination                  `json:"pagination"`
	Resources  []IsolationSegementResponse `json:"resources"`
}

type Meta

type Meta struct {
	Guid      string `json:"guid"`
	Url       string `json:"url"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type Org

type Org struct {
	Guid                string `json:"guid"`
	CreatedAt           string `json:"created_at"`
	UpdatedAt           string `json:"updated_at"`
	Name                string `json:"name"`
	QuotaDefinitionGuid string `json:"quota_definition_guid"`
	// contains filtered or unexported fields
}

func (*Org) AssociateAuditor

func (o *Org) AssociateAuditor(userGUID string) (Org, error)

func (*Org) AssociateAuditorByUsername

func (o *Org) AssociateAuditorByUsername(name string) (Org, error)

func (*Org) AssociateManager

func (o *Org) AssociateManager(userGUID string) (Org, error)

func (*Org) AssociateManagerByUsername

func (o *Org) AssociateManagerByUsername(name string) (Org, error)

func (*Org) AssociateUser

func (o *Org) AssociateUser(userGUID string) (Org, error)

func (*Org) AssociateUserByUsername

func (o *Org) AssociateUserByUsername(name string) (Org, error)

func (*Org) Quota

func (o *Org) Quota() (*OrgQuota, error)

func (*Org) RemoveAuditor

func (o *Org) RemoveAuditor(userGUID string) error

func (*Org) RemoveAuditorByUsername

func (o *Org) RemoveAuditorByUsername(name string) error

func (*Org) RemoveManager

func (o *Org) RemoveManager(userGUID string) error

func (*Org) RemoveManagerByUsername

func (o *Org) RemoveManagerByUsername(name string) error

func (*Org) RemoveUser

func (o *Org) RemoveUser(userGUID string) error

func (*Org) RemoveUserByUsername

func (o *Org) RemoveUserByUsername(name string) error

func (*Org) Summary

func (o *Org) Summary() (OrgSummary, error)

type OrgAuditorResponse

type OrgAuditorResponse struct {
	Count     int            `json:"total_results"`
	Pages     int            `json:"total_pages"`
	NextURL   string         `json:"next_url"`
	Resources []UserResource `json:"resources"`
}

type OrgManagerResponse

type OrgManagerResponse struct {
	Count     int            `json:"total_results"`
	Pages     int            `json:"total_pages"`
	NextURL   string         `json:"next_url"`
	Resources []UserResource `json:"resources"`
}

type OrgQuota

type OrgQuota struct {
	Guid                    string `json:"guid"`
	Name                    string `json:"name"`
	NonBasicServicesAllowed bool   `json:"non_basic_services_allowed"`
	TotalServices           int    `json:"total_services"`
	TotalRoutes             int    `json:"total_routes"`
	TotalPrivateDomains     int    `json:"total_private_domains"`
	MemoryLimit             int    `json:"memory_limit"`
	TrialDBAllowed          bool   `json:"trial_db_allowed"`
	InstanceMemoryLimit     int    `json:"instance_memory_limit"`
	AppInstanceLimit        int    `json:"app_instance_limit"`
	AppTaskLimit            int    `json:"app_task_limit"`
	TotalServiceKeys        int    `json:"total_service_keys"`
	TotalReservedRoutePorts int    `json:"total_reserved_route_ports"`
	// contains filtered or unexported fields
}

type OrgQuotasResource

type OrgQuotasResource struct {
	Meta   Meta     `json:"metadata"`
	Entity OrgQuota `json:"entity"`
}

type OrgQuotasResponse

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

type OrgRequest

type OrgRequest struct {
	Name                string `json:"name"`
	Status              string `json:"status,omitempty"`
	QuotaDefinitionGuid string `json:"quota_definition_guid,omitempty"`
}

type OrgResource

type OrgResource struct {
	Meta   Meta `json:"metadata"`
	Entity Org  `json:"entity"`
}

type OrgResponse

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

type OrgSummary

type OrgSummary struct {
	Guid   string             `json:"guid"`
	Name   string             `json:"name"`
	Status string             `json:"status"`
	Spaces []OrgSummarySpaces `json:"spaces"`
}

type OrgSummarySpaces

type OrgSummarySpaces struct {
	Guid         string `json:"guid"`
	Name         string `json:"name"`
	ServiceCount int    `json:"service_count"`
	AppCount     int    `json:"app_count"`
	MemDevTotal  int    `json:"mem_dev_total"`
	MemProdTotal int    `json:"mem_prod_total"`
}

type Pagination

type Pagination struct {
	TotalResults int `json:"total_results"`
	TotalPages   int `json:"total_pages"`
	First        struct {
		Href string `json:"href"`
	} `json:"first"`
	Last struct {
		Href string `json:"href"`
	} `json:"last"`
	Next     string `json:"next"`
	Previous string `json:"previous"`
}

type Route

type Route struct {
	Guid                string `json:"guid"`
	Host                string `json:"host"`
	Path                string `json:"path"`
	DomainGuid          string `json:"domain_guid"`
	SpaceGuid           string `json:"space_guid"`
	ServiceInstanceGuid string `json:"service_instance_guid"`
	Port                int    `json:"port"`
	// contains filtered or unexported fields
}

type RouteRequest

type RouteRequest struct {
	DomainGuid string `json:"domain_guid"`
	SpaceGuid  string `json:"space_guid"`
}

type RoutesResource

type RoutesResource struct {
	Meta   Meta  `json:"metadata"`
	Entity Route `json:"entity"`
}

type RoutesResponse

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

type SecGroup

type SecGroup struct {
	Guid       string          `json:"guid"`
	Name       string          `json:"name"`
	Rules      []SecGroupRule  `json:"rules"`
	Running    bool            `json:"running_default"`
	Staging    bool            `json:"staging_default"`
	SpacesURL  string          `json:"spaces_url"`
	SpacesData []SpaceResource `json:"spaces"`
	// contains filtered or unexported fields
}

func (*SecGroup) ListSpaceResources

func (secGroup *SecGroup) ListSpaceResources() ([]SpaceResource, error)

type SecGroupCreateResponse

type SecGroupCreateResponse struct {
	Code        int    `json:"code"`
	ErrorCode   string `json:"error_code"`
	Description string `json:"description"`
}

type SecGroupResource

type SecGroupResource struct {
	Meta   Meta     `json:"metadata"`
	Entity SecGroup `json:"entity"`
}

type SecGroupResponse

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

type SecGroupRule

type SecGroupRule struct {
	Protocol    string `json:"protocol"`
	Ports       string `json:"ports,omitempty"`       //e.g. "4000-5000,9142"
	Destination string `json:"destination"`           //CIDR Format
	Description string `json:"description,omitempty"` //Optional description
	Code        int    `json:"code"`                  // ICMP code
	Type        int    `json:"type"`                  //ICMP type. Only valid if Protocol=="icmp"
	Log         bool   `json:"log,omitempty"`         //If true, log this rule
}

type Service

type Service struct {
	Guid              string   `json:"guid"`
	Label             string   `json:"label"`
	Description       string   `json:"description"`
	Active            bool     `json:"active"`
	Bindable          bool     `json:"bindable"`
	ServiceBrokerGuid string   `json:"service_broker_guid"`
	PlanUpdateable    bool     `json:"plan_updateable"`
	Tags              []string `json:"tags"`
	// contains filtered or unexported fields
}

type ServiceBinding

type ServiceBinding struct {
	Guid                string      `json:"guid"`
	AppGuid             string      `json:"app_guid"`
	ServiceInstanceGuid string      `json:"service_instance_guid"`
	Credentials         interface{} `json:"credentials"`
	BindingOptions      interface{} `json:"binding_options"`
	GatewayData         interface{} `json:"gateway_data"`
	GatewayName         string      `json:"gateway_name"`
	SyslogDrainUrl      string      `json:"syslog_drain_url"`
	VolumeMounts        interface{} `json:"volume_mounts"`
	AppUrl              string      `json:"app_url"`
	ServiceInstanceUrl  string      `json:"service_instance_url"`
	// contains filtered or unexported fields
}

type ServiceBindingResource

type ServiceBindingResource struct {
	Meta   Meta           `json:"metadata"`
	Entity ServiceBinding `json:"entity"`
}

type ServiceBindingsResponse

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

type ServiceBroker

type ServiceBroker struct {
	Guid      string `json:"guid"`
	Name      string `json:"name"`
	BrokerURL string `json:"broker_url"`
	Username  string `json:"auth_username"`
	Password  string `json:"auth_password"`
	SpaceGUID string `json:"space_guid,omitempty"`
	// contains filtered or unexported fields
}

type ServiceBrokerResource

type ServiceBrokerResource struct {
	Meta   Meta          `json:"metadata"`
	Entity ServiceBroker `json:"entity"`
}

type ServiceBrokerResponse

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

type ServiceInstance

type ServiceInstance struct {
	Name               string                 `json:"name"`
	CreatedAt          string                 `json:"created_at"`
	UpdatedAt          string                 `json:"updated_at"`
	Credentials        map[string]interface{} `json:"credentials"`
	ServicePlanGuid    string                 `json:"service_plan_guid"`
	SpaceGuid          string                 `json:"space_guid"`
	DashboardUrl       string                 `json:"dashboard_url"`
	Type               string                 `json:"type"`
	LastOperation      LastOperation          `json:"last_operation"`
	Tags               []string               `json:"tags"`
	ServiceGuid        string                 `json:"service_guid"`
	SpaceUrl           string                 `json:"space_url"`
	ServicePlanUrl     string                 `json:"service_plan_url"`
	ServiceBindingsUrl string                 `json:"service_bindings_url"`
	ServiceKeysUrl     string                 `json:"service_keys_url"`
	RoutesUrl          string                 `json:"routes_url"`
	ServiceUrl         string                 `json:"service_url"`
	Guid               string                 `json:"guid"`
	// contains filtered or unexported fields
}

type ServiceInstanceRequest

type ServiceInstanceRequest struct {
	Name            string                 `json:"name"`
	SpaceGuid       string                 `json:"space_guid"`
	ServicePlanGuid string                 `json:"service_plan_guid"`
	Parameters      map[string]interface{} `json:"parameters,omitempty"`
	Tags            []string               `json:"tags,omitempty"`
}

type ServiceInstanceResource

type ServiceInstanceResource struct {
	Meta   Meta            `json:"metadata"`
	Entity ServiceInstance `json:"entity"`
}

type ServiceInstancesResponse

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

type ServiceKey

type ServiceKey struct {
	Name                string      `json:"name"`
	Guid                string      `json:"guid"`
	ServiceInstanceGuid string      `json:"service_instance_guid"`
	Credentials         interface{} `json:"credentials"`
	ServiceInstanceUrl  string      `json:"service_instance_url"`
	// contains filtered or unexported fields
}

type ServiceKeyResource

type ServiceKeyResource struct {
	Meta   Meta       `json:"metadata"`
	Entity ServiceKey `json:"entity"`
}

type ServiceKeysResponse

type ServiceKeysResponse struct {
	Count     int                  `json:"total_results"`
	Pages     int                  `json:"total_pages"`
	Resources []ServiceKeyResource `json:"resources"`
}

type ServiceOfferingEntity

type ServiceOfferingEntity struct {
	Label        string
	Description  string
	Provider     string        `json:"provider"`
	BrokerGUID   string        `json:"service_broker_guid"`
	Requires     []string      `json:"requires"`
	ServicePlans []interface{} `json:"service_plans"`
	Extra        ServiceOfferingExtra
}

type ServiceOfferingExtra

type ServiceOfferingExtra struct {
	DisplayName      string `json:"displayName"`
	DocumentationURL string `json:"documentationURL"`
	LongDescription  string `json:"longDescription"`
}

func (*ServiceOfferingExtra) UnmarshalJSON

func (resource *ServiceOfferingExtra) UnmarshalJSON(rawData []byte) error

type ServiceOfferingResource

type ServiceOfferingResource struct {
	Metadata Meta
	Entity   ServiceOfferingEntity
}

type ServiceOfferingResponse

type ServiceOfferingResponse struct {
	Count     int                       `json:"total_results"`
	Pages     int                       `json:"total_pages"`
	NextUrl   string                    `json:"next_url"`
	PrevUrl   string                    `json:"prev_url"`
	Resources []ServiceOfferingResource `json:"resources"`
}

type ServicePlan

type ServicePlan struct {
	Name                string      `json:"name"`
	Guid                string      `json:"guid"`
	Free                bool        `json:"free"`
	Description         string      `json:"description"`
	ServiceGuid         string      `json:"service_guid"`
	Extra               interface{} `json:"extra"`
	UniqueId            string      `json:"unique_id"`
	Public              bool        `json:"public"`
	Active              bool        `json:"active"`
	Bindable            bool        `json:"bindable"`
	ServiceUrl          string      `json:"service_url"`
	ServiceInstancesUrl string      `json:"service_instances_url"`
	// contains filtered or unexported fields
}

type ServicePlanEntity

type ServicePlanEntity struct {
	Name                string                  `json:"name"`
	Free                bool                    `json:"free"`
	Public              bool                    `json:"public"`
	Active              bool                    `json:"active"`
	Description         string                  `json:"description"`
	ServiceOfferingGUID string                  `json:"service_guid"`
	ServiceOffering     ServiceOfferingResource `json:"service"`
}

type ServicePlanResource

type ServicePlanResource struct {
	Meta   Meta        `json:"metadata"`
	Entity ServicePlan `json:"entity"`
}

type ServicePlanVisibilitiesResponse

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

type ServicePlanVisibility

type ServicePlanVisibility struct {
	Guid             string `json:"guid"`
	ServicePlanGuid  string `json:"service_plan_guid"`
	OrganizationGuid string `json:"organization_guid"`
	ServicePlanUrl   string `json:"service_plan_url"`
	OrganizationUrl  string `json:"organization_url"`
	// contains filtered or unexported fields
}

type ServicePlanVisibilityResource

type ServicePlanVisibilityResource struct {
	Meta   Meta                  `json:"metadata"`
	Entity ServicePlanVisibility `json:"entity"`
}

type ServicePlansResponse

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

type ServiceSummary

type ServiceSummary struct {
	Guid          string `json:"guid"`
	Name          string `json:"name"`
	BoundAppCount int    `json:"bound_app_count"`
}

type ServicesResource

type ServicesResource struct {
	Meta   Meta    `json:"metadata"`
	Entity Service `json:"entity"`
}

type ServicesResponse

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

type SharedDomain

type SharedDomain struct {
	Guid            string `json:"guid"`
	Name            string `json:"name"`
	RouterGroupGuid string `json:"router_group_guid"`
	RouterGroupType string `json:"router_group_type"`
	// contains filtered or unexported fields
}

type SharedDomainResource

type SharedDomainResource struct {
	Meta   Meta         `json:"metadata"`
	Entity SharedDomain `json:"entity"`
}

type SharedDomainsResponse

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

type Space

type Space struct {
	Guid                string      `json:"guid"`
	CreatedAt           string      `json:"created_at"`
	UpdatedAt           string      `json:"updated_at"`
	Name                string      `json:"name"`
	OrganizationGuid    string      `json:"organization_guid"`
	OrgURL              string      `json:"organization_url"`
	OrgData             OrgResource `json:"organization"`
	QuotaDefinitionGuid string      `json:"space_quota_definition_guid"`
	AllowSSH            bool        `json:"allow_ssh"`
	// contains filtered or unexported fields
}

func (*Space) AssociateAuditorByUsername

func (s *Space) AssociateAuditorByUsername(name string) (Space, error)

func (*Space) AssociateDeveloperByUsername

func (s *Space) AssociateDeveloperByUsername(name string) (Space, error)

func (*Space) GetServiceOfferings

func (s *Space) GetServiceOfferings() (ServiceOfferingResponse, error)

func (*Space) Org

func (s *Space) Org() (Org, error)

func (*Space) Quota

func (s *Space) Quota() (*SpaceQuota, error)

func (*Space) RemoveAuditorByUsername

func (s *Space) RemoveAuditorByUsername(name string) error

func (*Space) RemoveDeveloperByUsername

func (s *Space) RemoveDeveloperByUsername(name string) error

func (*Space) Roles

func (s *Space) Roles() ([]SpaceRole, error)

func (*Space) Summary

func (s *Space) Summary() (SpaceSummary, error)

type SpaceAuditorResponse

type SpaceAuditorResponse struct {
	Count     int            `json:"total_results"`
	Pages     int            `json:"total_pages"`
	NextURL   string         `json:"next_url"`
	Resources []UserResource `json:"resources"`
}

type SpaceDeveloperResponse

type SpaceDeveloperResponse struct {
	Count     int            `json:"total_results"`
	Pages     int            `json:"total_pages"`
	NextURL   string         `json:"next_url"`
	Resources []UserResource `json:"resources"`
}

type SpaceManagerResponse

type SpaceManagerResponse struct {
	Count     int            `json:"total_results"`
	Pages     int            `json:"total_pages"`
	NextURL   string         `json:"next_url"`
	Resources []UserResource `json:"resources"`
}

type SpaceQuota

type SpaceQuota struct {
	Guid                    string `json:"guid"`
	Name                    string `json:"name"`
	OrganizationGuid        string `json:"organization_guid"`
	NonBasicServicesAllowed bool   `json:"non_basic_services_allowed"`
	TotalServices           int    `json:"total_services"`
	TotalRoutes             int    `json:"total_routes"`
	MemoryLimit             int    `json:"memory_limit"`
	InstanceMemoryLimit     int    `json:"instance_memory_limit"`
	AppInstanceLimit        int    `json:"app_instance_limit"`
	AppTaskLimit            int    `json:"app_task_limit"`
	TotalServiceKeys        int    `json:"total_service_keys"`
	TotalReservedRoutePorts int    `json:"total_reserved_route_ports"`
	// contains filtered or unexported fields
}

type SpaceQuotasResource

type SpaceQuotasResource struct {
	Meta   Meta       `json:"metadata"`
	Entity SpaceQuota `json:"entity"`
}

type SpaceQuotasResponse

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

type SpaceRequest

type SpaceRequest struct {
	Name               string   `json:"name"`
	OrganizationGuid   string   `json:"organization_guid"`
	DeveloperGuid      []string `json:"developer_guids,omitempty"`
	ManagerGuid        []string `json:"manager_guids,omitempty"`
	AuditorGuid        []string `json:"auditor_guids,omitempty"`
	DomainGuid         []string `json:"domain_guids,omitempty"`
	SecurityGroupGuids []string `json:"security_group_guids,omitempty"`
	SpaceQuotaDefGuid  string   `json:"space_quota_definition_guid,omitempty"`
	AllowSSH           bool     `json:"allow_ssh,omitempty"`
}

type SpaceResource

type SpaceResource struct {
	Meta   Meta  `json:"metadata"`
	Entity Space `json:"entity"`
}

type SpaceResponse

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

type SpaceRole

type SpaceRole struct {
	Guid                           string   `json:"guid"`
	Admin                          bool     `json:"admin"`
	Active                         bool     `json:"active"`
	DefaultSpaceGuid               string   `json:"default_space_guid"`
	Username                       string   `json:"username"`
	SpaceRoles                     []string `json:"space_roles"`
	SpacesUrl                      string   `json:"spaces_url"`
	OrganizationsUrl               string   `json:"organizations_url"`
	ManagedOrganizationsUrl        string   `json:"managed_organizations_url"`
	BillingManagedOrganizationsUrl string   `json:"billing_managed_organizations_url"`
	AuditedOrganizationsUrl        string   `json:"audited_organizations_url"`
	ManagedSpacesUrl               string   `json:"managed_spaces_url"`
	AuditedSpacesUrl               string   `json:"audited_spaces_url"`
	// contains filtered or unexported fields
}

type SpaceRoleResource

type SpaceRoleResource struct {
	Meta   Meta      `json:"metadata"`
	Entity SpaceRole `json:"entity"`
}

type SpaceRoleResponse

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

type SpaceSummary

type SpaceSummary struct {
	Guid     string           `json:"guid"`
	Name     string           `json:"name"`
	Apps     []AppSummary     `json:"apps"`
	Services []ServiceSummary `json:"services"`
}

type Stack

type Stack struct {
	Guid        string `json:"guid"`
	Name        string `json:"name"`
	Description string `json:"description"`
	// contains filtered or unexported fields
}

type StacksResource

type StacksResource struct {
	Meta   Meta  `json:"metadata"`
	Entity Stack `json:"entity"`
}

type StacksResponse

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

type Task

type Task struct {
	GUID       string `json:"guid"`
	SequenceID int    `json:"sequence_id"`
	Name       string `json:"name"`
	Command    string `json:"command"`
	State      string `json:"state"`
	MemoryInMb int    `json:"memory_in_mb"`
	DiskInMb   int    `json:"disk_in_mb"`
	Result     struct {
		FailureReason string `json:"failure_reason"`
	} `json:"result"`
	CreatedAt   time.Time `json:"created_at"`
	UpdatedAt   time.Time `json:"updated_at"`
	DropletGUID string    `json:"droplet_guid"`
	Links       struct {
		Self struct {
			Href string `json:"href"`
		} `json:"self"`
		App struct {
			Href string `json:"href"`
		} `json:"app"`
		Droplet struct {
			Href string `json:"href"`
		} `json:"droplet"`
	} `json:"links"`
}

Task is a description of a task element.

type TaskListResponse

type TaskListResponse struct {
	Pagination struct {
		TotalResults int `json:"total_results"`
		TotalPages   int `json:"total_pages"`
		First        struct {
			Href string `json:"href"`
		} `json:"first"`
		Last struct {
			Href string `json:"href"`
		} `json:"last"`
		Next     interface{} `json:"next"`
		Previous interface{} `json:"previous"`
	} `json:"pagination"`
	Tasks []Task `json:"resources"`
}

TaskListResponse is the JSON response from the API.

type TaskRequest

type TaskRequest struct {
	Command          string `json:"command"`
	Name             string `json:"name"`
	MemoryInMegabyte int    `json:"memory_in_mb"`
	DiskInMegabyte   int    `json:"disk_in_mb"`
	DropletGUID      string `json:"droplet_guid"`
}

TaskRequest is a v3 JSON object as described in: http://v3-apidocs.cloudfoundry.org/version/3.0.0/index.html#create-a-task

type UpdateServiceBrokerRequest

type UpdateServiceBrokerRequest struct {
	Name      string `json:"name"`
	BrokerURL string `json:"broker_url"`
	Username  string `json:"auth_username"`
	Password  string `json:"auth_password"`
}

type User

type User struct {
	Guid                  string `json:"guid"`
	CreatedAt             string `json:"created_at"`
	UpdatedAt             string `json:"updated_at"`
	Admin                 bool   `json:"admin"`
	Active                bool   `json:"active"`
	DefaultSpaceGUID      string `json:"default_space_guid"`
	Username              string `json:"username"`
	SpacesURL             string `json:"spaces_url"`
	OrgsURL               string `json:"organizations_url"`
	ManagedOrgsURL        string `json:"managed_organizations_url"`
	BillingManagedOrgsURL string `json:"billing_managed_organizations_url"`
	AuditedOrgsURL        string `json:"audited_organizations_url"`
	ManagedSpacesURL      string `json:"managed_spaces_url"`
	AuditedSpacesURL      string `json:"audited_spaces_url"`
	// contains filtered or unexported fields
}

type UserProvidedServiceInstance

type UserProvidedServiceInstance struct {
	Name               string                 `json:"name"`
	Credentials        map[string]interface{} `json:"credentials"`
	SpaceGuid          string                 `json:"space_guid"`
	Type               string                 `json:"type"`
	Tags               []string               `json:"tags"`
	SpaceUrl           string                 `json:"space_url"`
	ServiceBindingsUrl string                 `json:"service_bindings_url"`
	RoutesUrl          string                 `json:"routes_url"`
	RouteServiceUrl    string                 `json:"route_service_url"`
	SyslogDrainUrl     string                 `json:"syslog_drain_url"`
	Guid               string                 `json:"guid"`
	// contains filtered or unexported fields
}

type UserProvidedServiceInstanceResource

type UserProvidedServiceInstanceResource struct {
	Meta   Meta                        `json:"metadata"`
	Entity UserProvidedServiceInstance `json:"entity"`
}

type UserProvidedServiceInstancesResponse

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

type UserRequest

type UserRequest struct {
	Guid             string `json:"guid"`
	DefaultSpaceGuid string `json:"default_space_guid,omitempty"`
}

type UserResource

type UserResource struct {
	Meta   Meta `json:"metadata"`
	Entity User `json:"entity"`
}

type UserResponse

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

type Users

type Users []User

func (Users) GetUserByUsername

func (u Users) GetUserByUsername(username string) User

Jump to

Keyboard shortcuts

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