package
6.41.0+incompatible
Repository: https://github.com/randomtask1155/cli.git
Documentation: pkg.go.dev

# Packages

Code generated by counterfeiter.
Package constant contains types and constants used by the ccv3 package.

# Functions

FormatQueryParameters converts a Query object into a collection that cloudcontroller.Request can accept.
NewClient returns a new Client.
NewPaginatedResources returns a new PaginatedResources struct with the given resource type.
TestClient returns a new client explicitly meant for internal testing.

# Constants

AppGUIDFilter is a query parameter for listing objects by app GUID.
GUIDFilter is a query parameter for listing objects by GUID.
NameFilter is a query parameter for listing objects by name.
NameOrder is a query value for ordering by name.
OrderBy is a query parameter to specify how to order objects.
OrganizationGUIDFilter is a query parameter for listing objects by Organization GUID.
PerPage is a query parameter for specifying the number of results per page.
SequenceIDFilter is a query parameter for listing objects by sequence ID.
SpaceGUIDFilter is a query parameter for listing objects by Space GUID.

# Structs

APILink represents a generic link from a response object.
Application represents a Cloud Controller V3 Application.
Build represent the process of staging an application package.
Client can be used to talk to a Cloud Controller's V3 Endpoints.
Config allows the Client to be configured.
No description provided by the author
Droplet represents a Cloud Controller droplet's metadata.
DropletBuildpack is the name and output of a buildpack used to create a droplet.
Environment variables that will be provided to an app at runtime.
ErrorDetails provides information regarding a job's error.
Info represents a GET response from the '/' endpoint of the cloud controller API.
IsolationSegment represents a Cloud Controller Isolation Segment.
Job represents a Cloud Controller Job.
Organization represents a Cloud Controller V3 Organization.
Package represents a Cloud Controller V3 Package.
PaginatedResources represents a page of resources returned by the Cloud Controller.
No description provided by the author
ProcessInstance represents a single process instance for a particular application.
Query is additional settings that can be passed to some requests that can filter, sort, etc.
Relationship represents a one to one relationship.
RelationshipList represents a one to many relationship.
Resource represents a Cloud Controller Resource.
ServiceInstance represents a Cloud Controller V3 Service Instance.
Space represents a Cloud Controller V3 Space.
TargetSettings represents configuration for establishing a connection to the Cloud Controller server.
Task represents a Cloud Controller V3 Task.

# Interfaces

No description provided by the author
ConnectionWrapper can wrap a given connection allowing the wrapper to modify all requests going in and out of the given connection.

# Type aliases

APILinks is a directory of follow-up urls for the resource.
EnvironmentVariables represents the environment variables that can be set on an application by the user.
JobURL is the URL to a given Job.
QueryKey is the type of query that is being selected on.
Relationships represent associations between resources.
ResourceLinks represents the information returned back from /v3.
Warnings are a collection of warnings that the Cloud Controller can return back from an API request.