Documentation ¶
Index ¶
- Constants
- 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 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 ErrorsResponse
- type IdentityResponse
- type IncludedData
- type Job
- type JobLinks
- type JobResponse
- type JobResponseError
- type Lifecycle
- type LifecycleData
- type Link
- type ListResponse
- func ForList[T, S any](itemPresenter itemPresenter[T, S], resources []T, baseURL, requestURL url.URL) ListResponse[S]
- func ForProcessList(processRecordList []repositories.ProcessRecord, baseURL, requestURL url.URL) ListResponse[ProcessResponse]
- func ForServiceBindingList(serviceBindingRecords []repositories.ServiceBindingRecord, ...) ListResponse[ServiceBindingResponse]
- func ForServiceRouteBindingsList(baseURL, requestURL url.URL) ListResponse[any]
- type LogCacheReadResponse
- type LogCacheReadResponseBatch
- type LogCacheReadResponseEnvelopes
- type LogCacheReadResponseLog
- type Metadata
- type OrgLinks
- type OrgResponse
- type Organization
- type PackageData
- type PackageLinks
- type PackageResponse
- type PageRef
- type PaginationData
- type PresentedError
- type ProcessDetails
- type ProcessInstancePort
- 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 Relationships
- type RoleLinks
- type RoleResponse
- type RootResponse
- type RootV3Response
- type RouteDestinationsResponse
- type RouteResponse
- type ServiceBindingLastOperationResponse
- type ServiceBindingLinks
- type ServiceBindingResponse
- type ServiceInstanceLinks
- type ServiceInstanceResponse
- type ServiceRouteBinding
- type SharedOrganizations
- type SpaceLinks
- type SpaceResponse
- type TaskLinks
- type TaskResponse
- type TaskResult
- type UserResponse
Constants ¶
View Source
const ( JobGUIDDelimiter = "~" StateComplete = "COMPLETE" StateFailed = "FAILED" StateProcessing = "PROCESSING" AppDeleteOperation = "app.delete" OrgDeleteOperation = "org.delete" RouteDeleteOperation = "route.delete" SpaceApplyManifestOperation = "space.apply_manifest" SpaceDeleteOperation = "space.delete" DomainDeleteOperation = "domain.delete" RoleDeleteOperation = "role.delete" )
View Source
const V3APIVersion = "3.117.0+cf-k8s"
Variables ¶
This section is empty.
Functions ¶
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 Relationships `json:"relationships"` Lifecycle Lifecycle `json:"lifecycle"` Metadata Metadata `json:"metadata"` Links AppLinks `json:"links"` }
func ForApp ¶
func ForApp(responseApp repositories.AppRecord, baseURL url.URL) AppResponse
type AppSSHEnabled ¶ added in v0.8.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 Relationships `json:"relationships"` Metadata Metadata `json:"metadata"` Links map[string]Link `json:"links"` }
func ForBuild ¶
func ForBuild(buildRecord repositories.BuildRecord, baseURL url.URL) 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) BuildpackResponse
type ChecksumData ¶
type CurrentDropletLinks ¶
type CurrentDropletResponse ¶
type CurrentDropletResponse struct { Relationship `json:",inline"` 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 Relationships `json:"relationships"` Links DeploymentLinks `json:"links"` }
func ForDeployment ¶ added in v0.8.0
func ForDeployment(responseDeployment repositories.DeploymentRecord, baseURL url.URL) 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) 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 Relationships `json:"relationships"` Metadata Metadata `json:"metadata"` Links map[string]*Link `json:"links"` }
func ForDroplet ¶
func ForDroplet(dropletRecord repositories.DropletRecord, baseURL url.URL) DropletResponse
type ErrorsResponse ¶
type ErrorsResponse struct {
Errors []PresentedError `json:"errors"`
}
type IdentityResponse ¶
func ForWhoAmI ¶
func ForWhoAmI(identity authorization.Identity) IdentityResponse
type IncludedData ¶
type IncludedData struct {
Apps []interface{} `json:"apps"`
}
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"` Warnings *string `json:"warnings"` Operation string `json:"operation"` State string `json:"state"` CreatedAt string `json:"created_at"` UpdatedAt string `json:"updated_at"` Links JobLinks `json:"links"` }
func ForJob ¶ added in v0.8.0
func ForJob(job Job, errors []JobResponseError, state string, baseURL url.URL) JobResponse
func ForManifestApplyJob ¶
func ForManifestApplyJob(job Job, 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 *IncludedData `json:"included,omitempty"` }
func ForList ¶
func ForList[T, S any](itemPresenter itemPresenter[T, S], resources []T, baseURL, requestURL url.URL) ListResponse[S]
func ForProcessList ¶
func ForProcessList(processRecordList []repositories.ProcessRecord, baseURL, requestURL url.URL) ListResponse[ProcessResponse]
func ForServiceBindingList ¶
func ForServiceBindingList(serviceBindingRecords []repositories.ServiceBindingRecord, appRecords []repositories.AppRecord, baseURL, requestURL url.URL) ListResponse[ServiceBindingResponse]
func ForServiceRouteBindingsList ¶
func ForServiceRouteBindingsList(baseURL, requestURL url.URL) ListResponse[any]
type LogCacheReadResponse ¶
type LogCacheReadResponse struct {
Envelopes LogCacheReadResponseEnvelopes `json:"envelopes"`
}
func ForLogs ¶
func ForLogs(logRecords []repositories.LogRecord) LogCacheReadResponse
type LogCacheReadResponseBatch ¶
type LogCacheReadResponseBatch struct { Timestamp int64 `json:"timestamp"` Log LogCacheReadResponseLog `json:"log"` Tags map[string]string `json:"tags,omitempty"` }
type LogCacheReadResponseEnvelopes ¶
type LogCacheReadResponseEnvelopes struct {
Batch []LogCacheReadResponseBatch `json:"batch"`
}
type LogCacheReadResponseLog ¶
type LogCacheReadResponseLog struct { Payload []byte `json:"payload"` Type loggregator_v2.Log_Type `json:"type"` }
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 Relationships `json:"relationships"` Metadata Metadata `json:"metadata"` Links OrgLinks `json:"links"` }
func ForOrg ¶ added in v0.3.0
func ForOrg(org repositories.OrgRecord, apiBaseURL url.URL) 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 Relationships `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) PackageResponse
type PaginationData ¶
type PresentedError ¶
type ProcessDetails ¶
type ProcessDetails struct{}
type ProcessInstancePort ¶
type ProcessLinks ¶
type ProcessResponse ¶
type ProcessResponse struct { GUID string `json:"guid"` Type string `json:"type"` Command string `json:"command"` Instances int `json:"instances"` MemoryMB int64 `json:"memory_in_mb"` DiskQuotaMB int64 `json:"disk_in_mb"` HealthCheck ProcessResponseHealthCheck `json:"health_check"` Relationships Relationships `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) ProcessResponse
type ProcessResponseHealthCheck ¶
type ProcessResponseHealthCheck struct { Type string `json:"type"` Data ProcessResponseHealthCheckData `json:"data"` }
type ProcessResponseHealthCheckData ¶
type ProcessResponseHealthCheckData struct { Type string `json:"-"` Timeout int64 `json:"timeout"` InvocationTimeout int64 `json:"invocation_timeout"` HTTPEndpoint string `json:"endpoint"` }
func (ProcessResponseHealthCheckData) MarshalJSON ¶
func (h ProcessResponseHealthCheckData) MarshalJSON() ([]byte, error)
type ProcessResponseProcessHealthCheckData ¶
type ProcessResponseProcessHealthCheckData struct {
Timeout *int64 `json:"timeout"`
}
type ProcessStatsResource ¶
type ProcessStatsResource struct { Type string `json:"type"` Index int `json:"index"` State string `json:"state"` Usage ProcessUsage `json:"usage"` Host *string `json:"host"` InstancePorts *[]ProcessInstancePort `json:"instance_ports,omitempty"` Uptime *int `json:"uptime"` MemQuota *int64 `json:"mem_quota"` DiskQuota *int64 `json:"disk_quota"` FDSQuota *int `json:"fds_quota"` IsolationSegment *string `json:"isolation_segment"` Details *ProcessDetails `json:"details"` }
type ProcessStatsResponse ¶
type ProcessStatsResponse struct {
Resources []ProcessStatsResource `json:"resources"`
}
func ForProcessStats ¶
func ForProcessStats(records []actions.PodStatsRecord) ProcessStatsResponse
type ProcessUsage ¶
type Relationship ¶
type Relationship struct {
Data *RelationshipData `json:"data"`
}
type RelationshipData ¶
type RelationshipData struct {
GUID string `json:"guid"`
}
type Relationships ¶
type Relationships map[string]Relationship
type RoleResponse ¶
type RoleResponse struct { GUID string `json:"guid"` CreatedAt string `json:"created_at"` UpdatedAt string `json:"updated_at"` Type string `json:"type"` Relationships Relationships `json:"relationships"` Links RoleLinks `json:"links"` }
func ForRole ¶ added in v0.7.1
func ForRole(role repositories.RoleRecord, apiBaseURL url.URL) RoleResponse
type RootResponse ¶
type RootResponse struct { Links map[string]*APILink `json:"links"` CFOnK8s bool `json:"cf_on_k8s"` }
func ForRoot ¶ added in v0.8.0
func ForRoot(baseURL url.URL) 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 Relationships `json:"relationships"` Metadata Metadata `json:"metadata"` Links routeLinks `json:"links"` }
func ForRoute ¶
func ForRoute(route repositories.RouteRecord, baseURL url.URL) RouteResponse
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 Relationships `json:"relationships"` Links ServiceBindingLinks `json:"links"` Metadata Metadata `json:"metadata"` }
func ForServiceBinding ¶
func ForServiceBinding(record repositories.ServiceBindingRecord, baseURL url.URL) ServiceBindingResponse
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 Relationships `json:"relationships"` Metadata Metadata `json:"metadata"` Links ServiceInstanceLinks `json:"links"` }
func ForServiceInstance ¶
func ForServiceInstance(serviceInstanceRecord repositories.ServiceInstanceRecord, baseURL url.URL) ServiceInstanceResponse
type ServiceRouteBinding ¶
type ServiceRouteBinding struct{}
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 Relationships `json:"relationships"` }
func ForSpace ¶ added in v0.3.0
func ForSpace(space repositories.SpaceRecord, apiBaseURL url.URL) SpaceResponse
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 Relationships `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) TaskResponse
type TaskResult ¶ added in v0.2.0
type TaskResult struct {
FailureReason *string `json:"failure_reason"`
}
type UserResponse ¶ added in v0.7.0
Source Files ¶
Click to show internal directories.
Click to hide internal directories.