package
7.0.0-beta.28+incompatible
Repository: https://github.com/mook-as/cf-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.
DomainGUIDFilter is a query param for listing objects by domain_guid.
GUIDFilter is a query parameter for listing objects by GUID.
HostFilter is a query param for getting an object with the given host.
HostsFilter is a query param for listing objects by hostname.
Include is a query parameter for specifying other resources associated with the resource returned by the endpoint.
LabelSelectorFilter is a query parameter for listing objects by label.
NameFilter is a query parameter for listing objects by name.
NameOrder is a query value for ordering by name.
NoRouteFilter is a query parameter for skipping route creation and unmapping existing routes.
OrderBy is a query parameter to specify how to order objects.
OrganizationGUIDFilter is a query parameter for listing objects by Organization GUID.
Origins filter is a query parameter when getting a user by origin (Note: CAPI will return an error if usernames filter is not also provided).
PathFilter is a query param for getting an object with the given host.
PathsFilter is a query param for listing objects by path.
PerPage is a query parameter for specifying the number of results per page.
PositionOrder is a query value for ordering by position.
RoleTypesFilter is a query param for getting a role by type.
SequenceIDFilter is a query parameter for listing objects by sequence ID.
SpaceGUIDFilter is a query parameter for listing objects by Space GUID.
StackFilter is a query parameter for listing objects by stack name.
States filter is a query parameter when getting a package's droplets by state.
StatusValueFilter is a query parameter for listing deployments by status.value.
DomainGUIDFilter is a query param for listing events by target_guid.
Unmapped filter is a query parameter specifying unmapped routes.
UserGUIDFilter filter is a query parameter when getting a user by GUID.
Usernames filter is a query parameter when getting a user by username.

# Structs

APILink represents a generic link from a response object.
Application represents a Cloud Controller V3 Application.
No description provided by the author
Build represent the process of staging an application package.
Buildpack represents a Cloud Controller V3 buildpack.
No description provided by the author
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
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.
No description provided by the author
Environment variables that will be provided to an app at runtime.
No description provided by the author
FeatureFlag represents a Cloud Controller V3 Feature Flag.
No description provided by the author
Info represents a GET response from the '/' endpoint of the cloud controller API.
No description provided by the author
IsolationSegment represents a Cloud Controller Isolation Segment.
Job represents a Cloud Controller Job.
JobErrorDetails provides information regarding a job's error.
Metadata is used for custom tagging of API resources.
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceBroker represents Service Broker data.
No description provided by the author
ServiceInstance represents a Cloud Controller V3 Service Instance.
No description provided by the author
No description provided by the author
Space represents a Cloud Controller V3 Space.
No description provided by the author
No description provided by the author
TargetSettings represents configuration for establishing a connection to the Cloud Controller server.
Task represents a Cloud Controller V3 Task.
No description provided by the author
No description provided by the author
User represents a Cloud Controller User.
V2FormattedResource represents a Cloud Controller Resource that still has the same shape as the V2 Resource.

# 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.
IncludedUsers represent a set of users included on an API response.
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.