Module com.sap.cloudfoundry.client.facade

Package com.sap.cloudfoundry.client.facade.rest

Interface CloudControllerRestClient

All Known Implementing Classes:

CloudControllerRestClientImpl

public interface CloudControllerRestClient

Interface defining operations available for the cloud controller REST client implementations

Method Summary

Modifier and Type	Method	Description
void	addDomain(String domainName)
void	addRoute(String host, String domainName, String path)
CloudPackage	asyncUploadApplication(String applicationName, Path file, UploadStatusCallback callback)
void	bindDropletToApp(UUID dropletGuid, UUID applicationGuid)
void	bindServiceInstance(String applicationName, String serviceInstanceName)
void	bindServiceInstance(String applicationName, String serviceInstanceName, Map<String,Object> parameters)
CloudTask	cancelTask(UUID taskGuid)
void	createApplication(String applicationName, Staging staging, Integer disk, Integer memory, List<String> uris, DockerInfo dockerInfo)
void	createApplication(String applicationName, Staging staging, Integer memory, List<String> uris)
CloudBuild	createBuild(UUID packageGuid)
void	createServiceBroker(CloudServiceBroker serviceBroker)
void	createServiceInstance(CloudServiceInstance serviceInstance)
CloudServiceKey	createServiceKey(String serviceInstanceName, String serviceKeyName, Map<String,Object> parameters)
void	createUserProvidedServiceInstance(CloudServiceInstance serviceInstance, Map<String,Object> credentials)
void	createUserProvidedServiceInstance(CloudServiceInstance serviceInstance, Map<String,Object> credentials, String syslogDrainUrl)
void	deleteAllApplications()
void	deleteAllServiceInstances()
void	deleteApplication(String applicationName)
void	deleteDomain(String domainName)
List<CloudRoute>	deleteOrphanedRoutes()
void	deleteRoute(String host, String domainName, String path)
void	deleteServiceBroker(String name)
void	deleteServiceInstance(CloudServiceInstance serviceInstance)
void	deleteServiceInstance(String serviceInstanceName)
void	deleteServiceKey(CloudServiceKey serviceKey)
void	deleteServiceKey(String serviceInstanceName, String serviceKeyName)
CloudApplication	getApplication(String applicationName)
CloudApplication	getApplication(String applicationName, boolean required)
CloudApplication	getApplication(UUID applicationGuid)
Map<String,String>	getApplicationEnvironment(String applicationName)
Map<String,String>	getApplicationEnvironment(UUID applicationGuid)
List<CloudEvent>	getApplicationEvents(String applicationName)
InstancesInfo	getApplicationInstances(CloudApplication app)
InstancesInfo	getApplicationInstances(String applicationName)
List<CloudApplication>	getApplications()
List<CloudApplication>	getApplicationsByMetadataLabelSelector(String labelSelector)
CloudBuild	getBuild(UUID packageGuid)
List<CloudBuild>	getBuildsForApplication(UUID applicationGuid)
List<CloudBuild>	getBuildsForPackage(UUID packageGuid)
URL	getControllerUrl()
DropletInfo	getCurrentDropletForApplication(UUID applicationGuid)
CloudDomain	getDefaultDomain()
List<CloudDomain>	getDomains()
List<CloudDomain>	getDomainsForOrganization()
List<CloudEvent>	getEvents()
List<CloudEvent>	getEventsByActee(UUID uuid)
CloudInfo	getInfo()
OAuthClient	getOAuthClient()
CloudOrganization	getOrganization(String organizationName)
CloudOrganization	getOrganization(String organizationName, boolean required)
List<CloudOrganization>	getOrganizations()
CloudPackage	getPackage(UUID packageGuid)
List<CloudPackage>	getPackagesForApplication(UUID applicationGuid)
List<CloudDomain>	getPrivateDomains()
List<ApplicationLog>	getRecentLogs(String applicationName)
List<ApplicationLog>	getRecentLogs(UUID applicationGuid)
List<CloudRoute>	getRoutes(String domainName)
Map<String,Object>	getServiceBindingParameters(UUID guid)
List<CloudServiceBinding>	getServiceBindings(UUID serviceInstanceGuid)
CloudServiceBroker	getServiceBroker(String name)
CloudServiceBroker	getServiceBroker(String name, boolean required)
List<CloudServiceBroker>	getServiceBrokers()
CloudServiceInstance	getServiceInstance(String serviceInstanceName)
CloudServiceInstance	getServiceInstance(String serviceInstanceName, boolean required)
Map<String,Object>	getServiceInstanceParameters(UUID guid)
List<CloudServiceInstance>	getServiceInstances()
List<CloudServiceInstance>	getServiceInstancesByMetadataLabelSelector(String labelSelector)
List<CloudServiceKey>	getServiceKeys(CloudServiceInstance serviceInstance)
List<CloudServiceKey>	getServiceKeys(String serviceInstanceName)
List<CloudServiceOffering>	getServiceOfferings()
List<CloudDomain>	getSharedDomains()
CloudSpace	getSpace(String spaceName)
CloudSpace	getSpace(String spaceName, boolean required)
CloudSpace	getSpace(String organizationName, String spaceName)
CloudSpace	getSpace(String organizationName, String spaceName, boolean required)
CloudSpace	getSpace(UUID spaceGuid)
List<UUID>	getSpaceAuditors()
List<UUID>	getSpaceAuditors(String spaceName)
List<UUID>	getSpaceAuditors(String organizationName, String spaceName)
List<UUID>	getSpaceAuditors(UUID spaceGuid)
List<UUID>	getSpaceDevelopers()
List<UUID>	getSpaceDevelopers(String spaceName)
List<UUID>	getSpaceDevelopers(String organizationName, String spaceName)
List<UUID>	getSpaceDevelopers(UUID spaceGuid)
List<UUID>	getSpaceManagers()
List<UUID>	getSpaceManagers(String spaceName)
List<UUID>	getSpaceManagers(String organizationName, String spaceName)
List<UUID>	getSpaceManagers(UUID spaceGuid)
List<CloudSpace>	getSpaces()
List<CloudSpace>	getSpaces(String organizationName)
CloudStack	getStack(String name)
CloudStack	getStack(String name, boolean required)
List<CloudStack>	getStacks()
CloudTask	getTask(UUID taskGuid)
List<CloudTask>	getTasks(String applicationName)
Upload	getUploadStatus(UUID packageGuid)
org.springframework.web.reactive.function.client.WebClient	getWebClient()
org.springframework.security.oauth2.common.OAuth2AccessToken	login()
void	logout()
void	rename(String applicationName, String newName)
StartingInfo	restartApplication(String applicationName)
CloudTask	runTask(String applicationName, CloudTask task)
StartingInfo	startApplication(String applicationName)
void	stopApplication(String applicationName)
void	unbindServiceInstance(CloudApplication application, CloudServiceInstance serviceInstance)
void	unbindServiceInstance(String applicationName, String serviceInstanceName)
void	updateApplicationDiskQuota(String applicationName, int disk)
void	updateApplicationEnv(String applicationName, Map<String,String> env)
void	updateApplicationInstances(String applicationName, int instances)
void	updateApplicationMemory(String applicationName, int memory)
void	updateApplicationMetadata(UUID guid, org.cloudfoundry.client.v3.Metadata metadata)
void	updateApplicationStaging(String applicationName, Staging staging)
void	updateApplicationUris(String applicationName, List<String> uris)
void	updateServiceBroker(CloudServiceBroker serviceBroker)
void	updateServiceInstanceMetadata(UUID guid, org.cloudfoundry.client.v3.Metadata metadata)
void	updateServiceParameters(String serviceName, Map<String,Object> parameters)
void	updateServicePlan(String serviceName, String planName)
void	updateServicePlanVisibilityForBroker(String name, boolean visibility)
void	updateServiceTags(String serviceName, List<String> tags)
void	uploadApplication(String applicationName, InputStream inputStream, UploadStatusCallback callback)
void	uploadApplication(String applicationName, Path file, UploadStatusCallback callback)

