Documentation
¶
Index ¶
- type CFApplication
- type CFApplicationEnvJSON
- type CFBindingCredentials
- type CFCredentials
- type CFEndpoint
- type CFEnvironmentResponse
- type CFErrorResponse
- type CFErrorResponseHTTP
- type CFLastOperation
- type CFResource
- type CFResourceEntity
- type CFResourceMetadata
- type CFResponse
- type CFService
- type CFServiceBinding
- type CFServiceInstance
- type CFServiceKey
- type CFServicePlan
- type CFSystemEnvJSON
- type CFUAA
- type CFVCAPApplication
- type DestinationConfiguration
- type DestinationListDestinationsResponse
- type HTML5App
- type HTML5AppDescriptor
- type HTML5AppDescriptorRoute
- type HTML5AppDescriptorRouteScope
- type HTML5ApplicationFile
- type HTML5ApplicationFileContent
- type HTML5ApplicationFileMetadata
- type HTML5AppsRepo
- type HTML5ListApplicationFilesResponse
- type HTML5ListApplicationsResponse
- type HTML5Manifest
- type HTML5ManifestSapApp
- type HTML5ManifestSapAppApplicationVersion
- type HTML5ManifestSapCloud
- type HTML5ServiceMeta
- type UAAResponse
- type UAASecurityDescriptor
- type UAASecurityDescriptorRoleTemplate
- type UAASecurityDescriptorScope
- type XSUAA
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CFApplication ¶
CFApplication Cloud Foundry application
type CFApplicationEnvJSON ¶
type CFApplicationEnvJSON struct {
VCAPApplication CFVCAPApplication `json:"VCAP_APPLICATION,omitempty"`
}
CFApplicationEnvJSON struct
type CFBindingCredentials ¶
type CFBindingCredentials struct {
Endpoints *map[string]string `json:"endpoints,omitempty"`
HTML5AppsRepo *HTML5AppsRepo `json:"html5-apps-repo,omitempty"`
SAPCloudService *string `json:"sap.cloud.service,omitempty"`
SAPCloudServiceAlias *string `json:"sap.cloud.service.alias,omitempty"`
UAA *XSUAA `json:"uaa,omitempty"`
}
CFBindingCredentials struct
type CFCredentials ¶
type CFCredentials struct {
Vendor *string `json:"vendor,omitempty"`
URI *string `json:"uri,omitempty"`
GrantType *string `json:"grant_type,omitempty"`
SapCloudService *string `json:"sap.cloud.service,omitempty"`
SapCloudServiceAlias *string `json:"sap.cloud.service.alias,omitempty"`
UAA *CFUAA `json:"uaa,omitempty"`
HTML5AppsRepo *HTML5AppsRepo `json:"html5-apps-repo,omitempty"`
Endpoints *map[string]CFEndpoint `json:"endpoints,omitempty"`
}
CFCredentials Cloud Foundry response resource entity credentials
func (*CFCredentials) UnmarshalJSON ¶ added in v1.4.0
func (credentials *CFCredentials) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshals Cloud Foundry service credentials
type CFEndpoint ¶ added in v1.4.0
type CFEndpoint struct {
Timeout string `json:"timeout,omitempty"`
URL string `json:"url,omitempty"`
}
CFEndpoint business service endpoint
type CFEnvironmentResponse ¶
type CFEnvironmentResponse struct {
SystemEnvJSON CFSystemEnvJSON `json:"system_env_json,omitempty"`
ApplicationEnvJSON CFApplicationEnvJSON `json:"application_env_json,omitempty"`
}
CFEnvironmentResponse response of 'cf env'
type CFErrorResponse ¶ added in v1.4.0
type CFErrorResponse struct {
Description *string `json:"description,omitempty"`
ErrorCode *string `json:"error_code,omitempty"`
Code int `json:"code,omitempty"`
HTTP *CFErrorResponseHTTP `json:"http,omitempty"`
}
CFErrorResponse Cloud Foundry error response
type CFErrorResponseHTTP ¶ added in v1.4.0
type CFErrorResponseHTTP struct {
URI string `json:"uri,omitempty"`
Method string `json:"method,omitempty"`
Status int `json:"status,omitempty"`
}
CFErrorResponseHTTP Cloud Foundry error response HTTP data
type CFLastOperation ¶ added in v1.4.0
type CFLastOperation struct {
Type string `json:"type,omitempty"`
State string `json:"state,omitempty"`
Description string `json:"description,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
}
CFLastOperation Cloud Foundry last operation
type CFResource ¶
type CFResource struct {
// metadata
Metadata *CFResourceMetadata `json:"metadata,omitempty"`
// entity
Entity *CFResourceEntity `json:"entity,omitempty"`
}
CFResource Cloud Foundry response resource
type CFResourceEntity ¶
type CFResourceEntity struct {
// name
Name *string `json:"name,omitempty"`
// label
Label *string `json:"label,omitempty"`
// credentials
Credentials *CFCredentials `json:"credentials,omitempty"`
// last operation
LastOperation *CFLastOperation `json:"last_operation,omitempty"`
}
CFResourceEntity Cloud Foundry response resource entity
type CFResourceMetadata ¶
type CFResourceMetadata struct {
// created at
CreatedAt string `json:"created_at,omitempty"`
// guid
GUID string `json:"guid,omitempty"`
// updated at
UpdatedAt string `json:"updated_at,omitempty"`
// url
URL string `json:"url,omitempty"`
}
CFResourceMetadata Cloud Foundry response resource metadata
type CFResponse ¶
type CFResponse struct {
TotalResults int `json:"total_results"`
TotalPages int `json:"total_pages"`
PrevURL *string `json:"prev_url,omitempty"`
NextURL *string `json:"next_url,omitempty"`
Resources []CFResource `json:"resources"`
}
CFResponse Cloud Foundry response
type CFServiceBinding ¶
type CFServiceBinding struct {
Name string `json:"name,omitempty"`
Plan string `json:"plan,omitempty"`
Credentials CFBindingCredentials `json:"credentials,omitempty"`
}
CFServiceBinding struct
type CFServiceInstance ¶
type CFServiceInstance struct {
Name string
GUID string
UpdatedAt string
LastOperation CFLastOperation
}
CFServiceInstance Cloud Foundry service instance
type CFServiceKey ¶
type CFServiceKey struct {
Name string
GUID string
Credentials CFCredentials
}
CFServiceKey Cloud Foundry service
type CFServicePlan ¶
CFServicePlan Cloud Foundry service plan
type CFSystemEnvJSON ¶
type CFSystemEnvJSON struct {
VCAPServices map[string][]CFServiceBinding `json:"VCAP_SERVICES,omitempty"`
}
CFSystemEnvJSON struct
type CFUAA ¶
type CFUAA struct {
ClientID string `json:"clientid,omitempty"`
ClientSecret string `json:"clientsecret,omitempty"`
IdentityZone string `json:"identityzone,omitempty"`
URL string `json:"url,omitempty"`
XSAPPNAME string `json:"xsappname,omitempty"`
}
CFUAA Cloud Foundry XSUAA credentials
type CFVCAPApplication ¶ added in v1.1.0
type CFVCAPApplication struct {
CFApi string `json:"cf_api,omitempty"`
Limits map[string]int `json:"limits,omitempty"`
ApplicationName string `json:"application_name,omitempty"`
ApplicationUris []string `json:"application_uris,omitempty"`
Name string `json:"name,omitempty"`
SpaceName string `json:"space_name,omitempty"`
SpaceID string `json:"space_id,omitempty"`
Uris []string `json:"uris,omitempty"`
ApplicationID string `json:"application_id,omitempty"`
Version string `json:"version,omitempty"`
ApplicationVersion string `json:"application_version,omitempty"`
}
CFVCAPApplication struct
type DestinationConfiguration ¶ added in v1.4.0
type DestinationConfiguration struct {
Name string `json:"Name,omitempty"`
Description string `json:"Description,omitempty"`
Type string `json:"Type,omitempty"`
URL string `json:"URL,omitempty"`
Authentication string `json:"Authentication,omitempty"`
ProxyType string `json:"ProxyType,omitempty"`
TokenServiceURL string `json:"tokenServiceURL,omitempty"`
TokenServiceURLType string `json:"tokenServiceURLType,omitempty"`
ClientID string `json:"clientId,omitempty"`
ClientSecret string `json:"clientSecret,omitempty"`
Properties map[string]string
}
DestinationConfiguration destination configuration object
func (*DestinationConfiguration) MarshalJSON ¶ added in v1.4.0
func (dc *DestinationConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON marshals destination configuration
func (*DestinationConfiguration) UnmarshalJSON ¶ added in v1.4.0
func (dc *DestinationConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshals destination configuration
type DestinationListDestinationsResponse ¶ added in v1.4.0
type DestinationListDestinationsResponse = []DestinationConfiguration
DestinationListDestinationsResponse destination service list of destination configurations
type HTML5App ¶
type HTML5App struct {
ApplicationName string `json:"applicationName,omitempty"`
ApplicationVersion string `json:"applicationVersion,omitempty"`
ChangedOn string `json:"changedOn,omitempty"`
CreatedOn string `json:"createdOn,omitempty"`
IsDefault bool `json:"isDefault,omitempty"`
IsPublic bool `json:"public,omitempty"`
}
HTML5App HTML5 application
type HTML5AppDescriptor ¶ added in v1.4.0
type HTML5AppDescriptor struct {
AuthenticationMethod *string `json:"authenticationMethod,omitempty"`
Routes []HTML5AppDescriptorRoute `json:"routes,omitempty"`
}
HTML5AppDescriptor application descriptor (xs-app.json)
func (*HTML5AppDescriptor) GetAllScopes ¶ added in v1.4.0
func (d *HTML5AppDescriptor) GetAllScopes() []string
GetAllScopes returns set of all scopes of all routes, all verbs
func (*HTML5AppDescriptor) IsAuthorizationRequired ¶ added in v1.4.0
func (d *HTML5AppDescriptor) IsAuthorizationRequired() bool
IsAuthorizationRequired check if there are routes protected with scopes
type HTML5AppDescriptorRoute ¶ added in v1.4.0
type HTML5AppDescriptorRoute struct {
AuthenticationType *string `json:"authenticationType,omitempty"`
Scope *HTML5AppDescriptorRouteScope `json:"scope,omitempty"`
}
HTML5AppDescriptorRoute application descriptor route
func (*HTML5AppDescriptorRoute) GetAllScopes ¶ added in v1.4.0
func (r *HTML5AppDescriptorRoute) GetAllScopes() []string
GetAllScopes returns set of all scopes of all verbs
type HTML5AppDescriptorRouteScope ¶ added in v1.4.0
HTML5AppDescriptorRouteScope application descriptor route scope
func (*HTML5AppDescriptorRouteScope) UnmarshalJSON ¶ added in v1.4.0
func (s *HTML5AppDescriptorRouteScope) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal scope
type HTML5ApplicationFile ¶
type HTML5ApplicationFile struct {
FilePath string `json:"filePath,omitempty"`
FileMetadata HTML5ApplicationFileMetadata
}
HTML5ApplicationFile application file
type HTML5ApplicationFileContent ¶ added in v1.1.0
HTML5ApplicationFileContent application file content
type HTML5ApplicationFileMetadata ¶
HTML5ApplicationFileMetadata application file metadata
type HTML5AppsRepo ¶
type HTML5AppsRepo struct {
AppHostID string `json:"app_host_id,omitempty"`
}
HTML5AppsRepo struct
type HTML5ListApplicationFilesResponse ¶
type HTML5ListApplicationFilesResponse []HTML5ApplicationFile
HTML5ListApplicationFilesResponse response of list application files API
type HTML5ListApplicationsResponse ¶
type HTML5ListApplicationsResponse []HTML5App
HTML5ListApplicationsResponse response of list applications API
type HTML5Manifest ¶ added in v1.2.0
type HTML5Manifest struct {
SapApp HTML5ManifestSapApp `json:"sap.app,omitempty"`
SapCloud HTML5ManifestSapCloud `json:"sap.cloud,omitempty"`
}
HTML5Manifest HTML5 application manifest file
type HTML5ManifestSapApp ¶ added in v1.2.0
type HTML5ManifestSapApp struct {
ID string `json:"id,omitempty"`
Type string `json:"type,omitempty"`
ApplicationVersion HTML5ManifestSapAppApplicationVersion `json:"applicationVersion,omitempty"`
}
HTML5ManifestSapApp HTML5 application manifest file "sap.app" namespace
type HTML5ManifestSapAppApplicationVersion ¶ added in v1.2.0
type HTML5ManifestSapAppApplicationVersion struct {
Version string `json:"version,omitempty"`
}
HTML5ManifestSapAppApplicationVersion HTML5 application manifest file "sap.app/applicationVersion" namespace
type HTML5ManifestSapCloud ¶ added in v1.4.0
type HTML5ManifestSapCloud struct {
Public bool `json:"public,omitempty"`
Service string `json:"service,omitempty"`
}
HTML5ManifestSapCloud HTML5 application manifest file "sap.cloud" namespace
type HTML5ServiceMeta ¶ added in v1.1.0
type HTML5ServiceMeta struct {
Status string `json:"status,omitempty"`
Size int `json:"size,omitempty"`
SizeLimit int `json:"sizeLimit,omitempty"`
ChangedOn string `json:"changedOn,omitempty"`
Error error
}
HTML5ServiceMeta HTML5 service metadata
type UAAResponse ¶
type UAAResponse struct {
AccessToken string `json:"access_token,omitempty"`
TokenType string `json:"token_type,omitempty"`
ExpiresIn int `json:"expires_in,omitempty"`
Scope string `json:"scope,omitempty"`
JTI string `json:"jti,omitempty"`
}
UAAResponse XSUAA response with token
type UAASecurityDescriptor ¶ added in v1.4.0
type UAASecurityDescriptor struct {
XSAPPNAME string `json:"xsappname,omitempty"`
ForeignScopeReferences []string `json:"foreign-scope-references,omitempty"`
Scopes []UAASecurityDescriptorScope `json:"scopes,omitempty"`
RoleTemplates []UAASecurityDescriptorRoleTemplate `json:"role-templates,omitempty"`
}
UAASecurityDescriptor XSUAA security descriptor (xs-security.json)
type UAASecurityDescriptorRoleTemplate ¶ added in v1.4.0
type UAASecurityDescriptorRoleTemplate struct {
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
ScopeReferences []string `json:"scope-references,omitempty"`
}
UAASecurityDescriptorRoleTemplate XSUAA security descriptor role template
type UAASecurityDescriptorScope ¶ added in v1.4.0
type UAASecurityDescriptorScope struct {
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
}
UAASecurityDescriptorScope XSUAA security descriptor scope
Source Files
¶
- cf_application.go
- cf_environment_response.go
- cf_error.go
- cf_response.go
- cf_service.go
- cf_service_instance.go
- cf_service_key.go
- cf_service_plan.go
- destination_configuration.go
- html5_app.go
- html5_app_descriptor.go
- html5_file_content.go
- html5_file_metadata.go
- html5_files.go
- html5_manifest.go
- html5_service_meta.go
- uaa_response.go
- uaa_security_descriptor.go