 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
- func ForRelationships(relationships map[string]string) map[string]ToOneRelationship
- func JobURLForRedirects(resourceGUID string, operation string, baseURL url.URL) string
- type APILink
- type APILinkMeta
- type AppEnvResponse
- type AppEnvVarsLinks
- type AppEnvVarsResponse
- type AppLinks
- type AppResponse
- type AppSSHEnabled
- type BrokerCatalogFeatures
- type BuildResponse
- type BuildpackData
- type BuildpackResponse
- type ChecksumData
- type CurrentDropletLinks
- type CurrentDropletResponse
- type DeploymentLinks
- type DeploymentResponse
- type DeploymentStatus
- type DomainLinks
- type DomainRelationships
- type DomainResponse
- type DropletGUID
- type DropletResponse
- type Envelope
- type ErrorsResponse
- type Gauge
- type GaugeEnvelope
- type GaugeFloat
- type GaugeInt
- type GaugeNumber
- type GaugeValue
- type IdentityResponse
- type InfoCLIVersion
- type InfoV3Response
- type InputParameterSchema
- type Job
- type JobLinks
- type JobResponse
- type JobResponseError
- type Lifecycle
- type LifecycleData
- type Link
- type ListResponse
- type Log
- type LogCacheReadResponse
- type LogCacheReadResponseEnvelopes
- type LogEnvelope
- type LogType
- type MaintenanceInfo
- type Metadata
- type OrgLinks
- type OrgResponse
- type Organization
- type PackageData
- type PackageLinks
- type PackageResponse
- type PageRef
- type PaginationData
- type PresentedError
- type ProcessLinks
- type ProcessResponse
- type ProcessResponseHTTPHealthCheckData
- type ProcessResponseHealthCheck
- type ProcessResponseHealthCheckData
- type ProcessResponsePortHealthCheckData
- type ProcessResponseProcessHealthCheckData
- type ProcessStatsResource
- type ProcessStatsResponse
- type ProcessUsage
- type Relationship
- type RelationshipData
- type Resource
- type RoleLinks
- type RoleResponse
- type RootResponse
- type RootV3Response
- type RouteDestinationsResponse
- type RouteResponse
- type SecurityGroupLinks
- type SecurityGroupResponse
- type ServiceBindingDetailsResponse
- type ServiceBindingLastOperationResponse
- type ServiceBindingLinks
- type ServiceBindingResponse
- type ServiceBindingSchema
- type ServiceBrokerCatalog
- type ServiceBrokerLinks
- type ServiceBrokerResponse
- type ServiceInstanceLinks
- type ServiceInstanceResponse
- type ServiceInstanceSchema
- type ServiceOfferingLinks
- type ServiceOfferingRelationships
- type ServiceOfferingResponse
- type ServicePlanBrokerCatalog
- type ServicePlanFeatures
- type ServicePlanLinks
- type ServicePlanRelationships
- type ServicePlanResponse
- type ServicePlanSchemas
- type ServicePlanVisibilityResponse
- type SharedOrganizations
- type SpaceLinks
- type SpaceResponse
- type StackLinks
- type StackResponse
- type TaskLinks
- type TaskResponse
- type TaskResult
- type ToOneRelationship
- type UserLinks
- type UserResponse
- type VisibilityOrganization
Constants ¶
      View Source
      
  
    const ( JobGUIDDelimiter = "~" StateComplete = "COMPLETE" StateFailed = "FAILED" StateProcessing = "PROCESSING" StatePolling = "POLLING" AppDeleteOperation = "app.delete" OrgDeleteOperation = "org.delete" RouteDeleteOperation = "route.delete" SpaceApplyManifestOperation = "space.apply_manifest" SpaceDeleteOperation = "space.delete" SpaceDeleteUnmappedRoutesOperation = "space.delete_unapped_routes" DomainDeleteOperation = "domain.delete" RoleDeleteOperation = "role.delete" ServiceBrokerCreateOperation = "service_broker.create" ServiceBrokerDeleteOperation = "service_broker.delete" ServiceBrokerUpdateOperation = "service_broker.update" ManagedServiceInstanceResourceType = "managed_service_instance" ManagedServiceBindingResourceType = "managed_service_binding" ManagedServiceInstanceCreateOperation = ManagedServiceInstanceResourceType + ".create" ManagedServiceInstanceDeleteOperation = ManagedServiceInstanceResourceType + ".delete" ManagedServiceBindingCreateOperation = ManagedServiceBindingResourceType + ".create" ManagedServiceBindingDeleteOperation = ManagedServiceBindingResourceType + ".delete" )
      View Source
      
  
