package
7.8.0+incompatible
Repository: https://github.com/cloudfoundry/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.
No description provided by the author
TestClient returns a new client explicitly meant for internal testing.

# Constants

AppGUIDFilter is a query parameter for listing objects by app GUID.
CreatedAtDescendingOrder is a query value for ordering by created_at timestamp, in descending order.
DomainGUIDFilter is a query param for listing objects by domain_guid.
FieldsServiceBroker is a query parameter to include specific fields from a service broker in an offering response.
FieldsServiceOfferingServiceBroker is a query parameter to include specific fields from a service broker in a plan response.
GloballyEnabledRunning is the query parameter for getting only security groups that are globally enabled for running.
GloballyEnabledStaging is the query parameter for getting only security groups that are globally enabled for staging.
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.
PortFilter is a query param for getting an object with the given port (TCP routes).
PortsFilter is a query param for getting an object with the given ports (TCP routes).
PositionOrder is a query value for ordering by position.
Purge is a query parameter used on a Delete request to indicate that dependent resources should also be deleted.
RoleTypesFilter is a query param for getting a role by type.
SequenceIDFilter is a query parameter for listing objects by sequence ID.
ServiceBrokerGUIDsFilter is a query parameter for getting resources according to the service broker GUID.
ServiceBrokerNamesFilter is a query parameter when getting plans or offerings according to the Service Brokers that it relates to.
ServiceOfferingGUIDsFilter is a query parameter when getting resources according to service offering GUIDs.
ServiceOfferingNamesFilter is a query parameter when getting a plan according to the Service Offerings that it relates to.
SourceGUID is the query parameter for getting an object.
SpaceGUIDFilter is a query parameter for listing objects by Space GUID.
StackFilter is a query parameter for listing objects by stack name.
VersionsFilter is a query parameter when getting an apps revisions by version.
StatusValueFilter is a query parameter for listing deployments by status.value.
DomainGUIDFilter is a query param for listing events by target_guid.
UnmappedFilter is a query parameter specifying unmapped routes.
UserGUIDFilter is a query parameter when getting a user by GUID.
UsernamesFilter is a query parameter when getting a user by username.
StatesFilter is a query parameter when getting a package's droplets by state.

# Structs

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
Environment variables that will be provided to an app at runtime.
No description provided by the author
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
Job represents a Cloud Controller Job.
JobErrorDetails provides information regarding a job's error.
PaginatedResources represents a page of resources returned by the Cloud Controller.
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.
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
No description provided by the author
TargetSettings represents configuration for establishing a connection to the Cloud Controller server.
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.
No description provided by the author

# Type aliases

JobURL is the URL to a given Job.
QueryKey is the type of query that is being selected on.
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.