Class CloudFoundryApi

This abstracts away the details of common CF API operations. The implementations use a mix of API versions and HTTP libs and will likely change.

Hierarchy

CloudFoundryApi

Index

Constructors

constructor

Properties

Object literals

jsonContentHeader

Constructors

constructor

new CloudFoundryApi(cf: CloudFoundryClientV2, retryInterval?: number): CloudFoundryApi

- Defined in lib/api/CloudFoundryApi.ts:75
Parameters
- cf: CloudFoundryClientV2
- Default value retryInterval: number = 1000
Returns CloudFoundryApi

Properties

Private authHeader

authHeader: any

Private cf

cf: CloudFoundryClientV2

Private httpClient

httpClient: HttpClient

Private retryInterval

retryInterval: number

Methods

addRouteToApp

addRouteToApp(spaceGuid: string, appGuid: string, hostName: string, domainGuid: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:275
Parameters
- spaceGuid: string
- appGuid: string
- hostName: string
- domainGuid: string
Returns Promise<any>

addServices

addServices(appGuid: string, servicesToAdd: any[]): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:255
Parameters
- appGuid: string
- servicesToAdd: any[]
Returns Promise<any>

buildDroplet

buildDroplet(packageGuid: string): Promise<AxiosResponse<any>>

- Defined in lib/api/CloudFoundryApi.ts:214
Parameters
- packageGuid: string
Returns Promise<AxiosResponse<any>>

createApp

createApp(spaceGuid: string, manifestApp: ManifestApplication): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:116
Parameters
- spaceGuid: string
- manifestApp: ManifestApplication
Returns Promise<any>

deleteApp

deleteApp(appGuid: string): Promise<AxiosResponse<any>>

- Defined in lib/api/CloudFoundryApi.ts:157
Parameters
- appGuid: string
Returns Promise<AxiosResponse<any>>

getApp

getApp(spaceGuid: string, appName: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:108
Parameters
- spaceGuid: string
- appName: string
Returns Promise<any>

getAppRoutes

getAppRoutes(appGuid: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:269
Parameters
- appGuid: string
Returns Promise<any>

getAppServiceBindings

getAppServiceBindings(appGuid: string): Promise<any[]>

- Defined in lib/api/CloudFoundryApi.ts:243
Parameters
- appGuid: string
Returns Promise<any[]>

getDomain

getDomain(domainName: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:288
Parameters
- domainName: string
Returns Promise<any>

getDomainByGuid

getDomainByGuid(domainGuid: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:294
Parameters
- domainGuid: string
Returns Promise<any>

getOrganisationGuidByName

getOrganisationGuidByName(orgName: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:336
Parameters
- orgName: string
Returns Promise<any>

getProcessStats

getProcessStats(appGuid: string): Promise<AxiosResponse<any>>

- Defined in lib/api/CloudFoundryApi.ts:165
Parameters
- appGuid: string
Returns Promise<AxiosResponse<any>>

getSpaceByName

getSpaceByName(organisationGuid: string, spaceName: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:318
Parameters
- organisationGuid: string
- spaceName: string
Returns Promise<any>

getUserServices

getUserServices(): Promise<any[]>

- Defined in lib/api/CloudFoundryApi.ts:249
Returns Promise<any[]>

Private normalizeManifestMemory

normalizeManifestMemory(memory: string): number

- Defined in lib/api/CloudFoundryApi.ts:381
Parameters
- memory: string
Returns number

Private refreshToken

refreshToken(): Promise<void>

- Defined in lib/api/CloudFoundryApi.ts:350
Returns Promise<void>

removeRouteFromApp

removeRouteFromApp(spaceGuid: string, appGuid: string, hostName: string, domainName: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:300
Parameters
- spaceGuid: string
- appGuid: string
- hostName: string
- domainName: string
Returns Promise<any>

removeServices

removeServices(appGuid: string, serviceToRemove: any[]): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:262
Parameters
- appGuid: string
- serviceToRemove: any[]
Returns Promise<any>

renameApp

renameApp(appGuid: string, appName: string): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:146
Parameters
- appGuid: string
- appName: string
Returns Promise<any>

Private retryUntilCondition

retryUntilCondition(action: function, successCondition: function, failureCondition: function): Promise<AxiosResponse>

- Defined in lib/api/CloudFoundryApi.ts:365
Parameters
- action: function
  - - (): Promise<AxiosResponse>
    - Returns Promise<AxiosResponse>
- successCondition: function
  - - (r: AxiosResponse): boolean
    - Parameters
      - r: AxiosResponse
      Returns boolean
- failureCondition: function
  - - (r: AxiosResponse): boolean
    - Parameters
      - r: AxiosResponse
      Returns boolean
Returns Promise<AxiosResponse>

setCurrentDropletForApp

setCurrentDropletForApp(appGuid: string, dropletGuid: string): Promise<AxiosResponse<any>>

- Defined in lib/api/CloudFoundryApi.ts:234
Parameters
- appGuid: string
- dropletGuid: string
Returns Promise<AxiosResponse<any>>

startApp

startApp(appGuid: string): Promise<AxiosResponse<any>>

- Defined in lib/api/CloudFoundryApi.ts:91
Parameters
- appGuid: string
Returns Promise<AxiosResponse<any>>

stopApp

stopApp(appGuid: string): Promise<AxiosResponse<any>>

- Defined in lib/api/CloudFoundryApi.ts:82
Parameters
- appGuid: string
Returns Promise<AxiosResponse<any>>

updateAppWithManifest

updateAppWithManifest(appGuid: string, manifestApp: ManifestApplication): Promise<any>

- Defined in lib/api/CloudFoundryApi.ts:132
Parameters
- appGuid: string
- manifestApp: ManifestApplication
Returns Promise<any>

uploadPackage

uploadPackage(appGuid: string, packageFile: ReadStream): Promise<AxiosResponse<any>>

- Defined in lib/api/CloudFoundryApi.ts:173
Parameters
- appGuid: string
- packageFile: ReadStream
Returns Promise<AxiosResponse<any>>

Object literals

Private jsonContentHeader

jsonContentHeader: object

Content-Type

Content-Type: string = "application/json"

Generated using TypeDoc