const V3APIVersion = "3.117.0+cf-k8s"
    Variables ¶
This section is empty.
Functions ¶
func ForRelationships ¶ added in v0.13.0
func ForRelationships(relationships map[string]string) map[string]ToOneRelationship
Types ¶
type APILink ¶
type APILink struct {
	Link
	Meta APILinkMeta `json:"meta"`
}
    type APILinkMeta ¶
type APILinkMeta struct {
	Version string `json:"version"`
}
    type AppEnvResponse ¶
type AppEnvResponse struct {
	EnvironmentVariables map[string]string `json:"environment_variables"`
	StagingEnvJSON       map[string]string `json:"staging_env_json"`
	RunningEnvJSON       map[string]string `json:"running_env_json"`
	SystemEnvJSON        map[string]any    `json:"system_env_json"`
	ApplicationEnvJSON   map[string]any    `json:"application_env_json"`
}
    func ForAppEnv ¶
func ForAppEnv(envVarRecord repositories.AppEnvRecord) AppEnvResponse
type AppEnvVarsLinks ¶
type AppEnvVarsResponse ¶
type AppEnvVarsResponse struct {
	Var   map[string]string `json:"var"`
	Links AppEnvVarsLinks   `json:"links"`
}
    func ForAppEnvVars ¶
func ForAppEnvVars(record repositories.AppEnvVarsRecord, baseURL url.URL) AppEnvVarsResponse
type AppLinks ¶
type AppLinks struct {
	Self                 Link `json:"self"`
	Space                Link `json:"space"`
	Processes            Link `json:"processes"`
	Packages             Link `json:"packages"`
	EnvironmentVariables Link `json:"environment_variables"`
	CurrentDroplet       Link `json:"current_droplet"`
	Droplets             Link `json:"droplets"`
	Tasks                Link `json:"tasks"`
	StartAction          Link `json:"start"`
	StopAction           Link `json:"stop"`
	Revisions            Link `json:"revisions"`
	DeployedRevisions    Link `json:"deployed_revisions"`
	Features             Link `json:"features"`
}
    type AppResponse ¶
