Documentation
¶
Index ¶
- func Login(options LoginOptions) error
- func LoginCheck(options LoginOptions) (bool, error)
- func Logout() error
- type AbapBinding
- type AbapConnection
- type LoginOptions
- type Manifest
- func (m Manifest) ApplicationHasProperty(index int, name string) (bool, error)
- func (m Manifest) GetAppName(index int) (string, error)
- func (m Manifest) GetApplicationProperty(index int, name string) (interface{}, error)
- func (m Manifest) GetApplications() ([]map[string]interface{}, error)
- func (m Manifest) GetName() string
- func (m Manifest) IsModified() bool
- func (m *Manifest) Transform() error
- func (m *Manifest) WriteManifest() error
- type ServiceKey
- type ServiceKeyOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Login ¶
func Login(options LoginOptions) error
Login logs user in to Cloud Foundry via cf cli. Checks if user is logged in first, if not perform 'cf login' command with appropriate parameters
func LoginCheck ¶
func LoginCheck(options LoginOptions) (bool, error)
LoginCheck checks if user is logged in to Cloud Foundry. If user is not logged in 'cf api' command will return string that contains 'User is not logged in' only if user is not logged in. If the returned string doesn't contain the substring 'User is not logged in' we know he is logged in.
Types ¶
type AbapBinding ¶
type AbapBinding struct {
Env string `json:"env"`
ID string `json:"id"`
Type string `json:"type"`
Version string `json:"version"`
}
AbapBinding contains information about service binding in Cloud Foundry
type AbapConnection ¶
type AbapConnection struct {
CommunicationArrangementID string `json:"communication_arrangement_id"`
CommunicationScenarioID string `json:"communication_scenario_id"`
CommunicationSystemID string `json:"communication_system_id"`
Password string `json:"password"`
Username string `json:"username"`
}
AbapConnection contains information about the ABAP connection for the ABAP endpoint
type LoginOptions ¶
type LoginOptions struct {
CfAPIEndpoint string
CfOrg string
CfSpace string
Username string
Password string
}
LoginOptions for logging in to CF
type Manifest ¶ added in v1.45.0
type Manifest struct {
// contains filtered or unexported fields
}
Manifest ...
func ReadManifest ¶ added in v1.45.0
ReadManifest Reads the manifest denoted by 'name'
func (Manifest) ApplicationHasProperty ¶ added in v1.45.0
ApplicationHasProperty Checks if the application denoted by 'index' has the property 'name'
func (Manifest) GetAppName ¶ added in v1.45.0
GetAppName Gets the name of the app at 'index'
func (Manifest) GetApplicationProperty ¶ added in v1.45.0
GetApplicationProperty ...
func (Manifest) GetApplications ¶ added in v1.45.0
GetApplications Returns all applications denoted in the manifest file. The applications are returned as a slice of maps. Each app is represented by a map.
func (*Manifest) Transform ¶ added in v1.45.0
Transform For each app in the manifest the first entry in the build packs list gets moved to the top level under the key 'buildpack'. The 'buildpacks' list is deleted.
func (*Manifest) WriteManifest ¶ added in v1.45.0
WriteManifest Writes the manifest to the file denoted by the name property (GetName()). The modified flag is resetted after the write operation.
type ServiceKey ¶
type ServiceKey struct {
Abap AbapConnection `json:"abap"`
Binding AbapBinding `json:"binding"`
Systemid string `json:"systemid"`
URL string `json:"url"`
}
ServiceKey struct to parse CF Service Key
func ReadServiceKeyAbapEnvironment ¶
func ReadServiceKeyAbapEnvironment(options ServiceKeyOptions, cfLogoutOption bool) (ServiceKey, error)
ReadServiceKeyAbapEnvironment from Cloud Foundry and returns it. Depending on user/developer requirements if he wants to perform further Cloud Foundry actions the cfLogoutOption parameters gives the option to logout after reading ABAP communication arrangement or not.