public class DefaultSkipperClient extends Object implements SkipperClient
Modifier and Type | Class and Description |
---|---|
protected static class |
DefaultSkipperClient.DeployersResponseWrapper |
protected static class |
DefaultSkipperClient.HateoasResponseWrapper<T> |
protected static class |
DefaultSkipperClient.PackageMetadatasResponseWrapper |
protected static class |
DefaultSkipperClient.ReleasesResponseWrapper |
protected static class |
DefaultSkipperClient.RepositoriesResponseWrapper |
Modifier and Type | Field and Description |
---|---|
protected RestTemplate |
restTemplate |
Constructor and Description |
---|
DefaultSkipperClient(String baseUri)
Create a new DefaultSkipperClient given the URL of the Server.
|
DefaultSkipperClient(String baseUri,
RestTemplate restTemplate)
Create a new DefaultSkipperClient given the base URI of the Server and a preconfigured
RestTemplate.
|
Modifier and Type | Method and Description |
---|---|
org.springframework.cloud.skipper.domain.CancelResponse |
cancel(org.springframework.cloud.skipper.domain.CancelRequest cancelRequest)
Sends a cancel request for current release operation
|
void |
delete(String releaseName,
boolean deletePackage)
Delete a specific release.
|
org.springframework.cloud.skipper.domain.LogInfo |
getLog(String releaseName)
Fetch the logs of the latest release identified by the given name.
|
org.springframework.cloud.skipper.domain.LogInfo |
getLog(String releaseName,
String appName)
Fetch the logs of the latest release identified by the given release name
and a specific application name inside the release.
|
org.springframework.cloud.skipper.domain.Template |
getSpringCloudDeployerApplicationTemplate()
Return the template for deploying a Spring Boot Application using skipper.
|
Collection<org.springframework.cloud.skipper.domain.Release> |
history(String releaseName)
List all releases for the given release name.
|
org.springframework.cloud.skipper.domain.AboutResource |
info() |
org.springframework.cloud.skipper.domain.Release |
install(org.springframework.cloud.skipper.domain.InstallRequest installRequest)
Install the package
|
List<org.springframework.cloud.skipper.domain.Release> |
list(String releaseNameLike)
List the latest version of releases with status of deployed or failed.
|
Collection<org.springframework.cloud.skipper.domain.Deployer> |
listDeployers()
List Platform Deployers
|
Collection<org.springframework.cloud.skipper.domain.Repository> |
listRepositories()
List Package Repositories.
|
String |
manifest(String releaseName)
Return the manifest of the last known release.
|
String |
manifest(String releaseName,
int releaseVersion)
Return a manifest info of a release version.
|
void |
packageDelete(String packageName)
Delete a package
|
org.springframework.cloud.skipper.domain.Release |
rollback(org.springframework.cloud.skipper.domain.RollbackRequest rollbackRequest)
Rollback a specific release.
|
org.springframework.cloud.skipper.domain.Release |
rollback(String releaseName,
int releaseVersion)
Rollback a specific release.
|
org.springframework.cloud.skipper.domain.Release |
scale(String releaseName,
org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest)
Scale a release with a given scale request.
|
Collection<org.springframework.cloud.skipper.domain.PackageMetadata> |
search(String name,
boolean details)
Search for package metadata.
|
Map<String,Map<String,org.springframework.cloud.deployer.spi.app.DeploymentState>> |
states(String... releaseNames)
Return the deployment state of a last known releases mapped back to release names.
|
org.springframework.cloud.skipper.domain.Info |
status(String releaseName)
Return a status info of a last known release.
|
org.springframework.cloud.skipper.domain.Info |
status(String releaseName,
int releaseVersion)
Return a status info of a release version.
|
Map<String,org.springframework.cloud.skipper.domain.Info> |
statuses(String... releaseNames)
Return a status info of a last known releases mapped back to release names.
|
org.springframework.cloud.skipper.domain.Release |
upgrade(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest)
Upgrade a release.
|
org.springframework.cloud.skipper.domain.PackageMetadata |
upload(org.springframework.cloud.skipper.domain.UploadRequest uploadRequest)
Upload the package.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create
protected final RestTemplate restTemplate
public DefaultSkipperClient(String baseUri)
baseUri
- the URL of the Server.public DefaultSkipperClient(String baseUri, RestTemplate restTemplate)
baseUri
- the URI of the Server.restTemplate
- the template to use to make http calls to the server.public org.springframework.cloud.skipper.domain.Template getSpringCloudDeployerApplicationTemplate()
SkipperClient
getSpringCloudDeployerApplicationTemplate
in interface SkipperClient
public org.springframework.cloud.skipper.domain.AboutResource info()
info
in interface SkipperClient
public org.springframework.cloud.skipper.domain.Info status(String releaseName)
SkipperClient
status
in interface SkipperClient
releaseName
- the release namepublic Map<String,org.springframework.cloud.skipper.domain.Info> statuses(String... releaseNames)
SkipperClient
statuses
in interface SkipperClient
releaseNames
- the release namespublic Map<String,Map<String,org.springframework.cloud.deployer.spi.app.DeploymentState>> states(String... releaseNames)
SkipperClient
states
in interface SkipperClient
releaseNames
- the release namespublic org.springframework.cloud.skipper.domain.Info status(String releaseName, int releaseVersion)
SkipperClient
status
in interface SkipperClient
releaseName
- the release namereleaseVersion
- the release versionpublic org.springframework.cloud.skipper.domain.LogInfo getLog(String releaseName)
SkipperClient
getLog
in interface SkipperClient
releaseName
- the release namepublic org.springframework.cloud.skipper.domain.LogInfo getLog(String releaseName, String appName)
SkipperClient
getLog
in interface SkipperClient
releaseName
- the release nameappName
- the application namepublic org.springframework.cloud.skipper.domain.Release scale(String releaseName, org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest)
SkipperClient
scale
in interface SkipperClient
releaseName
- the release namescaleRequest
- the scale requestpublic String manifest(String releaseName)
SkipperClient
manifest
in interface SkipperClient
releaseName
- the release namepublic String manifest(String releaseName, int releaseVersion)
SkipperClient
manifest
in interface SkipperClient
releaseName
- the release namereleaseVersion
- the release versionpublic Collection<org.springframework.cloud.skipper.domain.PackageMetadata> search(String name, boolean details)
SkipperClient
search
in interface SkipperClient
name
- optional name with wildcard support for searchingdetails
- boolean flag to fetch all the metadatapublic org.springframework.cloud.skipper.domain.Release install(org.springframework.cloud.skipper.domain.InstallRequest installRequest)
SkipperClient
install
in interface SkipperClient
installRequest
- the package install requestRelease
public org.springframework.cloud.skipper.domain.Release upgrade(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest)
SkipperClient
upgrade
in interface SkipperClient
upgradeRequest
- the request to upgrade the releaseRelease
public void delete(String releaseName, boolean deletePackage)
SkipperClient
delete
in interface SkipperClient
releaseName
- the release namedeletePackage
- delete package when deleting the releasepublic org.springframework.cloud.skipper.domain.CancelResponse cancel(org.springframework.cloud.skipper.domain.CancelRequest cancelRequest)
SkipperClient
cancel
in interface SkipperClient
cancelRequest
- the cancel requestpublic org.springframework.cloud.skipper.domain.Release rollback(org.springframework.cloud.skipper.domain.RollbackRequest rollbackRequest)
SkipperClient
rollback
in interface SkipperClient
rollbackRequest
- the rollback requestRelease
public org.springframework.cloud.skipper.domain.Release rollback(String releaseName, int releaseVersion)
SkipperClient
rollback
in interface SkipperClient
releaseName
- the release namereleaseVersion
- the release versionRelease
SkipperClient.rollback(RollbackRequest)
public List<org.springframework.cloud.skipper.domain.Release> list(String releaseNameLike)
SkipperClient
list
in interface SkipperClient
releaseNameLike
- the wildcard name of releases to search forpublic Collection<org.springframework.cloud.skipper.domain.Release> history(String releaseName)
SkipperClient
history
in interface SkipperClient
releaseName
- the release name of the release to search forpublic Collection<org.springframework.cloud.skipper.domain.Repository> listRepositories()
SkipperClient
listRepositories
in interface SkipperClient
public Collection<org.springframework.cloud.skipper.domain.Deployer> listDeployers()
SkipperClient
listDeployers
in interface SkipperClient
public org.springframework.cloud.skipper.domain.PackageMetadata upload(org.springframework.cloud.skipper.domain.UploadRequest uploadRequest)
SkipperClient
upload
in interface SkipperClient
uploadRequest
- the properties for the package uploadpublic void packageDelete(String packageName)
SkipperClient
packageDelete
in interface SkipperClient
packageName
- the name of the packageCopyright © 2022 Pivotal Software, Inc.. All rights reserved.