type AppResponse struct {
	Name  string `json:"name"`
	GUID  string `json:"guid"`
	State string `json:"state"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Lifecycle     Lifecycle                    `json:"lifecycle"`
	Metadata      Metadata                     `json:"metadata"`
	Links         AppLinks                     `json:"links"`
}
    func ForApp ¶
func ForApp(responseApp repositories.AppRecord, baseURL url.URL, includes ...include.Resource) AppResponse
type AppSSHEnabled ¶ added in v0.8.0
type BrokerCatalogFeatures ¶ added in v0.15.0
type BuildResponse ¶
type BuildResponse struct {
	GUID            string                       `json:"guid"`
	CreatedAt       string                       `json:"created_at"`
	UpdatedAt       string                       `json:"updated_at"`
	CreatedBy       map[string]interface{}       `json:"created_by"`
	State           string                       `json:"state"`
	StagingMemoryMB int                          `json:"staging_memory_in_mb"`
	StagingDiskMB   int                          `json:"staging_disk_in_mb"`
	Error           *string                      `json:"error"`
	Lifecycle       Lifecycle                    `json:"lifecycle"`
	Package         RelationshipData             `json:"package"`
	Droplet         *RelationshipData            `json:"droplet"`
	Relationships   map[string]ToOneRelationship `json:"relationships"`
	Metadata        Metadata                     `json:"metadata"`
	Links           map[string]Link              `json:"links"`
}
    func ForBuild ¶
func ForBuild(buildRecord repositories.BuildRecord, baseURL url.URL, includes ...include.Resource) BuildResponse
type BuildpackData ¶
type BuildpackResponse ¶
type BuildpackResponse struct {
	GUID      string          `json:"guid"`
	CreatedAt string          `json:"created_at"`
	UpdatedAt string          `json:"updated_at"`
	Name      string          `json:"name"`
	Filename  string          `json:"filename"`
	Stack     string          `json:"stack"`
	Position  int             `json:"position"`
	Enabled   bool            `json:"enabled"`
	Locked    bool            `json:"locked"`
	Metadata  Metadata        `json:"metadata"`
	Links     map[string]Link `json:"links"`
}
    func ForBuildpack ¶
func ForBuildpack(buildpackRecord repositories.BuildpackRecord, _ url.URL, includes ...include.Resource) BuildpackResponse
type ChecksumData ¶
type CurrentDropletLinks ¶
type CurrentDropletResponse ¶
type CurrentDropletResponse struct {
	Data  RelationshipData    `json:"data"`
	Links CurrentDropletLinks `json:"links"`
}
    func ForCurrentDroplet ¶
func ForCurrentDroplet(record repositories.CurrentDropletRecord, baseURL url.URL) CurrentDropletResponse
type DeploymentLinks ¶ added in v0.8.0
type DeploymentResponse ¶ added in v0.8.0
type DeploymentResponse struct {
	GUID          string                       `json:"guid"`
	Status        DeploymentStatus             `json:"status"`
	Droplet       DropletGUID                  `json:"droplet"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Links         DeploymentLinks              `json:"links"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
}
    func ForDeployment ¶ added in v0.8.0
func ForDeployment(responseDeployment repositories.DeploymentRecord, baseURL url.URL, includes ...include.Resource) DeploymentResponse
type DeploymentStatus ¶ added in v0.8.0
type DomainLinks ¶
type DomainRelationships ¶
type DomainRelationships struct {
	Organization        `json:"organization"`
}
    type DomainResponse ¶
type DomainResponse struct {
	Name               string   `json:"name"`
	GUID               string   `json:"guid"`
	Internal           bool     `json:"internal"`
	RouterGroup        *string  `json:"router_group"`
	SupportedProtocols []string `json:"supported_protocols"`
	CreatedAt     string              `json:"created_at"`
	UpdatedAt     string              `json:"updated_at"`
	Metadata      Metadata            `json:"metadata"`
	Relationships DomainRelationships `json:"relationships"`
	Links         DomainLinks         `json:"links"`
}
    func ForDomain ¶
func ForDomain(responseDomain repositories.DomainRecord, baseURL url.URL, includes ...include.Resource) DomainResponse
type DropletGUID ¶ added in v0.8.0
type DropletGUID struct {
	Guid string `json:"guid"`
}
    type DropletResponse ¶
type DropletResponse struct {
	GUID              string                       `json:"guid"`
	CreatedAt         string                       `json:"created_at"`
	UpdatedAt         string                       `json:"updated_at"`
	State             string                       `json:"state"`
	Error             *string                      `json:"error"`
	Lifecycle         Lifecycle                    `json:"lifecycle"`
	ExecutionMetadata string                       `json:"execution_metadata"`
	Checksum          *ChecksumData                `json:"checksum"`
	Buildpacks        []BuildpackData              `json:"buildpacks"`
	ProcessTypes      map[string]string            `json:"process_types"`
	Stack             string                       `json:"stack"`
	Image             *string                      `json:"image"`
	Relationships     map[string]ToOneRelationship `json:"relationships"`
	Metadata          Metadata                     `json:"metadata"`
	Links             map[string]*Link             `json:"links"`
}
    func ForDroplet ¶
func ForDroplet(dropletRecord repositories.DropletRecord, baseURL url.URL, includes ...include.Resource) DropletResponse
type ErrorsResponse ¶
type ErrorsResponse struct {
	Errors []PresentedError `json:"errors"`
}
    type Gauge ¶ added in v0.15.0
type Gauge struct {
	Metrics map[string]GaugeValue `json:"metrics"`
}
    type GaugeEnvelope ¶ added in v0.15.0
type GaugeFloat ¶ added in v0.15.0
type GaugeFloat float64
func (GaugeFloat) MarshalJSON ¶ added in v0.15.0
func (f GaugeFloat) MarshalJSON() ([]byte, error)
type GaugeNumber ¶ added in v0.15.0
type GaugeValue ¶ added in v0.15.0
type GaugeValue struct {
	Unit  string      `json:"unit"`
	Value GaugeNumber `json:"value"`
}
    type IdentityResponse ¶
func ForWhoAmI ¶
func ForWhoAmI(identity authorization.Identity) IdentityResponse
type InfoCLIVersion ¶ added in v0.12.0
type InfoV3Response ¶ added in v0.12.0
type InfoV3Response struct {
	Build       string                 `json:"build"`
	CLIVersion  InfoCLIVersion         `json:"cli_version"`
	Description string                 `json:"description"`
	Name        string                 `json:"name"`
	Version     string                 `json:"version"`
	Custom      map[string]interface{} `json:"custom"`
	Links map[string]Link `json:"links"`
}
    func ForInfoV3 ¶ added in v0.12.0
func ForInfoV3(baseURL url.URL, infoConfig config.InfoConfig) InfoV3Response
type InputParameterSchema ¶ added in v0.15.0
type Job ¶ added in v0.8.0
func JobFromGUID ¶ added in v0.8.0
type JobResponse ¶
type JobResponse struct {
	GUID      string             `json:"guid"`
	Errors    []JobResponseError `json:"errors"`
	Operation string             `json:"operation"`
	State     string             `json:"state"`
	Links     JobLinks           `json:"links"`
}
    func ForJob ¶ added in v0.8.0
func ForJob(job Job, errors []JobResponseError, state repositories.ResourceState, baseURL url.URL) JobResponse
func ForManifestApplyJob ¶
func ForManifestApplyJob(job Job, baseURL url.URL) JobResponse
func ForSpaceDeleteUnmappedRoutesJob ¶ added in v0.16.0
func ForSpaceDeleteUnmappedRoutesJob(job Job, state repositories.ResourceState, baseURL url.URL) JobResponse
type JobResponseError ¶ added in v0.8.0
type Lifecycle ¶
type Lifecycle struct {
	Type string        `json:"type"`
	Data LifecycleData `json:"data"`
}
    type LifecycleData ¶
type ListResponse ¶
type ListResponse[T any] struct { PaginationData PaginationData `json:"pagination"` Resources []T `json:"resources"` Included map[string][]any `json:"included,omitempty"` }
func ForList ¶
func ForList[T, S any](itemPresenter itemPresenter[T, S], listResult repositories.ListResult[T], baseURL, requestURL url.URL, includes ...include.Resource) ListResponse[S]
func ForServiceBindingList ¶
func ForServiceBindingList(serviceBindings repositories.ListResult[repositories.ServiceBindingRecord], appRecords []repositories.AppRecord, baseURL, requestURL url.URL) ListResponse[ServiceBindingResponse]
type LogCacheReadResponse ¶
type LogCacheReadResponse[E isLogCacheEnvelope] struct {
	Envelopes LogCacheReadResponseEnvelopes[E] `json:"envelopes"`
}
    func ForLogs ¶
func ForLogs(logRecords []repositories.LogRecord) LogCacheReadResponse[LogEnvelope]
func ForStats ¶ added in v0.15.0
func ForStats(appRecord repositories.AppRecord, appPodStats []actions.PodStatsRecord) LogCacheReadResponse[GaugeEnvelope]
type LogCacheReadResponseEnvelopes ¶
type LogCacheReadResponseEnvelopes[E isLogCacheEnvelope] struct {
	Batch []E `json:"batch"`
}
    type LogEnvelope ¶ added in v0.15.0
type MaintenanceInfo ¶ added in v0.15.0
type MaintenanceInfo struct {
	Version string `json:"version"`
}
    type OrgResponse ¶
type OrgResponse struct {
	Name string `json:"name"`
	GUID string `json:"guid"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
	Suspended     bool                         `json:"suspended"`
	Relationships map[string]ToOneRelationship `json:"relationships,omitempty"`
	Metadata      Metadata                     `json:"metadata"`
	Links         OrgLinks                     `json:"links"`
}
    func ForOrg ¶ added in v0.3.0
