import "github.com/cloudfoundry/cli/api/cloudcontroller"
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.
cloud_controller_connection.go connection.go decode_json.go pipebomb.go request.go response.go
DecodeJSON unmarshals JSON into the given object with the appropriate settings.
CloudControllerConnection represents a connection to the Cloud Controller server.
func NewConnection(config Config) *CloudControllerConnection
NewConnection returns a new CloudControllerConnection with provided configuration.
func (connection *CloudControllerConnection) Make(request *Request, passedResponse *Response) error
Make performs the request and parses the response.
Config is for configuring a CloudControllerConnection.
Connection creates and executes http requests
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() (*Pipebomb, io.WriteCloser)
NewPipeBomb returns an io.WriteCloser that can be used to stream data to a the Pipebomb.
Seek returns a PipeSeekError; allowing the top level calling function to handle the retry instead of seeking back to the beginning of the Reader.
Request represents the request of the cloud controller.
type Response struct { // DecodeJSONResponseInto represents the resource entity type that is // expected in the response JSON. DecodeJSONResponseInto 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.
Path | Synopsis |
---|---|
ccerror | |
ccv2 | Package ccv2 represents a Cloud Controller V2 client. |
ccv2/ccv2fakes | Code generated by counterfeiter. |
ccv2/constant | Package constant contains types and constants used by the ccv2 package. |
ccv2/internal | |
ccv3 | Package ccv3 represents a Cloud Controller V3 client. |
ccv3/ccv3fakes | Code generated by counterfeiter. |
ccv3/constant | Package constant contains types and constants used by the ccv3 package. |
ccv3/internal | |
ccversion | |
cloudcontrollerfakes | Code generated by counterfeiter. |
uploads | |
wrapper | |
wrapper/util | |
wrapper/wrapperfakes | Code generated by counterfeiter. |
Package cloudcontroller imports 12 packages (graph). Updated 2021-01-26. Refresh now. Tools for package owners.