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)
Optional<String>	bindServiceInstance(String applicationName, String serviceInstanceName)
Optional<String>	bindServiceInstance(String applicationName, String serviceInstanceName, Map<String,Object> parameters)
CloudTask	cancelTask(UUID taskGuid)
CloudServiceKey	createAndFetchServiceKey(CloudServiceKey keyModel, String serviceInstanceName)
void	createApplication(ApplicationToCreateDto applicationToCreateDto)
CloudBuild	createBuild(UUID packageGuid)
CloudPackage	createDockerPackage(UUID applicationGuid, DockerInfo dockerInfo)
String	createServiceBroker(CloudServiceBroker serviceBroker)
void	createServiceInstance(CloudServiceInstance serviceInstance)
Optional<String>	createServiceKey(CloudServiceKey keyModel, String serviceInstanceName)
Optional<String>	createServiceKey(String serviceInstanceName, String serviceKeyName, Map<String,Object> parameters)
void	createUserProvidedServiceInstance(CloudServiceInstance serviceInstance)
void	deleteApplication(String applicationName)
void	deleteDomain(String domainName)
void	deleteOrphanedRoutes()
void	deleteRoute(String host, String domainName, String path)
Optional<String>	deleteServiceBinding(String serviceInstanceName, String serviceKeyName)
Optional<String>	deleteServiceBinding(UUID bindingGuid)
String	deleteServiceBroker(String name)
void	deleteServiceInstance(CloudServiceInstance serviceInstance)
void	deleteServiceInstance(String serviceInstanceName)
List<CloudServiceBinding>	getAppBindings(UUID applicationGuid)
CloudApplication	getApplication(String applicationName)
CloudApplication	getApplication(String applicationName, boolean required)
Map<String,String>	getApplicationEnvironment(String applicationName)
Map<String,String>	getApplicationEnvironment(UUID applicationGuid)
List<CloudEvent>	getApplicationEvents(String applicationName)
UUID	getApplicationGuid(String applicationName)
InstancesInfo	getApplicationInstances(CloudApplication app)
InstancesInfo	getApplicationInstances(UUID applicationGuid)
String	getApplicationName(UUID applicationGuid)
CloudProcess	getApplicationProcess(UUID applicationGuid)
List<CloudRoute>	getApplicationRoutes(UUID applicationGuid)
List<CloudApplication>	getApplications()
List<CloudApplication>	getApplicationsByMetadataLabelSelector(String labelSelector)
boolean	getApplicationSshEnabled(UUID applicationGuid)
CloudAsyncJob	getAsyncJob(String jobId)
CloudBuild	getBuild(UUID packageGuid)
List<CloudBuild>	getBuildsForApplication(UUID applicationGuid)
List<CloudBuild>	getBuildsForPackage(UUID packageGuid)
DropletInfo	getCurrentDropletForApplication(UUID applicationGuid)
CloudDomain	getDefaultDomain()
List<CloudDomain>	getDomains()
List<CloudDomain>	getDomainsForOrganization()
List<CloudEvent>	getEvents()
List<CloudEvent>	getEventsByTarget(UUID uuid)
CloudPackage	getPackage(UUID packageGuid)
List<CloudPackage>	getPackagesForApplication(UUID applicationGuid)
List<CloudDomain>	getPrivateDomains()
UUID	getRequiredServiceInstanceGuid(String name)
List<CloudRoute>	getRoutes(String domainName)
List<CloudServiceBinding>	getServiceAppBindings(UUID serviceInstanceGuid)
CloudServiceBinding	getServiceBinding(UUID serviceBindingGuid)
CloudServiceBinding	getServiceBindingForApplication(UUID applicationId, UUID serviceInstanceGuid)
Map<String,Object>	getServiceBindingParameters(UUID guid)
CloudServiceBroker	getServiceBroker(String name)
CloudServiceBroker	getServiceBroker(String name, boolean required)
List<CloudServiceBroker>	getServiceBrokers()
CloudServiceInstance	getServiceInstance(String serviceInstanceName)
CloudServiceInstance	getServiceInstance(String serviceInstanceName, boolean required)
String	getServiceInstanceName(UUID serviceInstanceGuid)
Map<String,Object>	getServiceInstanceParameters(UUID guid)
List<CloudServiceInstance>	getServiceInstancesByMetadataLabelSelector(String labelSelector)
List<CloudServiceInstance>	getServiceInstancesWithoutAuxiliaryContentByMetadataLabelSelector(String labelSelector)
List<CloudServiceInstance>	getServiceInstancesWithoutAuxiliaryContentByNames(List<String> names)
CloudServiceInstance	getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName)
CloudServiceInstance	getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName, boolean required)
CloudServiceKey	getServiceKey(String serviceInstanceName, String serviceKeyName)
List<CloudServiceKey>	getServiceKeys(CloudServiceInstance serviceInstance)
List<CloudServiceKey>	getServiceKeys(String serviceInstanceName)
List<CloudServiceKey>	getServiceKeysWithCredentials(CloudServiceInstance serviceInstance)
List<CloudServiceKey>	getServiceKeysWithCredentials(String serviceInstanceName)
List<CloudServiceOffering>	getServiceOfferings()
List<CloudDomain>	getSharedDomains()
CloudStack	getStack(String name)
CloudStack	getStack(String name, boolean required)
List<CloudStack>	getStacks()
CloudSpace	getTarget()
CloudTask	getTask(UUID taskGuid)
List<CloudTask>	getTasks(String applicationName)
Upload	getUploadStatus(UUID packageGuid)
Map<String,Object>	getUserProvidedServiceInstanceParameters(UUID guid)
Set<UserRole>	getUserRolesBySpaceAndUser(UUID spaceGuid, UUID userGuid)
void	rename(String applicationName, String newName)
void	restartApplication(String applicationName)
CloudTask	runTask(String applicationName, CloudTask task)
void	startApplication(String applicationName)
void	stopApplication(String applicationName)
Optional<String>	unbindServiceInstance(String applicationName, String serviceInstanceName)
Optional<String>	unbindServiceInstance(UUID applicationGuid, UUID serviceInstanceGuid)
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	updateApplicationRoutes(String applicationName, Set<CloudRoute> routes)
void	updateApplicationStaging(String applicationName, Staging staging)
void	updateServiceBindingMetadata(UUID guid, org.cloudfoundry.client.v3.Metadata metadata)
String	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, ServicePlanVisibility visibility)
void	updateServiceSyslogDrainUrl(String serviceName, String syslogDrainUrl)
void	updateServiceTags(String serviceName, List<String> tags)

