Documentation ¶
Overview ¶
Package ccv2 represents a Cloud Controller V2 client.
These sets of packages are still under development/pre-pre-pre...alpha. Use at your own risk! Functionality and design may change without warning.
It is currently designed to support Cloud Controller API 2.23.0. However, it may include features and endpoints of later API versions.
For more information on the Cloud Controller API see https://apidocs.cloudfoundry.org/
Method Naming Conventions ¶
The client takes a '<Action Name><Top Level Endpoint><Return Value>' approach to method names. If the <Top Level Endpoint> and <Return Value> are similar, they do not need to be repeated. If a GUID is required for the <Top Level Endpoint>, the pluralization is removed from said endpoint in the method name.
For Example:
Method Name: GetApplication Endpoint: /v2/applications/:guid Action Name: Get Top Level Endpoint: applications Return Value: Application Method Name: GetServiceInstances Endpoint: /v2/service_instances Action Name: Get Top Level Endpoint: service_instances Return Value: []ServiceInstance Method Name: GetSpaceServiceInstances Endpoint: /v2/spaces/:guid/service_instances Action Name: Get Top Level Endpoint: spaces Return Value: []ServiceInstance
Use the following table to determine which HTTP Command equates to which Action Name:
HTTP Command -> Action Name POST -> Create GET -> Get PUT -> Update DELETE -> Delete
Method Locations ¶
Methods exist in the same file as their return type, regardless of which endpoint they use.
Error Handling ¶
All error handling that requires parsing the error_code/code returned back from the Cloud Controller should be placed in the errorWrapper. Everything else can be handled in the individual operations. All parsed cloud controller errors should exist in errors.go, all generic HTTP errors should exist in the cloudcontroller's errors.go. Errors related to the individaul operation should exist at the top of that operation's file.
No inline-relations-depth And summary Endpoints ¶
This package will not use ever use 'inline-relations-depth' or the '/summary' endpoints for any operations. These requests can be extremely taxing on the Cloud Controller and are avoided at all costs. Additionally, the objects returned back from these requests can become extremely inconsistant across versions and are problematic to deal with in general.
Index ¶
- func FormatQueryParameters(queries []Query) url.Values
- type APIInformation
- type Application
- type ApplicationInstance
- type ApplicationInstanceState
- type ApplicationInstanceStatus
- type ApplicationPackageState
- type ApplicationState
- type Client
- func (client *Client) API() string
- func (client *Client) APIVersion() string
- func (client *Client) AssociateSpaceWithSecurityGroup(securityGroupGUID string, spaceGUID string) (Warnings, error)
- func (client *Client) AuthorizationEndpoint() string
- func (client *Client) CreateUser(uaaUserID string) (User, Warnings, error)
- func (client *Client) DeleteOrganization(orgGUID string) (Job, Warnings, error)
- func (client *Client) DeleteRoute(routeGUID string) (Warnings, error)
- func (client *Client) DeleteServiceBinding(serviceBindingGUID string) (Warnings, error)
- func (client *Client) DopplerEndpoint() string
- func (client *Client) GetApplication(guid string) (Application, Warnings, error)
- func (client *Client) GetApplicationInstanceStatusesByApplication(guid string) (map[int]ApplicationInstanceStatus, Warnings, error)
- func (client *Client) GetApplicationInstancesByApplication(guid string) (map[int]ApplicationInstance, Warnings, error)
- func (client *Client) GetApplicationRoutes(appGUID string, queryParams []Query) ([]Route, Warnings, error)
- func (client *Client) GetApplications(queries []Query) ([]Application, Warnings, error)
- func (client *Client) GetJob(jobGUID string) (Job, Warnings, error)
- func (client *Client) GetOrganization(guid string) (Organization, Warnings, error)
- func (client *Client) GetOrganizationPrivateDomains(orgGUID string, queries []Query) ([]Domain, Warnings, error)
- func (client *Client) GetOrganizationQuota(guid string) (OrganizationQuota, Warnings, error)
- func (client *Client) GetOrganizations(queries []Query) ([]Organization, Warnings, error)
- func (client *Client) GetPrivateDomain(domainGUID string) (Domain, Warnings, error)
- func (client *Client) GetRouteApplications(routeGUID string, queryParams []Query) ([]Application, Warnings, error)
- func (client *Client) GetSecurityGroups(queries []Query) ([]SecurityGroup, Warnings, error)
- func (client *Client) GetServiceBindings(queries []Query) ([]ServiceBinding, Warnings, error)
- func (client *Client) GetServiceInstances(queries []Query) ([]ServiceInstance, Warnings, error)
- func (client *Client) GetSharedDomain(domainGUID string) (Domain, Warnings, error)
- func (client *Client) GetSharedDomains() ([]Domain, Warnings, error)
- func (client *Client) GetSpaceQuota(guid string) (SpaceQuota, Warnings, error)
- func (client *Client) GetSpaceRoutes(spaceGUID string, queryParams []Query) ([]Route, Warnings, error)
- func (client *Client) GetSpaceRunningSecurityGroupsBySpace(spaceGUID string) ([]SecurityGroup, Warnings, error)
- func (client *Client) GetSpaceServiceInstances(spaceGUID string, includeUserProvidedServices bool, queries []Query) ([]ServiceInstance, Warnings, error)
- func (client *Client) GetSpaceStagingSecurityGroupsBySpace(spaceGUID string) ([]SecurityGroup, Warnings, error)
- func (client *Client) GetSpaces(queries []Query) ([]Space, Warnings, error)
- func (client *Client) GetStack(guid string) (Stack, Warnings, error)
- func (client *Client) Info() (APIInformation, Warnings, error)
- func (client *Client) MinCLIVersion() string
- func (client *Client) PollJob(job Job) (Warnings, error)
- func (client *Client) RoutingEndpoint() string
- func (client *Client) TargetCF(settings TargetSettings) (Warnings, error)
- func (client *Client) TokenEndpoint() string
- func (client *Client) UpdateApplication(app Application) (Application, Warnings, error)
- func (client *Client) WrapConnection(wrapper ConnectionWrapper)
- type Config
- type ConnectionWrapper
- type Domain
- type Job
- type JobStatus
- type Organization
- type OrganizationQuota
- type PaginatedResources
- type Params
- type Query
- type QueryFilter
- type QueryOperator
- type Route
- type SecurityGroup
- type SecurityGroupRule
- type ServiceBinding
- type ServiceInstance
- type ServiceInstanceType
- type Space
- type SpaceQuota
- type Stack
- type TargetSettings
- type User
- type Warnings
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FormatQueryParameters ¶
FormatQueryParameters converts a Query object into a collection that cloudcontroller.Request can accept.
Types ¶
type APIInformation ¶
type APIInformation struct { APIVersion string `json:"api_version"` AuthorizationEndpoint string `json:"authorization_endpoint"` DopplerEndpoint string `json:"doppler_logging_endpoint"` MinCLIVersion string `json:"min_cli_version"` MinimumRecommendedCLIVersion string `json:"min_recommended_cli_version"` Name string `json:"name"` RoutingEndpoint string `json:"routing_endpoint"` TokenEndpoint string `json:"token_endpoint"` }
APIInformation represents the information returned back from /v2/info
type Application ¶
type Application struct { // Buildpack is the buildpack set by the user. Buildpack string `json:"-"` // DetectedBuildpack is the buildpack automatically detected. DetectedBuildpack string `json:"-"` // DetectedStartCommand is the command used to start the application. DetectedStartCommand string `json:"-"` // DiskQuota is the disk given to each instance, in megabytes. DiskQuota int `json:"-"` // GUID is the unique application identifier. GUID string `json:"-"` // HealthCheckType is the type of health check that will be done to the app. HealthCheckType string `json:"health_check_type,omitempty"` // HealthCheckHTTPEndpoint is the url of the http health check endpoint. HealthCheckHTTPEndpoint string `json:"health_check_http_endpoint,omitempty"` // Instances is the total number of app instances. Instances int `json:"-"` // Memory is the memory given to each instance, in megabytes. Memory int `json:"-"` // Name is the name given to the application. Name string `json:"-"` // PackageState represents the staging state of the application bits. PackageState ApplicationPackageState `json:"-"` // PackageUpdatedAt is the last time the app bits were updated. In RFC3339. PackageUpdatedAt time.Time `json:"-"` // StackGUID is the GUID for the Stack the application is running on. StackGUID string `json:"-"` // StagingFailedDescription is the verbose description of why the package // failed to stage. StagingFailedDescription string `json:"-"` // StagingFailedReason is the reason why the package failed to stage. StagingFailedReason string `json:"-"` // State is the desired state of the application. State ApplicationState `json:"state,omitempty"` }
Application represents a Cloud Controller Application.
func (*Application) UnmarshalJSON ¶
func (application *Application) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller Application response.
type ApplicationInstance ¶
type ApplicationInstance struct { // Details are arbitrary information about the instance. Details string // ID is the instance ID. ID int // Since is the Unix time stamp that represents the time the instance was // created. Since float64 // State is the instance's state. State ApplicationInstanceState }
ApplicationInstance represents a Cloud Controller Application Instance.
func (*ApplicationInstance) UnmarshalJSON ¶
func (instance *ApplicationInstance) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller application instance response.
type ApplicationInstanceState ¶
type ApplicationInstanceState string
ApplicationInstanceState reflects the state of the individual app instance.
const ( ApplicationInstanceCrashed ApplicationInstanceState = "CRASHED" ApplicationInstanceDown ApplicationInstanceState = "DOWN" ApplicationInstanceFlapping ApplicationInstanceState = "FLAPPING" ApplicationInstanceRunning ApplicationInstanceState = "RUNNING" ApplicationInstanceStarting ApplicationInstanceState = "STARTING" ApplicationInstanceUnknown ApplicationInstanceState = "UNKNOWN" )
type ApplicationInstanceStatus ¶
type ApplicationInstanceStatus struct { // CPU is the instance's CPU utilization percentage. CPU float64 // Disk is the instance's disk usage in bytes. Disk int // DiskQuota is the instance's allowed disk usage in bytes. DiskQuota int // ID is the instance ID. ID int // IsolationSegment that the app is currently running on. IsolationSegment string // Memory is the instance's memory usage in bytes. Memory int // MemoryQuota is the instance's allowed memory usage in bytes. MemoryQuota int // State is the instance's state. State ApplicationInstanceState // Uptime is the number of seconds the instance has been running. Uptime int }
ApplicationInstanceStatus represents a Cloud Controller Application Instance.
func (*ApplicationInstanceStatus) UnmarshalJSON ¶
func (instance *ApplicationInstanceStatus) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller application instance response.
type ApplicationPackageState ¶
type ApplicationPackageState string
ApplicationPackageState is the staging state of application bits.
const ( ApplicationPackageStaged ApplicationPackageState = "STAGED" ApplicationPackagePending ApplicationPackageState = "PENDING" ApplicationPackageFailed ApplicationPackageState = "FAILED" ApplicationPackageUnknown ApplicationPackageState = "UNKNOWN" )
type ApplicationState ¶
type ApplicationState string
ApplicationState is the running state of an application.
const ( ApplicationStarted ApplicationState = "STARTED" ApplicationStopped ApplicationState = "STOPPED" )
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a client that can be used to talk to a Cloud Controller's V2 Endpoints.
func (*Client) APIVersion ¶
APIVersion returns Cloud Controller API Version for the targeted Cloud Controller.
func (*Client) AssociateSpaceWithSecurityGroup ¶
func (*Client) AuthorizationEndpoint ¶
AuthorizationEndpoint returns the authorization endpoint for the targeted Cloud Controller.
func (*Client) CreateUser ¶
CreateUser creates a new Cloud Controller User from the provided UAA user ID.
func (*Client) DeleteOrganization ¶
DeleteOrganization deletes the Organization associated with the provided GUID. It will return the Cloud Controller job that is assigned to the organization deletion.
func (*Client) DeleteRoute ¶
DeleteRoute deletes the Route associated with the provided Route GUID.
func (*Client) DeleteServiceBinding ¶
DeleteServiceBinding will destroy the requested Service Binding.
func (*Client) DopplerEndpoint ¶
DopplerEndpoint returns the Doppler endpoint for the targetd Cloud Controller.
func (*Client) GetApplication ¶
func (client *Client) GetApplication(guid string) (Application, Warnings, error)
GetApplication returns back an Application.
func (*Client) GetApplicationInstanceStatusesByApplication ¶
func (client *Client) GetApplicationInstanceStatusesByApplication(guid string) (map[int]ApplicationInstanceStatus, Warnings, error)
GetApplicationInstanceStatusesByApplication returns a list of ApplicationInstance for a given application. Given the state of an application, it might skip some application instances.
func (*Client) GetApplicationInstancesByApplication ¶
func (client *Client) GetApplicationInstancesByApplication(guid string) (map[int]ApplicationInstance, Warnings, error)
GetApplicationInstancesByApplication returns a list of ApplicationInstance for a given application. Given the state of an application, it might skip some application instances.
func (*Client) GetApplicationRoutes ¶
func (client *Client) GetApplicationRoutes(appGUID string, queryParams []Query) ([]Route, Warnings, error)
GetApplicationRoutes returns a list of Routes associated with the provided Application GUID, and filtered by the provided queries.
func (*Client) GetApplications ¶
func (client *Client) GetApplications(queries []Query) ([]Application, Warnings, error)
GetApplications returns back a list of Applications based off of the provided queries.
func (*Client) GetOrganization ¶
func (client *Client) GetOrganization(guid string) (Organization, Warnings, error)
GetOrganization returns an Organization associated with the provided guid.
func (*Client) GetOrganizationPrivateDomains ¶
func (client *Client) GetOrganizationPrivateDomains(orgGUID string, queries []Query) ([]Domain, Warnings, error)
GetOrganizationPrivateDomains returns the private domains associated with an organization.
func (*Client) GetOrganizationQuota ¶
func (client *Client) GetOrganizationQuota(guid string) (OrganizationQuota, Warnings, error)
GetOrganizaitonQuota gets an organization quota (quota definition) from the API.
func (*Client) GetOrganizations ¶
func (client *Client) GetOrganizations(queries []Query) ([]Organization, Warnings, error)
GetOrganizations returns back a list of Organizations based off of the provided queries.
func (*Client) GetPrivateDomain ¶
GetPrivateDomain returns the Private Domain associated with the provided Domain GUID.
func (*Client) GetRouteApplications ¶
func (client *Client) GetRouteApplications(routeGUID string, queryParams []Query) ([]Application, Warnings, error)
GetRouteApplications returns a list of Applications associated with a route GUID, filtered by provided queries.
func (*Client) GetSecurityGroups ¶
func (client *Client) GetSecurityGroups(queries []Query) ([]SecurityGroup, Warnings, error)
func (*Client) GetServiceBindings ¶
func (client *Client) GetServiceBindings(queries []Query) ([]ServiceBinding, Warnings, error)
GetServiceBindings returns back a list of Service Bindings based off of the provided queries.
func (*Client) GetServiceInstances ¶
func (client *Client) GetServiceInstances(queries []Query) ([]ServiceInstance, Warnings, error)
GetServiceInstances returns back a list of *managed* Service Instances based off of the provided queries.
func (*Client) GetSharedDomain ¶
GetSharedDomain returns the Shared Domain associated with the provided Domain GUID.
func (*Client) GetSharedDomains ¶
GetSharedDomains returns the global shared domains.
func (*Client) GetSpaceQuota ¶
func (client *Client) GetSpaceQuota(guid string) (SpaceQuota, Warnings, error)
GetSpaceQuota returns a Space Quota.
func (*Client) GetSpaceRoutes ¶
func (client *Client) GetSpaceRoutes(spaceGUID string, queryParams []Query) ([]Route, Warnings, error)
GetSpaceRoutes returns a list of Routes associated with the provided Space GUID, and filtered by the provided queries.
func (*Client) GetSpaceRunningSecurityGroupsBySpace ¶
func (client *Client) GetSpaceRunningSecurityGroupsBySpace(spaceGUID string) ([]SecurityGroup, Warnings, error)
GetSpaceRunningSecurityGroupsBySpace returns the running Security Groups associated with the provided Space GUID.
func (*Client) GetSpaceServiceInstances ¶
func (client *Client) GetSpaceServiceInstances(spaceGUID string, includeUserProvidedServices bool, queries []Query) ([]ServiceInstance, Warnings, error)
GetSpaceServiceInstances returns back a list of Service Instances based off of the space and queries provided. User provided services will be included if includeUserProvidedServices is set to true.
func (*Client) GetSpaceStagingSecurityGroupsBySpace ¶
func (client *Client) GetSpaceStagingSecurityGroupsBySpace(spaceGUID string) ([]SecurityGroup, Warnings, error)
GetSpaceStagingSecurityGroupsBySpace returns the staging Security Groups associated with the provided Space GUID.
func (*Client) GetSpaces ¶
GetSpaces returns back a list of Spaces based off of the provided queries.
func (*Client) Info ¶
func (client *Client) Info() (APIInformation, Warnings, error)
Info returns back endpoint and API information from /v2/info.
func (*Client) MinCLIVersion ¶
MinCLIVersion returns the minimum CLI version required for the targeted Cloud Controller
func (*Client) PollJob ¶
PollJob will keep polling the given job until the job has terminated, an error is encountered, or config.OverallPollingTimeout is reached. In the last case, a JobTimeoutError is returned.
func (*Client) RoutingEndpoint ¶
RoutingEndpoint returns the Routing endpoint for the targeted Cloud Controller.
func (*Client) TargetCF ¶
func (client *Client) TargetCF(settings TargetSettings) (Warnings, error)
TargetCF sets the client to use the Cloud Controller specified in the configuration. Any other configuration is also applied to the client.
func (*Client) TokenEndpoint ¶
TokenEndpoint returns the Token endpoint for the targeted Cloud Controller.
func (*Client) UpdateApplication ¶
func (client *Client) UpdateApplication(app Application) (Application, Warnings, error)
func (*Client) WrapConnection ¶
func (client *Client) WrapConnection(wrapper ConnectionWrapper)
WrapConnection wraps the current Client connection in the wrapper.
type Config ¶
type Config struct { // AppName is the name of the application/process using the client. AppName string // AppVersion is the version of the application/process using the client. AppVersion string // JobPollingTimeout is the maximum amount of time a job polls for. JobPollingTimeout time.Duration // JobPollingInterval is the wait time between job polls. JobPollingInterval time.Duration // Wrappers that apply to the client connection. Wrappers []ConnectionWrapper }
Config allows the Client to be configured
type ConnectionWrapper ¶
type ConnectionWrapper interface { cloudcontroller.Connection Wrap(innerconnection cloudcontroller.Connection) cloudcontroller.Connection }
ConnectionWrapper can wrap a given connection allowing the wrapper to modify all requests going in and out of the given connection.
type Domain ¶
Domain represents a Cloud Controller Domain.
func (*Domain) UnmarshalJSON ¶
UnmarshalJSON helps unmarshal a Cloud Controller Domain response.
type Job ¶
Job represents a Cloud Controller Job.
func (*Job) UnmarshalJSON ¶
UnmarshalJSON helps unmarshal a Cloud Controller Job response.
type JobStatus ¶
type JobStatus string
JobStatus is the current state of a job.
const ( // JobStatusFailed is when the job is no longer running due to a failure. JobStatusFailed JobStatus = "failed" // JobStatusFinished is when the job is no longer and it was successful. JobStatusFinished JobStatus = "finished" // JobStatusQueued is when the job is waiting to be run. JobStatusQueued JobStatus = "queued" // JobStatusRunning is when the job is running. JobStatusRunning JobStatus = "running" )
type Organization ¶
type Organization struct { GUID string Name string QuotaDefinitionGUID string DefaultIsolationSegmentGUID string }
Organization represents a Cloud Controller Organization.
func (*Organization) UnmarshalJSON ¶
func (org *Organization) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller Organization response.
type OrganizationQuota ¶
OrganizationQuota is the definition of a quota for an organization.
func (*OrganizationQuota) UnmarshalJSON ¶
func (application *OrganizationQuota) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller organization quota response.
type PaginatedResources ¶
type PaginatedResources struct { NextURL string `json:"next_url"` ResourcesBytes json.RawMessage `json:"resources"` // contains filtered or unexported fields }
PaginatedResources represents a page of resources returned by the Cloud Controller.
func NewPaginatedResources ¶
func NewPaginatedResources(exampleResource interface{}) PaginatedResources
NewPaginatedResources returns a new PaginatedResources struct with the given resource type.
func (PaginatedResources) Resources ¶
func (pr PaginatedResources) Resources() ([]interface{}, error)
Resources unmarshals JSON representing a page of resources and returns a slice of the given resource type.
type Query ¶
type Query struct { Filter QueryFilter Operator QueryOperator Value string }
Query is a type of filter that can be passed to specific request to narrow down the return set.
type QueryFilter ¶
type QueryFilter string
QueryFilter is the type of filter a Query uses.
const ( // AppGUIDFilter is the name of the App GUID filter. AppGUIDFilter QueryFilter = "app_guid" // OrganizationGUIDFilter is the name of the organization GUID filter. OrganizationGUIDFilter QueryFilter = "organization_guid" // RouteGUIDFilter is the name of the route GUID filter. RouteGUIDFilter QueryFilter = "route_guid" // ServiceInstanceGUIDFilter is the name of the service instance GUID filter. ServiceInstanceGUIDFilter QueryFilter = "service_instance_guid" // SpaceGUIDFilter is the name of the space GUID filter. SpaceGUIDFilter QueryFilter = "space_guid" // NameFilter is the name of the name filter. NameFilter QueryFilter = "name" )
type QueryOperator ¶
type QueryOperator string
QueryOperator is the type of operation a Query uses.
const ( // EqualOperator is the query equal operator. EqualOperator QueryOperator = ":" )
type Route ¶
Route represents a Cloud Controller Route.
func (*Route) UnmarshalJSON ¶
UnmarshalJSON helps unmarshal a Cloud Controller Route response.
type SecurityGroup ¶
type SecurityGroup struct { GUID string Name string Rules []SecurityGroupRule }
func (*SecurityGroup) UnmarshalJSON ¶
func (securityGroup *SecurityGroup) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller Security Group response
type SecurityGroupRule ¶
type ServiceBinding ¶
type ServiceBinding struct {
GUID string
}
ServiceBinding represents a Cloud Controller Service Binding.
func (*ServiceBinding) UnmarshalJSON ¶
func (serviceBinding *ServiceBinding) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller Service Binding response.
type ServiceInstance ¶
type ServiceInstance struct { GUID string Name string Type ServiceInstanceType }
ServiceInstance represents a Cloud Controller Service Instance.
func (ServiceInstance) Managed ¶
func (serviceInstance ServiceInstance) Managed() bool
Managed returns true if the Service Instance is a managed service.
func (*ServiceInstance) UnmarshalJSON ¶
func (serviceInstance *ServiceInstance) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller Service Instance response.
func (ServiceInstance) UserProvided ¶
func (serviceInstance ServiceInstance) UserProvided() bool
UserProvidedService returns true if the Service Instance is a user provided service.
type ServiceInstanceType ¶
type ServiceInstanceType string
ServiceInstanceType is the type of the Service Instance.
const ( // UserProvidedService is a Service Instance that is created by a user. UserProvidedService ServiceInstanceType = "user_provided_service_instance" // ManagedService is a Service Instance that is managed by a service broker. ManagedService ServiceInstanceType = "managed_service_instance" )
type Space ¶
Space represents a Cloud Controller Space.
func (*Space) UnmarshalJSON ¶
UnmarshalJSON helps unmarshal a Cloud Controller Space response.
type SpaceQuota ¶
func (*SpaceQuota) UnmarshalJSON ¶
func (spaceQuota *SpaceQuota) UnmarshalJSON(data []byte) error
UnmarshalJSON helps unmarshal a Cloud Controller Space Quota response.
type Stack ¶
Stack represents a Cloud Controller Stack.
func (*Stack) UnmarshalJSON ¶
UnmarshalJSON helps unmarshal a Cloud Controller Stack response.
type TargetSettings ¶
type TargetSettings struct { // DialTimeout is the DNS timeout used to make all requests to the Cloud // Controller. DialTimeout time.Duration // SkipSSLValidation controls whether a client verifies the server's // certificate chain and host name. If SkipSSLValidation is true, TLS accepts // any certificate presented by the server and any host name in that // certificate for *all* client requests going forward. // // In this mode, TLS is susceptible to man-in-the-middle attacks. This should // be used only for testing. SkipSSLValidation bool // URL is a fully qualified URL to the Cloud Controller API. URL string }
TargetSettings represents configuration for establishing a connection to the Cloud Controller server.
type User ¶
type User struct {
GUID string
}
User represents a Cloud Controller User.
func (*User) UnmarshalJSON ¶
UnmarshalJSON helps unmarshal a Cloud Controller User response.
Source Files ¶
- application.go
- application_instance.go
- application_instance_status.go
- client.go
- connection_wrapper.go
- domain.go
- errors.go
- info.go
- job.go
- organization.go
- organization_quota.go
- paginate.go
- paginated_resources.go
- query.go
- request.go
- route.go
- security_group.go
- service_binding.go
- service_instance.go
- space.go
- space_quota.go
- stack.go
- target.go
- user.go