func ForOrg(org repositories.OrgRecord, apiBaseURL url.URL, includes ...include.Resource) OrgResponse
type Organization ¶
type Organization struct {
	Data *string `json:"data"`
}
    type PackageData ¶
type PackageData struct {
	Image string `json:"image,omitempty"`
}
    type PackageLinks ¶
type PackageResponse ¶
type PackageResponse struct {
	GUID          string                       `json:"guid"`
	Type          string                       `json:"type"`
	Data          PackageData                  `json:"data"`
	State         string                       `json:"state"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Links         PackageLinks                 `json:"links"`
	Metadata      Metadata                     `json:"metadata"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
}
    func ForPackage ¶
func ForPackage(record repositories.PackageRecord, baseURL url.URL, includes ...include.Resource) PackageResponse
type PaginationData ¶
type PresentedError ¶
type ProcessLinks ¶
type ProcessResponse ¶
type ProcessResponse struct {
	GUID          string                       `json:"guid"`
	Type          string                       `json:"type"`
	Command       string                       `json:"command"`
	Instances     int32                        `json:"instances"`
	MemoryMB      int64                        `json:"memory_in_mb"`
	DiskQuotaMB   int64                        `json:"disk_in_mb"`
	HealthCheck   ProcessResponseHealthCheck   `json:"health_check"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Metadata      Metadata                     `json:"metadata"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
	Links         ProcessLinks                 `json:"links"`
}
    func ForProcess ¶