Method Detail

getTarget

CloudSpace getTarget()

addDomain

void addDomain(String domainName)

addRoute

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

bindServiceInstance

Optional<String> bindServiceInstance(String applicationName,
                                     String serviceInstanceName)

bindServiceInstance

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

createApplication

void createApplication(ApplicationToCreateDto applicationToCreateDto)

createServiceInstance

void createServiceInstance(CloudServiceInstance serviceInstance)

createServiceBroker

String createServiceBroker(CloudServiceBroker serviceBroker)

createAndFetchServiceKey

CloudServiceKey createAndFetchServiceKey(CloudServiceKey keyModel,
                                         String serviceInstanceName)

createServiceKey

Optional<String> createServiceKey(CloudServiceKey keyModel,
                                  String serviceInstanceName)

createServiceKey

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

createUserProvidedServiceInstance

void createUserProvidedServiceInstance(CloudServiceInstance serviceInstance)

deleteApplication

void deleteApplication(String applicationName)

deleteDomain

void deleteDomain(String domainName)

deleteOrphanedRoutes

void deleteOrphanedRoutes()

deleteRoute

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

deleteServiceInstance

void deleteServiceInstance(String serviceInstanceName)

deleteServiceInstance

void deleteServiceInstance(CloudServiceInstance serviceInstance)

deleteServiceBroker

String deleteServiceBroker(String name)

deleteServiceBinding

Optional<String> deleteServiceBinding(String serviceInstanceName,
                                      String serviceKeyName)

deleteServiceBinding

Optional<String> deleteServiceBinding(UUID bindingGuid)

getApplication

CloudApplication getApplication(String applicationName)

getApplication

CloudApplication getApplication(String applicationName,
                                boolean required)

getApplicationGuid

UUID getApplicationGuid(String applicationName)

getApplicationName

String getApplicationName(UUID applicationGuid)

getApplicationEnvironment

Map<String,String> getApplicationEnvironment(UUID applicationGuid)

getApplicationEnvironment

Map<String,String> getApplicationEnvironment(String applicationName)

getApplicationEvents

List<CloudEvent> getApplicationEvents(String applicationName)

getEventsByTarget

List<CloudEvent> getEventsByTarget(UUID uuid)

getApplicationInstances

InstancesInfo getApplicationInstances(CloudApplication app)

getApplicationInstances

InstancesInfo getApplicationInstances(UUID applicationGuid)

getApplicationProcess

CloudProcess getApplicationProcess(UUID applicationGuid)

getApplicationRoutes

List<CloudRoute> getApplicationRoutes(UUID applicationGuid)

getApplicationSshEnabled

boolean getApplicationSshEnabled(UUID applicationGuid)

getApplications

List<CloudApplication> getApplications()

getDefaultDomain

CloudDomain getDefaultDomain()

getDomains

List<CloudDomain> getDomains()

getDomainsForOrganization

List<CloudDomain> getDomainsForOrganization()

getEvents

List<CloudEvent> getEvents()

getPrivateDomains

List<CloudDomain> getPrivateDomains()

getRoutes

List<CloudRoute> getRoutes(String domainName)

getRequiredServiceInstanceGuid

UUID getRequiredServiceInstanceGuid(String name)

getServiceInstance

CloudServiceInstance getServiceInstance(String serviceInstanceName)