Method Detail

addDomain

void addDomain(String domainName)

addRoute

void addRoute(String host,
              String domainName,
              String path)

bindServiceInstance

void bindServiceInstance(String applicationName,
                         String serviceInstanceName)

bindServiceInstance

void bindServiceInstance(String applicationName,
                         String serviceInstanceName,
                         Map<String,Object> parameters)

createApplication

void createApplication(String applicationName,
                       Staging staging,
                       Integer memory,
                       List<String> uris)

createApplication

void createApplication(String applicationName,
                       Staging staging,
                       Integer disk,
                       Integer memory,
                       List<String> uris,
                       DockerInfo dockerInfo)

createServiceInstance

void createServiceInstance(CloudServiceInstance serviceInstance)

createServiceBroker

void createServiceBroker(CloudServiceBroker serviceBroker)

createServiceKey

CloudServiceKey createServiceKey(String serviceInstanceName,
                                 String serviceKeyName,
                                 Map<String,Object> parameters)

createUserProvidedServiceInstance

void createUserProvidedServiceInstance(CloudServiceInstance serviceInstance,
                                       Map<String,Object> credentials)

createUserProvidedServiceInstance

void createUserProvidedServiceInstance(CloudServiceInstance serviceInstance,
                                       Map<String,Object> credentials,
                                       String syslogDrainUrl)

