spring-boot/org.springframework.boot.cloud/CloudPlatform

CloudPlatform

enum CloudPlatform

Simple detection for well known cloud platforms. Detection can be forced using the "spring.main.cloud-platform" configuration property.

Author

Phillip Webb

Brian Clozel

Nguyen Sach

Since

1.3.0

Entries

No Cloud platform. Useful when false-positives are detected.

Cloud Foundry platform.

Heroku platform.

SAP Cloud platform.

Nomad platform.

Kubernetes platform.

AZURE_APP_SERVICE

AZURE_APP_SERVICE

Azure App Service platform.

Functions

open fun getActive(environment: Environment): CloudPlatform

Returns the active CloudPlatform or null if one is not active.

open fun isActive(environment: Environment): Boolean

Determines if the platform is active (i.e.

abstract fun isDetected(environment: Environment): Boolean

Determines if the platform is detected by looking for platform-specific environment variables.

open fun isEnforced(binder: Binder): Boolean

open fun isEnforced(environment: Environment): Boolean

Determines if the platform is enforced by looking at the "spring.main.cloud-platform" configuration property.

isUsingForwardHeaders

open fun isUsingForwardHeaders(): Boolean

Returns if the platform is behind a load balancer and uses X-Forwarded-For headers.

open fun valueOf(name: String): CloudPlatform

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

open fun values(): Array<CloudPlatform>

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.