getServiceInstance

CloudServiceInstance getServiceInstance(String serviceInstanceName,
                                        boolean required)

getServiceInstanceName

String getServiceInstanceName(UUID serviceInstanceGuid)

getServiceInstanceWithoutAuxiliaryContent

CloudServiceInstance getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName)

getServiceInstanceWithoutAuxiliaryContent

CloudServiceInstance getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName,
                                                               boolean required)

getServiceBinding

CloudServiceBinding getServiceBinding(UUID serviceBindingGuid)

getServiceAppBindings

List<CloudServiceBinding> getServiceAppBindings(UUID serviceInstanceGuid)

getAppBindings

List<CloudServiceBinding> getAppBindings(UUID applicationGuid)

getServiceBindingForApplication

CloudServiceBinding getServiceBindingForApplication(UUID applicationId,
                                                    UUID serviceInstanceGuid)

getServiceBroker

CloudServiceBroker getServiceBroker(String name)

getServiceBroker

CloudServiceBroker getServiceBroker(String name,
                                    boolean required)

getServiceBrokers

List<CloudServiceBroker> getServiceBrokers()

getServiceKey

CloudServiceKey getServiceKey(String serviceInstanceName,
                              String serviceKeyName)

getServiceKeys

List<CloudServiceKey> getServiceKeys(String serviceInstanceName)

getServiceKeysWithCredentials

List<CloudServiceKey> getServiceKeysWithCredentials(String serviceInstanceName)

getServiceKeys

List<CloudServiceKey> getServiceKeys(CloudServiceInstance serviceInstance)

getServiceKeysWithCredentials

List<CloudServiceKey> getServiceKeysWithCredentials(CloudServiceInstance serviceInstance)

getServiceOfferings

List<CloudServiceOffering> getServiceOfferings()

getSharedDomains

List<CloudDomain> getSharedDomains()

getStack

CloudStack getStack(String name)

getStack

CloudStack getStack(String name,
                    boolean required)

getStacks

List<CloudStack> getStacks()

rename

void rename(String applicationName,
            String newName)

restartApplication

void restartApplication(String applicationName)

startApplication

void startApplication(String applicationName)

stopApplication

void stopApplication(String applicationName)

unbindServiceInstance

Optional<String> unbindServiceInstance(String applicationName,
                                       String serviceInstanceName)

unbindServiceInstance

Optional<String> unbindServiceInstance(UUID applicationGuid,
                                       UUID serviceInstanceGuid)

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)

updateApplicationRoutes

void updateApplicationRoutes(String applicationName,
                             Set<CloudRoute> routes)

updateServiceBroker

String updateServiceBroker(CloudServiceBroker serviceBroker)

updateServicePlanVisibilityForBroker

void updateServicePlanVisibilityForBroker(String name,
                                          ServicePlanVisibility visibility)

updateServicePlan

void updateServicePlan(String serviceName,
                       String planName)

updateServiceParameters

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

updateServiceSyslogDrainUrl

void updateServiceSyslogDrainUrl(String serviceName,
                                 String syslogDrainUrl)

updateServiceTags

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

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)

getServiceInstanceParameters

Map<String,Object> getServiceInstanceParameters(UUID guid)

getUserProvidedServiceInstanceParameters

Map<String,Object> getUserProvidedServiceInstanceParameters(UUID guid)

getServiceBindingParameters

Map<String,Object> getServiceBindingParameters(UUID guid)

getBuildsForPackage

List<CloudBuild> getBuildsForPackage(UUID packageGuid)

getApplicationsByMetadataLabelSelector

List<CloudApplication> getApplicationsByMetadataLabelSelector(String labelSelector)

getServiceInstancesWithoutAuxiliaryContentByNames

List<CloudServiceInstance> getServiceInstancesWithoutAuxiliaryContentByNames(List<String> names)

getServiceInstancesByMetadataLabelSelector

List<CloudServiceInstance> getServiceInstancesByMetadataLabelSelector(String labelSelector)

getServiceInstancesWithoutAuxiliaryContentByMetadataLabelSelector

List<CloudServiceInstance> getServiceInstancesWithoutAuxiliaryContentByMetadataLabelSelector(String labelSelector)

updateApplicationMetadata

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

updateServiceInstanceMetadata

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

updateServiceBindingMetadata

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

getCurrentDropletForApplication

DropletInfo getCurrentDropletForApplication(UUID applicationGuid)

getPackage

CloudPackage getPackage(UUID packageGuid)

getPackagesForApplication

List<CloudPackage> getPackagesForApplication(UUID applicationGuid)

getUserRolesBySpaceAndUser

Set<UserRole> getUserRolesBySpaceAndUser(UUID spaceGuid,
                                         UUID userGuid)

createDockerPackage

CloudPackage createDockerPackage(UUID applicationGuid,
                                 DockerInfo dockerInfo)

getAsyncJob

CloudAsyncJob getAsyncJob(String jobId)