deleteAllApplications

void deleteAllApplications()

deleteAllServiceInstances

void deleteAllServiceInstances()

deleteApplication

void deleteApplication(String applicationName)

deleteDomain

void deleteDomain(String domainName)

deleteOrphanedRoutes

List<CloudRoute> deleteOrphanedRoutes()

deleteRoute

void deleteRoute(String host,
                 String domainName,
                 String path)

deleteServiceInstance

void deleteServiceInstance(String serviceInstanceName)

deleteServiceInstance

void deleteServiceInstance(CloudServiceInstance serviceInstance)

deleteServiceBroker

void deleteServiceBroker(String name)

deleteServiceKey

void deleteServiceKey(String serviceInstanceName,
                      String serviceKeyName)

deleteServiceKey

void deleteServiceKey(CloudServiceKey serviceKey)

getApplication

CloudApplication getApplication(String applicationName)

getApplication

CloudApplication getApplication(String applicationName,
                                boolean required)

getApplication

CloudApplication getApplication(UUID applicationGuid)

getApplicationEnvironment

Map<String,String> getApplicationEnvironment(UUID applicationGuid)

getApplicationEnvironment

Map<String,String> getApplicationEnvironment(String applicationName)

getApplicationEvents

List<CloudEvent> getApplicationEvents(String applicationName)

getEventsByActee

List<CloudEvent> getEventsByActee(UUID uuid)

getApplicationInstances

InstancesInfo getApplicationInstances(String applicationName)

getApplicationInstances

InstancesInfo getApplicationInstances(CloudApplication app)

getApplications

List<CloudApplication> getApplications()

getControllerUrl

URL getControllerUrl()

getDefaultDomain

CloudDomain getDefaultDomain()

getDomains

List<CloudDomain> getDomains()

getDomainsForOrganization

List<CloudDomain> getDomainsForOrganization()

getEvents

List<CloudEvent> getEvents()

getInfo

CloudInfo getInfo()

getOrganization

CloudOrganization getOrganization(String organizationName)

getOrganization

CloudOrganization getOrganization(String organizationName,
                                  boolean required)

getOrganizations

List<CloudOrganization> getOrganizations()

getPrivateDomains

List<CloudDomain> getPrivateDomains()

getRecentLogs

List<ApplicationLog> getRecentLogs(String applicationName)

getRecentLogs

List<ApplicationLog> getRecentLogs(UUID applicationGuid)

getRoutes

List<CloudRoute> getRoutes(String domainName)

getServiceInstance

CloudServiceInstance getServiceInstance(String serviceInstanceName)

getServiceInstance

CloudServiceInstance getServiceInstance(String serviceInstanceName,
                                        boolean required)

getServiceBindings

List<CloudServiceBinding> getServiceBindings(UUID serviceInstanceGuid)

getServiceBroker

CloudServiceBroker getServiceBroker(String name)

getServiceBroker

CloudServiceBroker getServiceBroker(String name,
                                    boolean required)

getServiceBrokers

List<CloudServiceBroker> getServiceBrokers()

getServiceKeys

List<CloudServiceKey> getServiceKeys(String serviceInstanceName)

getServiceKeys

List<CloudServiceKey> getServiceKeys(CloudServiceInstance serviceInstance)

getServiceOfferings

List<CloudServiceOffering> getServiceOfferings()

getServiceInstances

List<CloudServiceInstance> getServiceInstances()

getSharedDomains

List<CloudDomain> getSharedDomains()

getSpace

CloudSpace getSpace(UUID spaceGuid)

getSpace

CloudSpace getSpace(String organizationName,
                    String spaceName)

getSpace

CloudSpace getSpace(String organizationName,
                    String spaceName,
                    boolean required)

getSpace

CloudSpace getSpace(String spaceName)

getSpace

CloudSpace getSpace(String spaceName,
                    boolean required)

getSpaceAuditors

List<UUID> getSpaceAuditors()

getSpaceAuditors

List<UUID> getSpaceAuditors(String spaceName)

getSpaceAuditors

List<UUID> getSpaceAuditors(String organizationName,
                            String spaceName)

getSpaceAuditors

List<UUID> getSpaceAuditors(UUID spaceGuid)

getSpaceDevelopers

List<UUID> getSpaceDevelopers()

getSpaceDevelopers

List<UUID> getSpaceDevelopers(String spaceName)

getSpaceDevelopers

List<UUID> getSpaceDevelopers(String organizationName,
                              String spaceName)

getSpaceDevelopers