func ForProcess(responseProcess repositories.ProcessRecord, baseURL url.URL, _ ...include.Resource) ProcessResponse
func ForProcessSanitized ¶ added in v0.16.0
func ForProcessSanitized(responseProcess repositories.ProcessRecord, baseURL url.URL, includes ...include.Resource) ProcessResponse
type ProcessResponseHealthCheck ¶
type ProcessResponseHealthCheck struct {
	Type string                         `json:"type"`
	Data ProcessResponseHealthCheckData `json:"data"`
}
    type ProcessResponseHealthCheckData ¶
type ProcessResponseHealthCheckData struct {
	Type              string `json:"-"`
	Timeout           int32  `json:"timeout"`
	InvocationTimeout int32  `json:"invocation_timeout"`
	HTTPEndpoint      string `json:"endpoint"`
}
    func (ProcessResponseHealthCheckData) MarshalJSON ¶
func (h ProcessResponseHealthCheckData) MarshalJSON() ([]byte, error)
type ProcessResponseProcessHealthCheckData ¶
type ProcessResponseProcessHealthCheckData struct {
	Timeout *int32 `json:"timeout"`
}
    type ProcessStatsResource ¶
type ProcessStatsResponse ¶
type ProcessStatsResponse struct {
	Resources []ProcessStatsResource `json:"resources"`
}
    func ForProcessStats ¶
func ForProcessStats(gauges []stats.ProcessGauges, instancesState []stats.ProcessInstanceState, now time.Time) ProcessStatsResponse
type ProcessUsage ¶
type Relationship ¶
type Relationship struct {
	GUID string `json:"guid"`
}
    type RelationshipData ¶
type RelationshipData struct {
	GUID string `json:"guid,omitempty"`
}
    type Resource ¶ added in v0.13.0
type Resource struct {
	// contains filtered or unexported fields
}
    func NewResource ¶ added in v0.13.0
func (*Resource) PresentResource ¶ added in v0.13.0
func (r *Resource) PresentResource(resource relationships.Resource) any
type RoleResponse ¶
type RoleResponse struct {
	GUID          string                       `json:"guid"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
	Type          string                       `json:"type"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Links         RoleLinks                    `json:"links"`
}
    func ForRole ¶ added in v0.7.1
func ForRole(role repositories.RoleRecord, apiBaseURL url.URL, includes ...include.Resource) RoleResponse
type RootResponse ¶
type RootV3Response ¶ added in v0.8.0
func ForRootV3 ¶ added in v0.8.0
func ForRootV3(baseURL url.URL) RootV3Response
type RouteDestinationsResponse ¶
type RouteDestinationsResponse struct {
	Destinations []routeDestination     `json:"destinations"`
	Links        routeDestinationsLinks `json:"links"`
}
    func ForRouteDestinations ¶
