Documentation
¶
Index ¶
- type APINotFoundError
- type ApplicationStoppedStatsError
- type BadRequestError
- type ForbiddenError
- type InstancesError
- type InvalidAuthTokenError
- type JobFailedError
- type JobTimeoutError
- type NotFoundError
- type NotStagedError
- type RawHTTPStatusError
- type RequestError
- type ResourceNotFoundError
- type SSLValidationHostnameError
- type ServiceUnavailableError
- type TaskWorkersUnavailableError
- type UnauthorizedError
- type UnknownObjectInListError
- type UnprocessableEntityError
- type UnverifiedServerError
- type UploadLinkNotFoundError
- type V2ErrorResponse
- type V2UnexpectedResponseError
- type V3Error
- type V3ErrorResponse
- 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 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 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 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 JobFailedError ¶
JobFailedError represents a failed Cloud Controller Job. It wraps the error returned back from the Cloud Controller.
func (JobFailedError) Error ¶
func (e JobFailedError) Error() string
type JobTimeoutError ¶
JobTimeoutError is returned from PollJob when the OverallPollingTimeout has been reached.
func (JobTimeoutError) Error ¶
func (e JobTimeoutError) Error() string
type NotFoundError ¶
type NotFoundError struct {
Message string
}
NotFoundError wraps a generic 404 error.
func (NotFoundError) Error ¶
func (e NotFoundError) 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 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 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 ServiceUnavailableError ¶
type ServiceUnavailableError struct {
}
ServiceUnavailableError wraps a http 503 error.
func (ServiceUnavailableError) Error ¶
func (e ServiceUnavailableError) 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 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 (e UnverifiedServerError) Error() string
type UploadLinkNotFoundError ¶
type UploadLinkNotFoundError struct {
PackageGUID string
}
func (UploadLinkNotFoundError) Error ¶
func (e UploadLinkNotFoundError) 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 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 int `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 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_stopped_stats_error.go
- bad_request_error.go
- forbidden_error.go
- instances_error.go
- invalid_auth_token_error.go
- job_failed_error.go
- job_timeout_error.go
- not_found_error.go
- not_staged_error.go
- raw_http_status_error.go
- request_error.go
- resource_not_found_error.go
- service_unavailable_error.go
- ssl_validation_hostname_error.go
- task_workers_unavailable_error.go
- unauthorized_error.go
- unknown_object_in_list_error.go
- unprocessable_entity_error.go
- unverified_server_error.go
- upload_link_not_found_error.go
- v2_unexpected_response_error.go
- v3_unexpected_response_error.go