public interface SkipperClient
Modifier and Type | Method and Description |
---|---|
org.springframework.cloud.skipper.domain.Repository |
addRepository(String name,
String rootUrl,
String sourceUrl)
Add a new Package Repository.
|
org.springframework.cloud.skipper.domain.CancelResponse |
cancel(org.springframework.cloud.skipper.domain.CancelRequest cancelRequest)
Sends a cancel request for current release operation
|
static SkipperClient |
create(String baseUrl) |
void |
delete(String releaseName,
boolean deletePackage)
Delete a specific release.
|
void |
deleteRepository(String name)
Delete a Package Repository.
|
org.springframework.cloud.skipper.domain.Template |
getSpringCloudDeployerApplicationTemplate()
Return the template for deploying a Spring Boot Application using skipper.
|
org.springframework.hateoas.Resources<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.
|
org.springframework.hateoas.Resources<org.springframework.cloud.skipper.domain.Deployer> |
listDeployers()
List Platform Deployers
|
org.springframework.hateoas.Resources<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)
Deprecated.
use rollback method taking a rollback request
|
org.springframework.hateoas.Resources<org.springframework.cloud.skipper.domain.PackageMetadata> |
search(String name,
boolean details)
Search for package metadata.
|
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.
|
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.
|
static SkipperClient create(String baseUrl)
org.springframework.cloud.skipper.domain.Template getSpringCloudDeployerApplicationTemplate()
org.springframework.cloud.skipper.domain.AboutResource info()
org.springframework.hateoas.Resources<org.springframework.cloud.skipper.domain.PackageMetadata> search(String name, boolean details)
name
- optional name with wildcard support for searchingdetails
- boolean flag to fetch all the metadataorg.springframework.cloud.skipper.domain.Release install(org.springframework.cloud.skipper.domain.InstallRequest installRequest)
installRequest
- the package install requestRelease
org.springframework.cloud.skipper.domain.Release upgrade(org.springframework.cloud.skipper.domain.UpgradeRequest upgradeRequest)
upgradeRequest
- the request to upgrade the releaseRelease
org.springframework.cloud.skipper.domain.PackageMetadata upload(org.springframework.cloud.skipper.domain.UploadRequest uploadRequest)
uploadRequest
- the properties for the package uploadvoid packageDelete(String packageName)
packageName
- the name of the packagevoid delete(String releaseName, boolean deletePackage)
releaseName
- the release namedeletePackage
- delete package when deleting the releaseorg.springframework.cloud.skipper.domain.Release rollback(org.springframework.cloud.skipper.domain.RollbackRequest rollbackRequest)
rollbackRequest
- the rollback requestRelease
@Deprecated org.springframework.cloud.skipper.domain.Release rollback(String releaseName, int releaseVersion)
releaseName
- the release namereleaseVersion
- the release versionRelease
rollback(RollbackRequest)
org.springframework.cloud.skipper.domain.CancelResponse cancel(org.springframework.cloud.skipper.domain.CancelRequest cancelRequest)
cancelRequest
- the cancel requestList<org.springframework.cloud.skipper.domain.Release> list(String releaseNameLike)
releaseNameLike
- the wildcard name of releases to search fororg.springframework.hateoas.Resources<org.springframework.cloud.skipper.domain.Release> history(String releaseName)
releaseName
- the release name of the release to search fororg.springframework.cloud.skipper.domain.Repository addRepository(String name, String rootUrl, String sourceUrl)
name
- the name of the repositoryrootUrl
- the root URL for the packagesourceUrl
- the source URL for the packagesvoid deleteRepository(String name)
name
- the name of the repositoryorg.springframework.hateoas.Resources<org.springframework.cloud.skipper.domain.Repository> listRepositories()
org.springframework.hateoas.Resources<org.springframework.cloud.skipper.domain.Deployer> listDeployers()
org.springframework.cloud.skipper.domain.Info status(String releaseName)
releaseName
- the release nameorg.springframework.cloud.skipper.domain.Info status(String releaseName, int releaseVersion)
releaseName
- the release namereleaseVersion
- the release versionString manifest(String releaseName)
releaseName
- the release nameString manifest(String releaseName, int releaseVersion)
releaseName
- the release namereleaseVersion
- the release versionCopyright © 2019 Pivotal Software, Inc.. All rights reserved.