Documentation
¶
Index ¶
- type APINotFoundError
- type ApplicationNotFoundError
- type ApplicationStoppedStatsError
- type BadRequestError
- type BuildpackAlreadyExistsForStackError
- type BuildpackInvalidError
- type BuildpackNameTakenError
- type BuildpackStackDoesNotExistError
- type BuildpackStacksDontMatchError
- type BuildpackZipInvalidError
- type DeploymentNotFoundError
- type DropletNotFoundError
- type FeatureFlagNotFoundError
- type ForbiddenError
- type InstanceNotFoundError
- type InstancesError
- type InvalidAuthTokenError
- type InvalidBuildpackError
- type InvalidRelationError
- type InvalidStartError
- type JobTimeoutError
- type MinimumAPIVersionNotMetError
- type MultiError
- type NameNotUniqueInOrgError
- type NameNotUniqueInSpaceError
- type NilObjectError
- type NotStagedError
- type OrganizationNameTakenError
- type PipeSeekError
- type ProcessNotFoundError
- type RawHTTPStatusError
- type RequestError
- type ResourceNotFoundError
- type RoleAlreadyExistsError
- type RouteNotUniqueError
- type SSLValidationHostnameError
- type ServiceBindingTakenError
- type ServiceBrokerBadResponseError
- type ServiceBrokerCatalogInvalidError
- type ServiceBrokerRequestRejectedError
- type ServiceInstanceNameTakenError
- type ServiceKeyTakenError
- type ServicePlanVisibilityExistsError
- type ServiceUnavailableError
- type SpaceNameTakenError
- type TaskWorkersUnavailableError
- type UnauthorizedError
- type UnknownHTTPSourceError
- type UnknownObjectInListError
- type UnprocessableEntityError
- type UnverifiedServerError
- type V2ErrorResponse
- type V2JobFailedError
- type V2UnexpectedResponseError
- type V3Error
- type V3ErrorResponse
- type V3JobFailedError
- type V3UnexpectedResponseError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APINotFoundError ¶
type APINotFoundError struct {
URL string
}
APINotFoundError is returned when the API endpoint is not found.
func (APINotFoundError) Error ¶
func (e APINotFoundError) Error() string
type ApplicationNotFoundError ¶
type ApplicationNotFoundError struct { }
ApplicationNotFoundError is returned when an endpoint cannot find the specified application
func (ApplicationNotFoundError) Error ¶
func (e ApplicationNotFoundError) Error() string
type ApplicationStoppedStatsError ¶
type ApplicationStoppedStatsError struct {
Message string
}
ApplicationStoppedStatsError is returned when requesting instance information from a stopped app.
func (ApplicationStoppedStatsError) Error ¶
func (e ApplicationStoppedStatsError) Error() string
type BadRequestError ¶
type BadRequestError struct {
Message string
}
BadRequestError is returned when the server says the request was bad.
func (BadRequestError) Error ¶
func (e BadRequestError) Error() string
type BuildpackAlreadyExistsForStackError ¶
type BuildpackAlreadyExistsForStackError struct {
Message string
}
func (BuildpackAlreadyExistsForStackError) Error ¶
func (e BuildpackAlreadyExistsForStackError) Error() string
type BuildpackInvalidError ¶
type BuildpackInvalidError struct {
Message string
}
func (BuildpackInvalidError) Error ¶
func (e BuildpackInvalidError) Error() string
type BuildpackNameTakenError ¶
type BuildpackNameTakenError struct {
Message string
}
func (BuildpackNameTakenError) Error ¶
func (e BuildpackNameTakenError) Error() string
type BuildpackStackDoesNotExistError ¶
type BuildpackStackDoesNotExistError struct {
Message string
}
func (BuildpackStackDoesNotExistError) Error ¶
func (e BuildpackStackDoesNotExistError) Error() string
type BuildpackStacksDontMatchError ¶
type BuildpackStacksDontMatchError struct {
Message string
}
func (BuildpackStacksDontMatchError) Error ¶
func (e BuildpackStacksDontMatchError) Error() string
type BuildpackZipInvalidError ¶
type BuildpackZipInvalidError struct {
Message string
}
func (BuildpackZipInvalidError) Error ¶
func (e BuildpackZipInvalidError) Error() string
type DeploymentNotFoundError ¶
type DeploymentNotFoundError struct { }
DeploymentNotFoundError is returned when an endpoint cannot find the specified deployment
func (DeploymentNotFoundError) Error ¶
func (e DeploymentNotFoundError) Error() string
type DropletNotFoundError ¶
type DropletNotFoundError struct { }
DropletNotFoundError is returned when an endpoint cannot find the specified application
func (DropletNotFoundError) Error ¶
func (e DropletNotFoundError) Error() string
type FeatureFlagNotFoundError ¶
type FeatureFlagNotFoundError struct { }
FeatureFlagNotFoundError is returned when the API endpoint is not found.
func (FeatureFlagNotFoundError) Error ¶
func (e FeatureFlagNotFoundError) Error() string
type ForbiddenError ¶
type ForbiddenError struct {
Message string
}
ForbiddenError is returned when the client is forbidden from executing the request.
func (ForbiddenError) Error ¶
func (e ForbiddenError) Error() string
type InstanceNotFoundError ¶
type InstanceNotFoundError struct { }
InstanceNotFoundError is returned when an endpoint cannot find the specified instance
func (InstanceNotFoundError) Error ¶
func (e InstanceNotFoundError) Error() string
type InstancesError ¶
type InstancesError struct {
Message string
}
InstancesError is returned when requesting instance information encounters an error.
func (InstancesError) Error ¶
func (e InstancesError) Error() string
type InvalidAuthTokenError ¶
type InvalidAuthTokenError struct {
Message string
}
InvalidAuthTokenError is returned when the client has an invalid authorization header.
func (InvalidAuthTokenError) Error ¶
func (e InvalidAuthTokenError) Error() string
type InvalidBuildpackError ¶
type InvalidBuildpackError struct { }
func (InvalidBuildpackError) Error ¶
func (e InvalidBuildpackError) Error() string
type InvalidRelationError ¶
type InvalidRelationError struct {
Message string
}
InvalidRelationError is returned when an association between two entities cannot be created.
func (InvalidRelationError) Error ¶
func (e InvalidRelationError) Error() string
type InvalidStartError ¶
type InvalidStartError struct { }
func (InvalidStartError) Error ¶
func (e InvalidStartError) Error() string
type JobTimeoutError ¶
JobTimeoutError is returned from PollJob when the OverallPollingTimeout has been reached.
func (JobTimeoutError) Error ¶
func (e JobTimeoutError) Error() string
type MinimumAPIVersionNotMetError ¶
func (MinimumAPIVersionNotMetError) Error ¶
func (e MinimumAPIVersionNotMetError) Error() string
type MultiError ¶
func (MultiError) Details ¶
func (e MultiError) Details() []string
func (MultiError) Error ¶
func (e MultiError) Error() string
type NameNotUniqueInOrgError ¶
type NameNotUniqueInOrgError struct { }
func (NameNotUniqueInOrgError) Error ¶
func (e NameNotUniqueInOrgError) Error() string
type NameNotUniqueInSpaceError ¶
type NameNotUniqueInSpaceError struct {
UnprocessableEntityError
}
type NilObjectError ¶
type NilObjectError struct {
Object string
}
NilObjectError gets returned when passed a nil object as a parameter.
func (NilObjectError) Error ¶
func (e NilObjectError) Error() string
type NotStagedError ¶
type NotStagedError struct {
Message string
}
NotStagedError is returned when requesting instance information from a not staged app.
func (NotStagedError) Error ¶
func (e NotStagedError) Error() string
type OrganizationNameTakenError ¶
type OrganizationNameTakenError struct {
UnprocessableEntityError
}
OrganizationNameTakenError is returned when an organization with the requested name already exists in the Cloud Controller.
type PipeSeekError ¶
type PipeSeekError struct { // Err is the error that caused the Seek to be called. Err error }
PipeSeekError is returned by Pipebomb when a Seek is called.
func (PipeSeekError) Error ¶
func (e PipeSeekError) Error() string
type ProcessNotFoundError ¶
type ProcessNotFoundError struct { }
ProcessNotFoundError is returned when an endpoint cannot find the specified process
func (ProcessNotFoundError) Error ¶
func (e ProcessNotFoundError) Error() string
type RawHTTPStatusError ¶
RawHTTPStatusError represents any response with a 4xx or 5xx status code.
func (RawHTTPStatusError) Error ¶
func (r RawHTTPStatusError) Error() string
type RequestError ¶
type RequestError struct {
Err error
}
RequestError represents a generic error encountered while performing the HTTP request. This generic error occurs before a HTTP response is obtained.
func (RequestError) Error ¶
func (e RequestError) Error() string
type ResourceNotFoundError ¶
type ResourceNotFoundError struct {
Message string
}
ResourceNotFoundError is returned when the client requests a resource that does not exist or does not have permissions to see.
func (ResourceNotFoundError) Error ¶
func (e ResourceNotFoundError) Error() string
type RoleAlreadyExistsError ¶
type RoleAlreadyExistsError struct {
UnprocessableEntityError
}
RoleAlreadyExistsError is returned when a role with the same type, user, and org or space already exists in the Cloud Controller.
type RouteNotUniqueError ¶
type RouteNotUniqueError struct {
UnprocessableEntityError
}
type SSLValidationHostnameError ¶
type SSLValidationHostnameError struct {
Message string
}
SSLValidationHostnameError replaces x509.HostnameError when the server has SSL certificate that does not match the hostname.
func (SSLValidationHostnameError) Error ¶
func (e SSLValidationHostnameError) Error() string
type ServiceBindingTakenError ¶
type ServiceBindingTakenError struct {
Message string
}
ServiceBindingTakenError is returned when creating a service binding that already exists
func (ServiceBindingTakenError) Error ¶
func (e ServiceBindingTakenError) Error() string
type ServiceBrokerBadResponseError ¶
type ServiceBrokerBadResponseError struct {
Message string
}
ServiceBrokerBadResponseError is returned when CC returns an error of type CF-ServiceBrokerBadResponse.
func (ServiceBrokerBadResponseError) Error ¶
func (e ServiceBrokerBadResponseError) Error() string
type ServiceBrokerCatalogInvalidError ¶
type ServiceBrokerCatalogInvalidError struct {
Message string
}
func (ServiceBrokerCatalogInvalidError) Error ¶
func (e ServiceBrokerCatalogInvalidError) Error() string
type ServiceBrokerRequestRejectedError ¶
type ServiceBrokerRequestRejectedError struct {
Message string
}
ServiceBrokerRequestRejectedError is returned when CC returns an error of type CF-ServiceBrokerRequestRejected.
func (ServiceBrokerRequestRejectedError) Error ¶
func (e ServiceBrokerRequestRejectedError) Error() string
type ServiceInstanceNameTakenError ¶
type ServiceInstanceNameTakenError struct {
Message string
}
ServiceInstanceNameTakenError is returned when creating a service instance that already exists.
func (ServiceInstanceNameTakenError) Error ¶
func (e ServiceInstanceNameTakenError) Error() string
type ServiceKeyTakenError ¶
type ServiceKeyTakenError struct {
Message string
}
ServiceKeyTakenError is returned when creating a service key that already exists
func (ServiceKeyTakenError) Error ¶
func (e ServiceKeyTakenError) Error() string
type ServicePlanVisibilityExistsError ¶
type ServicePlanVisibilityExistsError struct {
Message string
}
ServicePlanVisibilityExistsError is returned when creating a service plan visibility that already exists
func (ServicePlanVisibilityExistsError) Error ¶
func (e ServicePlanVisibilityExistsError) Error() string
type ServiceUnavailableError ¶
type ServiceUnavailableError struct {
}ServiceUnavailableError wraps a http 503 error.
func (ServiceUnavailableError) Error ¶
func (e ServiceUnavailableError) Error() string
type SpaceNameTakenError ¶
type SpaceNameTakenError struct {
Message string
}
SpaceNameTakenError is returned when creating a space that already exists.
func (SpaceNameTakenError) Error ¶
func (e SpaceNameTakenError) Error() string
type TaskWorkersUnavailableError ¶
type TaskWorkersUnavailableError struct {
}TaskWorkersUnavailableError represents the case when no Diego workers are available.
func (TaskWorkersUnavailableError) Error ¶
func (e TaskWorkersUnavailableError) Error() string
type UnauthorizedError ¶
type UnauthorizedError struct {
}UnauthorizedError is returned when the client does not have the correct permissions to execute the request.
func (UnauthorizedError) Error ¶
func (e UnauthorizedError) Error() string
type UnknownHTTPSourceError ¶
UnknownHTTPSourceError represents HTTP responses with status code >= 400 that we cannot unmarshal into a {V2,V3}ErrorResponse. Ex: In "cf api google.com", google will return a 404, but the body will not match an error from the Cloud Controller
func (UnknownHTTPSourceError) Error ¶
func (r UnknownHTTPSourceError) Error() string
type UnknownObjectInListError ¶
type UnknownObjectInListError struct { Expected interface{} Unexpected interface{} }
UnknownObjectInListError is returned when iterating through a paginated list. Assuming tests are written for the paginated function, this should be impossible to get.
func (UnknownObjectInListError) Error ¶
func (e UnknownObjectInListError) Error() string
type UnprocessableEntityError ¶
type UnprocessableEntityError struct {
Message string
}
UnprocessableEntityError is returned when the request cannot be processed by the cloud controller.
func (UnprocessableEntityError) Error ¶
func (e UnprocessableEntityError) Error() string
type UnverifiedServerError ¶
type UnverifiedServerError struct {
URL string
}
UnverifiedServerError replaces x509.UnknownAuthorityError when the server has SSL but the client is unable to verify it's certificate
func (UnverifiedServerError) Error ¶
func (UnverifiedServerError) Error() string
type V2ErrorResponse ¶
type V2ErrorResponse struct { Code int `json:"code"` Description string `json:"description"` ErrorCode string `json:"error_code"` }
V2ErrorResponse represents a generic Cloud Controller V2 error response.
type V2JobFailedError ¶
V2JobFailedError represents a failed Cloud Controller Job. It wraps the error returned back from the Cloud Controller.
func (V2JobFailedError) Error ¶
func (e V2JobFailedError) Error() string
type V2UnexpectedResponseError ¶
type V2UnexpectedResponseError struct { V2ErrorResponse RequestIDs []string ResponseCode int }
V2UnexpectedResponseError is returned when the client gets an error that has not been accounted for.
func (V2UnexpectedResponseError) Error ¶
func (e V2UnexpectedResponseError) Error() string
type V3Error ¶
type V3Error struct { Code int64 `json:"code"` Detail string `json:"detail"` Title string `json:"title"` }
V3Error represents a cloud controller error.
type V3ErrorResponse ¶
type V3ErrorResponse struct {
Errors []V3Error `json:"errors"`
}
V3ErrorResponse represents a generic Cloud Controller V3 error response.
type V3JobFailedError ¶
type V3JobFailedError struct { JobGUID string // Code is a numeric code for this error. Code constant.JobErrorCode `json:"code"` // Detail is a verbose description of the error. Detail string `json:"detail"` // Title is a short description of the error. Title string `json:"title"` }
V3JobFailedError represents a failed Cloud Controller Job. It wraps the error returned back from the Cloud Controller.
func (V3JobFailedError) Error ¶
func (e V3JobFailedError) Error() string
type V3UnexpectedResponseError ¶
type V3UnexpectedResponseError struct { V3ErrorResponse ResponseCode int RequestIDs []string }
V3UnexpectedResponseError is returned when the client gets an error that has not been accounted for.
func (V3UnexpectedResponseError) Error ¶
func (e V3UnexpectedResponseError) Error() string
Source Files
¶
- api_not_found_error.go
- application_not_found_error.go
- application_stopped_stats_error.go
- bad_request_error.go
- buildpack_already_exists_for_stack_error.go
- buildpack_invalid_error.go
- buildpack_name_taken_error.go
- buildpack_stack_does_not_exist_error.go
- buildpack_stacks_dont_match_error.go
- buildpack_zip_invalid_error.go
- deployment_not_found_error.go
- droplet_not_found_error.go
- feature_flag_not_found_error.go
- forbidden_error.go
- instance_not_found_error.go
- instances_error.go
- invalid_auth_token_error.go
- invalid_buildpack_error.go
- invalid_relation_error.go
- invalid_start_error.go
- job_timeout_error.go
- minimum_api_version_not_met_error.go
- multi_error.go
- name_not_unique_in_org_error.go
- name_not_unique_in_space_error.go
- nil_object_error.go
- not_staged_error.go
- organization_name_taken_error.go
- pipe_seek_error.go
- process_not_found_error.go
- raw_http_status_error.go
- request_error.go
- resource_not_found_error.go
- role_already_exists_error.go
- route_not_unique_error.go
- service_binding_taken_error.go
- service_broker_bad_response_error.go
- service_broker_catalog_invalid_error.go
- service_broker_request_rejected_error.go
- service_instance_name_taken_error.go
- service_key_taken_error.go
- service_plan_visibility_exists_error.go
- service_unavailable_error.go
- space_name_taken_error.go
- ssl_validation_hostname_error.go
- task_workers_unavailable_error.go
- unauthorized_error.go
- unknown_http_source_error.go
- unknown_object_in_list_error.go
- unprocessable_entity_error.go
- unverified_server_error.go
- v2_job_failed_error.go
- v2_unexpected_response_error.go
- v3_error.go
- v3_job_failed_error.go
- v3_unexpected_response_error.go