func ForRouteDestinations(route repositories.RouteRecord, baseURL url.URL) RouteDestinationsResponse
type RouteResponse ¶
type RouteResponse struct {
	GUID         string             `json:"guid"`
	Protocol     string             `json:"protocol"`
	Port         *int               `json:"port"`
	Host         string             `json:"host"`
	Path         string             `json:"path"`
	URL          string             `json:"url"`
	Destinations []routeDestination `json:"destinations"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Metadata      Metadata                     `json:"metadata"`
	Links         routeLinks                   `json:"links"`
}
    func ForRoute ¶
func ForRoute(route repositories.RouteRecord, baseURL url.URL, includes ...include.Resource) RouteResponse
type SecurityGroupLinks ¶ added in v0.16.0
type SecurityGroupLinks struct {
	Self Link `json:"self"`
}
    type SecurityGroupResponse ¶ added in v0.16.0
type SecurityGroupResponse struct {
	GUID            string                              `json:"guid"`
	CreatedAt       string                              `json:"created_at"`
	UpdatedAt       string                              `json:"updated_at"`
	Name            string                              `json:"name"`
	GloballyEnabled repositories.SecurityGroupWorkloads `json:"globally_enabled"`
	Rules           []repositories.SecurityGroupRule    `json:"rules"`
	Relationships   payloads.SecurityGroupRelationships `json:"relationships"`
	Links           SecurityGroupLinks                  `json:"links"`
}
    func ForSecurityGroup ¶ added in v0.16.0
func ForSecurityGroup(securityGroupRecord repositories.SecurityGroupRecord, baseURL url.URL, includes ...include.Resource) SecurityGroupResponse
type ServiceBindingDetailsResponse ¶ added in v0.15.0
func ForServiceBindingDetails ¶ added in v0.15.0
func ForServiceBindingDetails(serviceBindingDetailsRecord repositories.ServiceBindingDetailsRecord) ServiceBindingDetailsResponse
type ServiceBindingLinks ¶
type ServiceBindingResponse ¶
type ServiceBindingResponse struct {
	GUID          string                              `json:"guid"`
	Type          string                              `json:"type"`
	Name          *string                             `json:"name"`
	CreatedAt     string                              `json:"created_at"`
	UpdatedAt     string                              `json:"updated_at"`
	LastOperation ServiceBindingLastOperationResponse `json:"last_operation"`
	Relationships map[string]ToOneRelationship        `json:"relationships"`
	Links         ServiceBindingLinks                 `json:"links"`
	Metadata      Metadata                            `json:"metadata"`
}
    func ForServiceBinding ¶
func ForServiceBinding(record repositories.ServiceBindingRecord, baseURL url.URL, includes ...include.Resource) ServiceBindingResponse
type ServiceBindingSchema ¶ added in v0.15.0
type ServiceBindingSchema struct {
	Create InputParameterSchema `json:"create"`
}
    type ServiceBrokerCatalog ¶ added in v0.15.0
type ServiceBrokerCatalog struct {
	ID       string                `json:"id"`
	Metadata map[string]any        `json:"metadata"`
	Features BrokerCatalogFeatures `json:"features"`
}
    type ServiceBrokerLinks ¶ added in v0.13.0
type ServiceBrokerResponse ¶ added in v0.13.0
type ServiceBrokerResponse struct {
	GUID      string             `json:"guid"`
	Name      string             `json:"name"`
	URL       string             `json:"url"`
	CreatedAt time.Time          `json:"created_at"`
	UpdatedAt *time.Time         `json:"updated_at"`
	Metadata  Metadata           `json:"metadata"`
	Links     ServiceBrokerLinks `json:"links"`
}
    func ForServiceBroker ¶ added in v0.13.0
func ForServiceBroker(serviceBrokerRecord repositories.ServiceBrokerRecord, baseURL url.URL, includes ...include.Resource) ServiceBrokerResponse
type ServiceInstanceLinks ¶
type ServiceInstanceResponse ¶
type ServiceInstanceResponse struct {
	Name            string        `json:"name"`
	GUID            string        `json:"guid"`
	Type            string        `json:"type"`
	Tags            []string      `json:"tags"`
	LastOperation   lastOperation `json:"last_operation"`
	RouteServiceURL *string       `json:"route_service_url"`
	SyslogDrainURL  *string       `json:"syslog_drain_url"`
	CreatedAt        string                       `json:"created_at"`
	UpdatedAt        string                       `json:"updated_at"`
	Relationships    map[string]ToOneRelationship `json:"relationships"`
	Metadata         Metadata                     `json:"metadata"`
	Links            ServiceInstanceLinks         `json:"links"`
	Included         map[string][]any             `json:"included,omitempty"`
	MaintenanceInfo  *MaintenanceInfo             `json:"maintenance_info,omitempty"`
	UpgradeAvailable *bool                        `json:"upgrade_available,omitempty"`
}
    func ForServiceInstance ¶
func ForServiceInstance(serviceInstanceRecord repositories.ServiceInstanceRecord, baseURL url.URL, includes ...include.Resource) ServiceInstanceResponse
type ServiceInstanceSchema ¶ added in v0.15.0
type ServiceInstanceSchema struct {
	Create InputParameterSchema `json:"create"`
	Update InputParameterSchema `json:"update"`
}
    type ServiceOfferingLinks ¶ added in v0.13.0
type ServiceOfferingRelationships ¶ added in v0.13.0
type ServiceOfferingRelationships struct {
	ServiceBroker ToOneRelationship `json:"service_broker"`
}
    type ServiceOfferingResponse ¶ added in v0.13.0
type ServiceOfferingResponse struct {
	Name             string                       `json:"name"`
	GUID             string                       `json:"guid"`
	CreatedAt        time.Time                    `json:"created_at"`
	UpdatedAt        *time.Time                   `json:"updated_at"`
	Metadata         Metadata                     `json:"metadata"`
	Description      string                       `json:"description"`
	Tags             []string                     `json:"tags,omitempty"`
	Requires         []string                     `json:"requires,omitempty"`
	DocumentationURL *string                      `json:"documentation_url"`
	BrokerCatalog    ServiceBrokerCatalog         `json:"broker_catalog"`
	Relationships    ServiceOfferingRelationships `json:"relationships"`
	Links            ServiceOfferingLinks         `json:"links"`
	Included         map[string][]any             `json:"included,omitempty"`
}
    func ForServiceOffering ¶ added in v0.13.0
func ForServiceOffering(serviceOffering repositories.ServiceOfferingRecord, baseURL url.URL, includes ...include.Resource) ServiceOfferingResponse
type ServicePlanBrokerCatalog ¶ added in v0.15.0
type ServicePlanBrokerCatalog struct {
	ID       string              `json:"id"`
	Metadata map[string]any      `json:"metadata,omitempty"`
	Features ServicePlanFeatures `json:"features"`
}
    type ServicePlanFeatures ¶ added in v0.15.0
type ServicePlanLinks ¶ added in v0.13.0
type ServicePlanRelationships ¶ added in v0.13.0
type ServicePlanRelationships struct {
	ServiceOffering ToOneRelationship `json:"service_offering"`
}
    type ServicePlanResponse ¶ added in v0.13.0
type ServicePlanResponse struct {
	Name            string                       `json:"name"`
	GUID            string                       `json:"guid"`
	CreatedAt       time.Time                    `json:"created_at"`
	UpdatedAt       *time.Time                   `json:"updated_at"`
	Metadata        Metadata                     `json:"metadata"`
	Free            bool                         `json:"free"`
	Description     string                       `json:"description,omitempty"`
	BrokerCatalog   ServicePlanBrokerCatalog     `json:"broker_catalog"`
	Schemas         ServicePlanSchemas           `json:"schemas"`
	MaintenanceInfo MaintenanceInfo              `json:"maintenance_info"`
	VisibilityType  string                       `json:"visibility_type"`
	Available       bool                         `json:"available"`
	Relationships   map[string]ToOneRelationship `json:"relationships"`
	Links           ServicePlanLinks             `json:"links"`
}
    func ForServicePlan ¶ added in v0.13.0
func ForServicePlan(servicePlan repositories.ServicePlanRecord, baseURL url.URL, includes ...include.Resource) ServicePlanResponse
type ServicePlanSchemas ¶ added in v0.15.0
type ServicePlanSchemas struct {
	ServiceInstance ServiceInstanceSchema `json:"service_instance"`
	ServiceBinding  ServiceBindingSchema  `json:"service_binding"`
}
    type ServicePlanVisibilityResponse ¶ added in v0.13.0
type ServicePlanVisibilityResponse struct {
	Type          string                   `json:"type"`
	Organizations []VisibilityOrganization `json:"organizations,omitempty"`
}
    func ForServicePlanVisibility ¶ added in v0.13.0
func ForServicePlanVisibility(plan repositories.ServicePlanRecord, _ url.URL) ServicePlanVisibilityResponse
type SharedOrganizations ¶
type SharedOrganizations struct {
}
    type SpaceLinks ¶
type SpaceResponse ¶
type SpaceResponse struct {
	Name          string                       `json:"name"`
	GUID          string                       `json:"guid"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
	Links         SpaceLinks                   `json:"links"`
	Metadata      Metadata                     `json:"metadata"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Included      map[string][]any             `json:"included,omitempty"`
}
    func ForSpace ¶ added in v0.3.0
func ForSpace(space repositories.SpaceRecord, apiBaseURL url.URL, includes ...include.Resource) SpaceResponse
type StackLinks ¶ added in v0.14.0
type StackLinks struct {
	Self Link `json:"self"`
}
    type StackResponse ¶ added in v0.14.0
type StackResponse struct {
	GUID        string     `json:"guid"`
	CreatedAt   string     `json:"created_at"`
	UpdatedAt   string     `json:"updated_at"`
	Name        string     `json:"name"`
	Description string     `json:"description"`
	Metadata    Metadata   `json:"metadata"`
	Links       StackLinks `json:"links"`
}
    func ForStack ¶ added in v0.14.0
func ForStack(stackRecord repositories.StackRecord, baseURL url.URL, includes ...include.Resource) StackResponse
type TaskResponse ¶ added in v0.2.0
type TaskResponse struct {
	Name          string                       `json:"name"`
	GUID          string                       `json:"guid"`
	Command       string                       `json:"command,omitempty"`
	DropletGUID   string                       `json:"droplet_guid"`
	Metadata      Metadata                     `json:"metadata"`
	Relationships map[string]ToOneRelationship `json:"relationships"`
	Links         TaskLinks                    `json:"links"`
	SequenceID    int64                        `json:"sequence_id"`
	CreatedAt     string                       `json:"created_at"`
	UpdatedAt     string                       `json:"updated_at"`
	MemoryMB      int64                        `json:"memory_in_mb"`
	DiskMB        int64                        `json:"disk_in_mb"`
	State         string                       `json:"state"`
	Result        TaskResult                   `json:"result"`
}
    func ForTask ¶ added in v0.2.0
func ForTask(responseTask repositories.TaskRecord, baseURL url.URL, includes ...include.Resource) TaskResponse
type TaskResult ¶ added in v0.2.0
type TaskResult struct {
	FailureReason *string `json:"failure_reason"`
}
    type ToOneRelationship ¶ added in v0.15.0
type ToOneRelationship struct {
	Data Relationship `json:"data"`
}
    type UserResponse ¶ added in v0.7.0
type UserResponse struct {
	Name  string    `json:"username"`
	GUID  string    `json:"guid"`
	Links UserLinks `json:"links"`
}
    func ForUser ¶ added in v0.7.0
func ForUser(userRecord repositories.UserRecord, baseURL url.URL, _ ...include.Resource) UserResponse
type VisibilityOrganization ¶ added in v0.15.0
       Source Files
      ¶
      Source Files
      ¶
    
- app.go
- build.go
- buildpack.go
- deployment.go
- domain.go
- droplet.go
- error.go
- identity.go
- info.go
- job.go
- log_cache.go
- org.go
- package.go
- process.go
- process_stats.go
- resource.go
- role.go
- root.go
- route.go
- security_group.go
- service_binding.go
- service_broker.go
- service_instance.go
- service_offering.go
- service_plan.go
- shared.go
- space.go
- stack.go
- task.go
- user.go
 Click to show internal directories. 
   Click to hide internal directories.