Documentation
¶
Index ¶
- Constants
- type AppFileResource
- type AppRouteEntity
- type AppRouteResource
- type ApplicationEntity
- type ApplicationResource
- type AuthTokenEntity
- type AuthTokenResource
- type BuildpackEntity
- type BuildpackResource
- type DockerCredentials
- type DomainEntity
- type DomainResource
- type EventResource
- type EventResourceNewV2
- type EventResourceOldV2
- type FeatureFlagResource
- type IntegrityFields
- type LastOperation
- type Metadata
- type OrganizationEntity
- type OrganizationResource
- type PaginatedApplicationResources
- type PaginatedAuthTokenResources
- type PaginatedQuotaResources
- type PaginatedSecurityGroupResources
- type PaginatedServiceInstanceResources
- type PaginatedServiceOfferingResources
- type PaginatedSpaceQuotaResources
- type PaginatedStackResources
- type QuotaResource
- type Resource
- type RouteEntity
- type RouteResource
- type SecurityGroup
- type SecurityGroupResource
- type ServiceBindingEntity
- type ServiceBindingResource
- type ServiceBrokerEntity
- type ServiceBrokerResource
- type ServiceInstanceEntity
- type ServiceInstanceResource
- type ServiceKeyEntity
- type ServiceKeyResource
- type ServiceMigrateV1ToV2Response
- type ServiceOfferingEntity
- type ServiceOfferingExtra
- type ServiceOfferingResource
- type ServicePlanDescription
- type ServicePlanEntity
- type ServicePlanResource
- type ServicePlanVisibilityResource
- type SpaceEntity
- type SpaceQuotaResource
- type SpaceResource
- type StackEntity
- type StackResource
- type UAAUserFields
- type UAAUserResource
- type UAAUserResourceEmail
- type UAAUserResourceName
- type UAAUserResources
- type UserEntity
- type UserResource
Constants ¶
View Source
const UnlimitedAppInstances int = -1
View Source
const UnlimitedReservedRoutePorts string = "-1"
View Source
const UnlimitedRoutes string = "-1"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppFileResource ¶
type AppFileResource struct {
Sha1 string `json:"sha1"`
Size int64 `json:"size"`
Path string `json:"fn"`
Mode string `json:"mode"`
}
func (AppFileResource) ToIntegrityFields ¶
func (resource AppFileResource) ToIntegrityFields() IntegrityFields
type AppRouteEntity ¶
type AppRouteResource ¶
type AppRouteResource struct {
Resource
Entity AppRouteEntity
}
func (AppRouteResource) ToFields ¶
func (resource AppRouteResource) ToFields() (route models.RouteSummary)
func (AppRouteResource) ToModel ¶
func (resource AppRouteResource) ToModel() (route models.RouteSummary)
type ApplicationEntity ¶
type ApplicationEntity struct {
Name *string `json:"name,omitempty"`
Command *string `json:"command,omitempty"`
DetectedStartCommand *string `json:"detected_start_command,omitempty"`
State *string `json:"state,omitempty"`
SpaceGUID *string `json:"space_guid,omitempty"`
Instances *int `json:"instances,omitempty"`
Memory *int64 `json:"memory,omitempty"`
DiskQuota *int64 `json:"disk_quota,omitempty"`
StackGUID *string `json:"stack_guid,omitempty"`
Stack *StackResource `json:"stack,omitempty"`
Routes *[]AppRouteResource `json:"routes,omitempty"`
Buildpack *string `json:"buildpack,omitempty"`
DetectedBuildpack *string `json:"detected_buildpack,omitempty"`
EnvironmentJSON *map[string]interface{} `json:"environment_json,omitempty"`
HealthCheckType *string `json:"health_check_type,omitempty"`
HealthCheckHTTPEndpoint *string `json:"health_check_http_endpoint,omitempty"`
HealthCheckTimeout *int `json:"health_check_timeout,omitempty"`
PackageState *string `json:"package_state,omitempty"`
StagingFailedReason *string `json:"staging_failed_reason,omitempty"`
DockerImage *string `json:"docker_image,omitempty"`
DockerCredentials *DockerCredentials `json:"docker_credentials,omitempty"`
EnableSSH *bool `json:"enable_ssh,omitempty"`
PackageUpdatedAt *time.Time `json:"package_updated_at,omitempty"`
}
func NewApplicationEntityFromAppParams ¶
func NewApplicationEntityFromAppParams(app models.AppParams) ApplicationEntity
type ApplicationResource ¶
type ApplicationResource struct {
Resource
Entity ApplicationEntity
}
func (ApplicationResource) ToFields ¶
func (resource ApplicationResource) ToFields() (app models.ApplicationFields)
func (ApplicationResource) ToModel ¶
func (resource ApplicationResource) ToModel() (app models.Application)
type AuthTokenEntity ¶
type AuthTokenResource ¶
type AuthTokenResource struct {
Resource
Entity AuthTokenEntity
}
func (AuthTokenResource) ToFields ¶
func (resource AuthTokenResource) ToFields() (authToken models.ServiceAuthTokenFields)
type BuildpackEntity ¶
type BuildpackResource ¶
type BuildpackResource struct {
Resource
Entity BuildpackEntity
}
func (BuildpackResource) ToFields ¶
func (resource BuildpackResource) ToFields() models.Buildpack
type DockerCredentials ¶
type DomainEntity ¶
type DomainResource ¶
type DomainResource struct {
Resource
Entity DomainEntity
}
func (DomainResource) ToFields ¶
func (resource DomainResource) ToFields() models.DomainFields
type EventResource ¶
type EventResource interface {
ToFields() models.EventFields
}
type EventResourceNewV2 ¶
type EventResourceNewV2 struct {
Resource
Entity struct {
Timestamp time.Time
Type string
Actor string `json:"actor"`
ActorName string `json:"actor_name"`
Metadata map[string]interface{}
}
}
func (EventResourceNewV2) ToFields ¶
func (resource EventResourceNewV2) ToFields() models.EventFields
type EventResourceOldV2 ¶
type EventResourceOldV2 struct {
Resource
Entity struct {
Timestamp time.Time
ExitDescription string `json:"exit_description"`
ExitStatus int `json:"exit_status"`
InstanceIndex int `json:"instance_index"`
}
}
func (EventResourceOldV2) ToFields ¶
func (resource EventResourceOldV2) ToFields() models.EventFields
type FeatureFlagResource ¶
type FeatureFlagResource struct {
Entity models.FeatureFlag
}
func (FeatureFlagResource) ToFields ¶
func (resource FeatureFlagResource) ToFields() (flag models.FeatureFlag)
type IntegrityFields ¶
type LastOperation ¶
type OrganizationEntity ¶
type OrganizationEntity struct {
Name string `json:"name"`
QuotaDefinition QuotaResource `json:"quota_definition"`
Spaces []SpaceResource
Domains []DomainResource
SpaceQuotas []SpaceQuotaResource `json:"space_quota_definitions"`
}
type OrganizationResource ¶
type OrganizationResource struct {
Resource
Entity OrganizationEntity
}
func (OrganizationResource) ToFields ¶
func (resource OrganizationResource) ToFields() (fields models.OrganizationFields)
func (OrganizationResource) ToModel ¶
func (resource OrganizationResource) ToModel() (org models.Organization)
type PaginatedApplicationResources ¶
type PaginatedApplicationResources struct {
Resources []ApplicationResource
}
type PaginatedAuthTokenResources ¶
type PaginatedAuthTokenResources struct {
Resources []AuthTokenResource
}
type PaginatedQuotaResources ¶
type PaginatedQuotaResources struct {
Resources []QuotaResource
}
type PaginatedSecurityGroupResources ¶
type PaginatedSecurityGroupResources struct {
Resources []SecurityGroupResource
}
type PaginatedServiceInstanceResources ¶
type PaginatedServiceInstanceResources struct {
TotalResults int `json:"total_results"`
Resources []ServiceInstanceResource
}
type PaginatedServiceOfferingResources ¶
type PaginatedServiceOfferingResources struct {
Resources []ServiceOfferingResource
}
type PaginatedSpaceQuotaResources ¶
type PaginatedSpaceQuotaResources struct {
Resources []SpaceQuotaResource
}
type PaginatedStackResources ¶
type PaginatedStackResources struct {
Resources []StackResource
}
type QuotaResource ¶
type QuotaResource struct {
Resource
Entity models.QuotaResponse
}
func (QuotaResource) ToFields ¶
func (resource QuotaResource) ToFields() models.QuotaFields
type RouteEntity ¶
type RouteEntity struct {
Host string `json:"host"`
Domain DomainResource `json:"domain"`
Path string `json:"path"`
Port int `json:"port"`
Space SpaceResource `json:"space"`
Apps []ApplicationResource `json:"apps"`
ServiceInstance ServiceInstanceResource `json:"service_instance"`
}
type RouteResource ¶
type RouteResource struct {
Resource
Entity RouteEntity
}
func (RouteResource) ToFields ¶
func (resource RouteResource) ToFields() (fields models.Route)
func (RouteResource) ToModel ¶
func (resource RouteResource) ToModel() (route models.Route)
type SecurityGroup ¶
type SecurityGroup struct {
models.SecurityGroupFields
Spaces []SpaceResource
}
type SecurityGroupResource ¶
type SecurityGroupResource struct {
Resource
Entity SecurityGroup
}
func (SecurityGroupResource) ToFields ¶
func (resource SecurityGroupResource) ToFields() (fields models.SecurityGroupFields)
func (SecurityGroupResource) ToModel ¶
func (resource SecurityGroupResource) ToModel() (asg models.SecurityGroup)
type ServiceBindingEntity ¶
type ServiceBindingEntity struct {
AppGUID string `json:"app_guid"`
}
type ServiceBindingResource ¶
type ServiceBindingResource struct {
Resource
Entity ServiceBindingEntity
}
func (ServiceBindingResource) ToFields ¶
func (resource ServiceBindingResource) ToFields() models.ServiceBindingFields
type ServiceBrokerEntity ¶
type ServiceBrokerResource ¶
type ServiceBrokerResource struct {
Resource
Entity ServiceBrokerEntity
}
func (ServiceBrokerResource) ToFields ¶
func (resource ServiceBrokerResource) ToFields() (fields models.ServiceBroker)
type ServiceInstanceEntity ¶
type ServiceInstanceEntity struct {
Name string `json:"name"`
DashboardURL string `json:"dashboard_url"`
Type string `json:"type"`
Tags []string `json:"tags"`
ServiceBindings []ServiceBindingResource `json:"service_bindings"`
ServiceKeys []ServiceKeyResource `json:"service_keys"`
ServicePlan ServicePlanResource `json:"service_plan"`
LastOperation LastOperation `json:"last_operation"`
}
type ServiceInstanceResource ¶
type ServiceInstanceResource struct {
Resource
Entity ServiceInstanceEntity
}
func (ServiceInstanceResource) ToFields ¶
func (resource ServiceInstanceResource) ToFields() models.ServiceInstanceFields
func (ServiceInstanceResource) ToModel ¶
func (resource ServiceInstanceResource) ToModel() (instance models.ServiceInstance)
type ServiceKeyEntity ¶
type ServiceKeyResource ¶
type ServiceKeyResource struct {
Resource
Entity ServiceKeyEntity
}
func (ServiceKeyResource) ToFields ¶
func (resource ServiceKeyResource) ToFields() models.ServiceKeyFields
func (ServiceKeyResource) ToModel ¶
func (resource ServiceKeyResource) ToModel() models.ServiceKey
type ServiceMigrateV1ToV2Response ¶
type ServiceMigrateV1ToV2Response struct {
ChangedCount int `json:"changed_count"`
}
type ServiceOfferingEntity ¶
type ServiceOfferingEntity struct {
Label string `json:"label"`
Version string `json:"version"`
Description string `json:"description"`
Provider string `json:"provider"`
BrokerGUID string `json:"service_broker_guid"`
Requires []string `json:"requires"`
ServicePlans []ServicePlanResource `json:"service_plans"`
Extra ServiceOfferingExtra
}
type ServiceOfferingExtra ¶
type ServiceOfferingExtra struct {
DocumentationURL string `json:"documentationURL"`
}
func (*ServiceOfferingExtra) UnmarshalJSON ¶
func (resource *ServiceOfferingExtra) UnmarshalJSON(rawData []byte) error
type ServiceOfferingResource ¶
type ServiceOfferingResource struct {
Resource
Entity ServiceOfferingEntity
}
func (ServiceOfferingResource) ToFields ¶
func (resource ServiceOfferingResource) ToFields() models.ServiceOfferingFields
func (ServiceOfferingResource) ToModel ¶
func (resource ServiceOfferingResource) ToModel() models.ServiceOffering
type ServicePlanDescription ¶
type ServicePlanDescription struct {
ServiceLabel string
ServicePlanName string
ServiceProvider string
}
func (ServicePlanDescription) String ¶
func (planDesc ServicePlanDescription) String() string
type ServicePlanEntity ¶
type ServicePlanResource ¶
type ServicePlanResource struct {
Resource
Entity ServicePlanEntity
}
func (ServicePlanResource) ToFields ¶
func (resource ServicePlanResource) ToFields() (fields models.ServicePlanFields)
type ServicePlanVisibilityResource ¶
type ServicePlanVisibilityResource struct {
Resource
Entity models.ServicePlanVisibilityFields
}
func (ServicePlanVisibilityResource) ToFields ¶
func (resource ServicePlanVisibilityResource) ToFields() (fields models.ServicePlanVisibilityFields)
type SpaceEntity ¶
type SpaceEntity struct {
Name string
Organization OrganizationResource
Applications []ApplicationResource `json:"apps"`
Domains []DomainResource
ServiceInstances []ServiceInstanceResource `json:"service_instances"`
SecurityGroups []SecurityGroupResource `json:"security_groups"`
SpaceQuotaGUID string `json:"space_quota_definition_guid"`
AllowSSH bool `json:"allow_ssh"`
}
type SpaceQuotaResource ¶
type SpaceQuotaResource struct {
Resource
Entity models.SpaceQuotaResponse
}
func (SpaceQuotaResource) ToModel ¶
func (resource SpaceQuotaResource) ToModel() models.SpaceQuota
type SpaceResource ¶
type SpaceResource struct {
Resource
Entity SpaceEntity
}
func (SpaceResource) ToFields ¶
func (resource SpaceResource) ToFields() (fields models.SpaceFields)
func (SpaceResource) ToModel ¶
func (resource SpaceResource) ToModel() (space models.Space)
type StackEntity ¶
type StackResource ¶
type StackResource struct {
Resource
Entity StackEntity
}
func (StackResource) ToFields ¶
func (resource StackResource) ToFields() *models.Stack
type UAAUserFields ¶
type UAAUserFields struct {
ID string
}
type UAAUserResource ¶
type UAAUserResource struct {
Username string `json:"userName"`
Emails []UAAUserResourceEmail `json:"emails"`
Password string `json:"password"`
Name UAAUserResourceName `json:"name"`
}
func NewUAAUserResource ¶
func NewUAAUserResource(username, password string) UAAUserResource
type UAAUserResourceEmail ¶
type UAAUserResourceEmail struct {
Value string `json:"value"`
}
type UAAUserResourceName ¶
type UAAUserResources ¶
type UserEntity ¶
type UserResource ¶
type UserResource struct {
Resource
Entity UserEntity
}
func (UserResource) ToFields ¶
func (resource UserResource) ToFields() models.UserFields
Source Files
¶
- applications.go
- auth_tokens.go
- buildpacks.go
- domains.go
- events.go
- feature_flags.go
- organizations.go
- quota_constants.go
- quotas.go
- resources.go
- routes.go
- security_groups.go
- service_bindings.go
- service_brokers.go
- service_instances.go
- service_keys.go
- service_offerings.go
- service_plan_visibility.go
- service_plans.go
- space_quotas.go
- spaces.go
- stacks.go
- users.go
Click to show internal directories.
Click to hide internal directories.