cloudcontroller

Documentation

Index

• type APINotFoundError
  • func (e APINotFoundError) Error() string
• type CloudControllerConnection
  • func NewConnection(config Config) *CloudControllerConnection
  • func (connection *CloudControllerConnection) Make(request *http.Request, passedResponse *Response) error
• type Config
• type Connection
• type ForbiddenError
  • func (e ForbiddenError) Error() string
• type InvalidAuthTokenError
  • func (e InvalidAuthTokenError) Error() string
• type NotFoundError
  • func (e NotFoundError) Error() string
• type RawHTTPStatusError
  • func (r RawHTTPStatusError) Error() string
• type RequestError
  • func (e RequestError) Error() string
• type ResourceNotFoundError
  • func (e ResourceNotFoundError) Error() string
• type Response
• type SSLValidationHostnameError
  • func (e SSLValidationHostnameError) Error() string
• type ServiceUnavailableError
  • func (e ServiceUnavailableError) Error() string
• type TaskWorkersUnavailableError
  • func (e TaskWorkersUnavailableError) Error() string
• type UnauthorizedError
  • func (e UnauthorizedError) Error() string
• type UnknownObjectInListError
  • func (e UnknownObjectInListError) Error() string
• type UnprocessableEntityError
  • func (e UnprocessableEntityError) Error() string
• type UnverifiedServerError
  • func (e UnverifiedServerError) Error() string

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 CloudControllerConnection

type CloudControllerConnection struct {
	HTTPClient *http.Client
	UserAgent  string
}

CloudControllerConnection represents a connection to the Cloud Controller server.

func NewConnection

func NewConnection(config Config) *CloudControllerConnection

NewConnection returns a new CloudControllerConnection with provided configuration.

func (*CloudControllerConnection) Make

func (connection *CloudControllerConnection) Make(request *http.Request, passedResponse *Response) error

Make performs the request and parses the response.

type Config

type Config struct {
	DialTimeout       time.Duration
	SkipSSLValidation bool
}

Config is for configuring a CloudControllerConnection.

type Connection

type Connection interface {
	Make(request *http.Request, passedResponse *Response) error
}

Connection creates and executes http requests

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

type NotFoundError struct {
	Message string
}

NotFoundError wraps a generic 404 error.

func (NotFoundError) Error

func (e NotFoundError) Error() string

type RawHTTPStatusError

type RawHTTPStatusError struct {
	StatusCode  int
	RawResponse []byte
	RequestIDs  []string
}

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 Response

type Response struct {
	// Result represents the resource entity type that is expected in the
	// response JSON.
	Result interface{}

	// RawResponse represents the response body.
	RawResponse []byte

	// Warnings represents warnings parsed from the custom warnings headers of a
	// Cloud Controller response.
	Warnings []string

	// HTTPResponse represents the HTTP response object.
	HTTPResponse *http.Response
}

Response represents a Cloud Controller response object.

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 {
	Message string
}

ServiceUnavailableError wraps a http 503 error.

func (ServiceUnavailableError) Error

func (e ServiceUnavailableError) Error() string

type TaskWorkersUnavailableError

type TaskWorkersUnavailableError struct {
	Message string
}

TaskWorkersUnavailableError represents the case when no Diego workers are available.

func (TaskWorkersUnavailableError) Error

func (e TaskWorkersUnavailableError) Error() string

type UnauthorizedError

type UnauthorizedError struct {
	Message string
}

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