List<UUID> getSpaceDevelopers(UUID spaceGuid)

getSpaceManagers

List<UUID> getSpaceManagers()

getSpaceManagers

List<UUID> getSpaceManagers(String spaceName)

getSpaceManagers

List<UUID> getSpaceManagers(String organizationName,
                            String spaceName)

getSpaceManagers

List<UUID> getSpaceManagers(UUID spaceGuid)

getSpaces

List<CloudSpace> getSpaces()

getSpaces

List<CloudSpace> getSpaces(String organizationName)

getStack

CloudStack getStack(String name)

getStack

CloudStack getStack(String name,
                    boolean required)

getStacks

List<CloudStack> getStacks()

login

org.springframework.security.oauth2.common.OAuth2AccessToken login()

logout

void logout()

rename

void rename(String applicationName,
            String newName)

restartApplication

StartingInfo restartApplication(String applicationName)

startApplication

StartingInfo startApplication(String applicationName)

stopApplication

void stopApplication(String applicationName)

unbindServiceInstance

void unbindServiceInstance(String applicationName,
                           String serviceInstanceName)

unbindServiceInstance

void unbindServiceInstance(CloudApplication application,
                           CloudServiceInstance serviceInstance)

updateApplicationDiskQuota

void updateApplicationDiskQuota(String applicationName,
                                int disk)

updateApplicationEnv

void updateApplicationEnv(String applicationName,
                          Map<String,String> env)

updateApplicationInstances

void updateApplicationInstances(String applicationName,
                                int instances)

updateApplicationMemory

void updateApplicationMemory(String applicationName,
                             int memory)

updateApplicationStaging

void updateApplicationStaging(String applicationName,
                              Staging staging)

updateApplicationUris

void updateApplicationUris(String applicationName,
                           List<String> uris)

updateServiceBroker

void updateServiceBroker(CloudServiceBroker serviceBroker)

updateServicePlanVisibilityForBroker

void updateServicePlanVisibilityForBroker(String name,
                                          boolean visibility)

updateServicePlan

void updateServicePlan(String serviceName,
                       String planName)

updateServiceParameters

void updateServiceParameters(String serviceName,
                             Map<String,Object> parameters)

updateServiceTags

void updateServiceTags(String serviceName,
                       List<String> tags)

uploadApplication

void uploadApplication(String applicationName,
                       Path file,
                       UploadStatusCallback callback)

uploadApplication

void uploadApplication(String applicationName,
                       InputStream inputStream,
                       UploadStatusCallback callback)
                throws IOException

Throws:

IOException

asyncUploadApplication

CloudPackage asyncUploadApplication(String applicationName,
                                    Path file,
                                    UploadStatusCallback callback)

getUploadStatus

Upload getUploadStatus(UUID packageGuid)

getTask

CloudTask getTask(UUID taskGuid)

getTasks

List<CloudTask> getTasks(String applicationName)

runTask

CloudTask runTask(String applicationName,
                  CloudTask task)

cancelTask

CloudTask cancelTask(UUID taskGuid)

createBuild

CloudBuild createBuild(UUID packageGuid)

getBuild

CloudBuild getBuild(UUID packageGuid)

bindDropletToApp

void bindDropletToApp(UUID dropletGuid,
                      UUID applicationGuid)

getBuildsForApplication

List<CloudBuild> getBuildsForApplication(UUID applicationGuid)

getWebClient

org.springframework.web.reactive.function.client.WebClient getWebClient()

getOAuthClient

OAuthClient getOAuthClient()

getServiceInstanceParameters

Map<String,Object> getServiceInstanceParameters(UUID guid)

getServiceBindingParameters

Map<String,Object> getServiceBindingParameters(UUID guid)

getBuildsForPackage

List<CloudBuild> getBuildsForPackage(UUID packageGuid)

getApplicationsByMetadataLabelSelector

List<CloudApplication> getApplicationsByMetadataLabelSelector(String labelSelector)

getServiceInstancesByMetadataLabelSelector

List<CloudServiceInstance> getServiceInstancesByMetadataLabelSelector(String labelSelector)

updateApplicationMetadata

void updateApplicationMetadata(UUID guid,
                               org.cloudfoundry.client.v3.Metadata metadata)

updateServiceInstanceMetadata

void updateServiceInstanceMetadata(UUID guid,
                                   org.cloudfoundry.client.v3.Metadata metadata)

getCurrentDropletForApplication

DropletInfo getCurrentDropletForApplication(UUID applicationGuid)

getPackage

CloudPackage getPackage(UUID packageGuid)

getPackagesForApplication

List<CloudPackage> getPackagesForApplication(UUID applicationGuid)