Documentation ¶
Overview ¶
Package cloudcontroller contains shared utilies between the V2 and V3 clients.
These sets of packages are still under development/pre-pre-pre...alpha. Use at your own risk! Functionality and design may change without warning.
Where are the clients?
These clients live in ccv2 and ccv3 packages. Each of them only works with the V2 and V3 api respectively.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DecodeJSON ¶
DecodeJSON unmarshals JSON into the given object with the appropriate settings.
func MinimumAPIVersionCheck ¶
MinimumAPIVersionCheck compares `current` to `minimum`. If `current` is older than `minimum` then an error is returned; otherwise, nil is returned.
Types ¶
type CloudControllerConnection ¶
CloudControllerConnection represents a connection to the Cloud Controller server.
func NewConnection ¶
func NewConnection(config Config) *CloudControllerConnection
NewConnection returns a new CloudControllerConnection with provided configuration.
type Connection ¶
Connection creates and executes http requests
type Pipebomb ¶
type Pipebomb struct {
io.ReadCloser
}
Pipebomb is a wrapper around an io.Pipe's io.ReadCloser that turns it into a ReadSeeker that errors on Seek calls. This is designed to prevent the caller from rereading the body multiple times.
func NewPipeBomb ¶
func NewPipeBomb() (*Pipebomb, io.WriteCloser)
NewPipeBomb returns an io.WriteCloser that can be used to stream data to a the Pipebomb.
type Request ¶
Request represents the request of the cloud controller.
func NewRequest ¶
func NewRequest(request *http.Request, body io.ReadSeeker) *Request
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 // ResourceLocationURL represents the Location header value ResourceLocationURL string }
Response represents a Cloud Controller response object.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package ccv2 represents a Cloud Controller V2 client.
|
Package ccv2 represents a Cloud Controller V2 client. |
ccv2fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
constant
Package constant contains types and constants used by the ccv2 package.
|
Package constant contains types and constants used by the ccv2 package. |
Package ccv3 represents a Cloud Controller V3 client.
|
Package ccv3 represents a Cloud Controller V3 client. |
ccv3fakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
constant
Package constant contains types and constants used by the ccv3 package.
|
Package constant contains types and constants used by the ccv3 package. |
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
wrapperfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |