A B C D E G I L M O P R S T U V W

A

addPlatformSpecificInfo(String, String) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

AppDefinition - Class in org.springframework.cloud.deployer.spi.core

Definition of an app, including its name and its properties.

AppDefinition(String, Map<String, String>) - Constructor for class org.springframework.cloud.deployer.spi.core.AppDefinition

Construct an AppDefinition.

AppDeployer - Interface in org.springframework.cloud.deployer.spi.app

SPI defining a runtime environment capable of deploying and managing the lifecycle of apps that are intended to run indefinitely (until undeployed), as opposed to tasks.

AppDeploymentRequest - Class in org.springframework.cloud.deployer.spi.core

Representation of an app deployment request.

AppDeploymentRequest(AppDefinition, Resource, Map<String, String>) - Constructor for class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

Construct an AppDeploymentRequest.

AppDeploymentRequest(AppDefinition, Resource, Map<String, String>, List<String>) - Constructor for class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

Construct an AppDeploymentRequest.

AppDeploymentRequest(AppDefinition, Resource) - Constructor for class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

Construct an AppDeploymentRequest with no deployment properties.

AppInstanceStatus - Interface in org.springframework.cloud.deployer.spi.app

Status for an individual app instance deployment.

AppScaleRequest - Class in org.springframework.cloud.deployer.spi.app

Representation of an app scale request.

AppScaleRequest(String, int) - Constructor for class org.springframework.cloud.deployer.spi.app.AppScaleRequest

AppScaleRequest(String, int, Map<String, String>) - Constructor for class org.springframework.cloud.deployer.spi.app.AppScaleRequest

AppStatus - Class in org.springframework.cloud.deployer.spi.app

Status of an app which is initially constructed from an AppDeploymentRequest and runtime deployment properties by a deployer during deployment.

AppStatus(String, DeploymentState) - Constructor for class org.springframework.cloud.deployer.spi.app.AppStatus

Construct a new AppStatus.

AppStatus.Builder - Class in org.springframework.cloud.deployer.spi.app

Utility class constructing an instance of AppStatus using a builder pattern.

B

build() - Method in class org.springframework.cloud.deployer.spi.app.AppStatus.Builder

Return a new instance of AppStatus based on the provided individual app instances via AppStatus.Builder.with(AppInstanceStatus).

build() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

Builder() - Constructor for class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

ByteSizeUtils - Class in org.springframework.cloud.deployer.spi.util

Utility class for dealing with parseable byte sizes, such as memory and disk limits.

C

cancel(String) - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Cancel the task corresponding to the provided id.

cleanup(String) - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Attempt to clean up any app execution resources that are associated with a task launch represented by the provided task execution id.

CommandLineTokenizer - Class in org.springframework.cloud.deployer.spi.util

A general purpose tokenizer for "command line" arrays.

CommandLineTokenizer(String) - Constructor for class org.springframework.cloud.deployer.spi.util.CommandLineTokenizer

COUNT_PROPERTY_KEY - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

The deployment property for the count (number of app instances).

CPU_PROPERTY_KEY - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

The deployment property for the cpu setting for the container that will run the app.

CreateScheduleException - Exception in org.springframework.cloud.deployer.spi.scheduler

Thrown when a schedule fails to be created on the scheduler infrastructure.

CreateScheduleException(String, Throwable) - Constructor for exception org.springframework.cloud.deployer.spi.scheduler.CreateScheduleException

CRON_EXPRESSION - Static variable in class org.springframework.cloud.deployer.spi.scheduler.SchedulerPropertyKeys

Scheduler cron expression property key.

CRON_PREFIX - Static variable in class org.springframework.cloud.deployer.spi.scheduler.SchedulerPropertyKeys

Scheduler cron property key prefix.

D

deploy(AppDeploymentRequest) - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Deploy an app using an AppDeploymentRequest.

DeploymentState - Enum in org.springframework.cloud.deployer.spi.app

Deployment states for apps and groups.

destroy(String) - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Attempt to clean up any app resources that are associated with a task app represented by the provided appName.

DISK_PROPERTY_KEY - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

The deployment property for the disk setting for the container that will run the app.

E

environmentInfo() - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Return the environment info for this deployer.

environmentInfo() - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Return the environment info for this launcher/deployer.

equals(Object) - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

G

generalState(DeploymentState) - Method in class org.springframework.cloud.deployer.spi.app.AppStatus.Builder

Set the state of the app as a direct value.

getArgs() - Method in class org.springframework.cloud.deployer.spi.util.CommandLineTokenizer

getAttributes() - Method in interface org.springframework.cloud.deployer.spi.app.AppInstanceStatus

Return a map of attributes for the deployed app instance.

getAttributes() - Method in class org.springframework.cloud.deployer.spi.task.TaskStatus

Return a map of attributes for the launched task.

getCommandlineArguments() - Method in class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

getCount() - Method in class org.springframework.cloud.deployer.spi.app.AppScaleRequest

getDefinition() - Method in class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

getDeploymentId() - Method in class org.springframework.cloud.deployer.spi.app.AppScaleRequest

getDeploymentId() - Method in class org.springframework.cloud.deployer.spi.app.AppStatus

Return the app deployment id.

getDeploymentProperties() - Method in class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

getId() - Method in interface org.springframework.cloud.deployer.spi.app.AppInstanceStatus

Return a unique identifier for the deployed app.

getImplementationName() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getImplementationVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getInstances() - Method in class org.springframework.cloud.deployer.spi.app.AppStatus

Return a map of AppInstanceStatus keyed by a unique identifier for each app instance.

getJavaVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getLog(String) - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Return the log of the application identified by the deployment id.

getLog(String) - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Return the log of the application identified by the task ID.

getMaximumConcurrentTasks() - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Implementations may limit the number of concurrent task executions.

getName() - Method in class org.springframework.cloud.deployer.spi.core.AppDefinition

Return the name of this app.

getPlatformApiVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getPlatformClientVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getPlatformHostVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getPlatformSpecificInfo() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getPlatformType() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getProperties() - Method in class org.springframework.cloud.deployer.spi.app.AppScaleRequest

getProperties() - Method in class org.springframework.cloud.deployer.spi.core.AppDefinition

Gets the app definition properties.

getResource() - Method in class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

getRunningTaskExecutionCount() - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

getScheduleName() - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

getScheduleName() - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleRequest

getScheduleProperties() - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

getSchedulerProperties() - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleRequest

getSpiVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getSpringBootVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getSpringBootVersion() - Static method in class org.springframework.cloud.deployer.spi.util.RuntimeVersionUtils

getSpringVersion() - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo

getState() - Method in interface org.springframework.cloud.deployer.spi.app.AppInstanceStatus

Return the state of the deployed app instance.

getState() - Method in class org.springframework.cloud.deployer.spi.app.AppStatus

Return the deployment state for the the app.

getState() - Method in class org.springframework.cloud.deployer.spi.task.TaskStatus

Return the state for the the task.

getTaskDefinitionName() - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

getTaskLaunchId() - Method in class org.springframework.cloud.deployer.spi.task.TaskStatus

Return the task launch id for the task.

getVersion(Class<?>) - Static method in class org.springframework.cloud.deployer.spi.util.RuntimeVersionUtils

GROUP_PROPERTY_KEY - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

The deployment property for the group to which an app belongs.

I

implementationName(String) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

implementationVersion(String) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

INDEXED_PROPERTY_KEY - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

The deployment property that indicates if each app instance should have an index value within a sequence from 0 to N-1, where N is the value of the "spring.cloud.deployer.count" property.

INSTANCE_INDEX_PROPERTY_KEY - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

The property to be set at each instance level to specify the sequence number amongst 0 to N-1, where N is the value of the "spring.cloud.deployer.count" property.

L

launch(AppDeploymentRequest) - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Launch a task for the provided AppDeploymentRequest.

LaunchState - Enum in org.springframework.cloud.deployer.spi.task

Launch states for a Task.

list(String) - Method in interface org.springframework.cloud.deployer.spi.scheduler.Scheduler

List all of the Schedules associated with the provided AppDefinition.

list() - Method in interface org.springframework.cloud.deployer.spi.scheduler.Scheduler

List all of the ScheduleInfos registered with the system.

M

MEMORY_PROPERTY_KEY - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

The deployment property for the memory setting for the container that will run the app.

MultiStateAppDeployer - Interface in org.springframework.cloud.deployer.spi.app

Extension of the AppDeployer interface that adds an additional method to return the DeploymentState for a collection of deployment ids.

O

of(String) - Static method in class org.springframework.cloud.deployer.spi.app.AppStatus

Return a Builder for AppStatus.

org.springframework.cloud.deployer.spi.app - package org.springframework.cloud.deployer.spi.app

org.springframework.cloud.deployer.spi.core - package org.springframework.cloud.deployer.spi.core

org.springframework.cloud.deployer.spi.scheduler - package org.springframework.cloud.deployer.spi.scheduler

org.springframework.cloud.deployer.spi.task - package org.springframework.cloud.deployer.spi.task

org.springframework.cloud.deployer.spi.util - package org.springframework.cloud.deployer.spi.util

P

parseToMebibytes(String) - Static method in class org.springframework.cloud.deployer.spi.util.ByteSizeUtils

Return the number of mebibytes (1024*1024) denoted by the given text, where an optional case-insensitive unit of 'm' or 'g' can be used to mean mebi- or gebi- bytes, respectively.

platformApiVersion(String) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

platformClientVersion(String) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

platformHostVersion(String) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

platformType(String) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

PREFIX - Static variable in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Common prefix used for deployment properties.

PREFIX - Static variable in class org.springframework.cloud.deployer.spi.scheduler.SchedulerPropertyKeys

R

RuntimeEnvironmentInfo - Class in org.springframework.cloud.deployer.spi.core

Class used to communicate the runtime environment info.

RuntimeEnvironmentInfo.Builder - Class in org.springframework.cloud.deployer.spi.core

RuntimeVersionUtils - Class in org.springframework.cloud.deployer.spi.util

Utility class to be used for generating version info for various libraries.

RuntimeVersionUtils() - Constructor for class org.springframework.cloud.deployer.spi.util.RuntimeVersionUtils

S

scale(AppScaleRequest) - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Scale an app according to given values.

schedule(ScheduleRequest) - Method in interface org.springframework.cloud.deployer.spi.scheduler.Scheduler

Registers the ScheduleRequest to be executed based on the cron expression provided.

ScheduleInfo - Class in org.springframework.cloud.deployer.spi.scheduler

A Schedule represents the association between the task definition and the times it is to be executed.

ScheduleInfo() - Constructor for class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

Scheduler - Interface in org.springframework.cloud.deployer.spi.scheduler

A Scheduler is a component that provides a way to register the execution of a ScheduleRequest with an underlying scheduler system (Quartz, etc).

ScheduleRequest - Class in org.springframework.cloud.deployer.spi.scheduler

Representation of a schedule request.

ScheduleRequest(AppDefinition, Map<String, String>, Map<String, String>, String, Resource) - Constructor for class org.springframework.cloud.deployer.spi.scheduler.ScheduleRequest

Construct an AppDeploymentRequest.

ScheduleRequest(AppDefinition, Map<String, String>, Map<String, String>, List<String>, String, Resource) - Constructor for class org.springframework.cloud.deployer.spi.scheduler.ScheduleRequest

Construct an AppDeploymentRequest.

SchedulerException - Exception in org.springframework.cloud.deployer.spi.scheduler

Base Exception class for Spring Cloud Scheduler.

SchedulerException(String) - Constructor for exception org.springframework.cloud.deployer.spi.scheduler.SchedulerException

SchedulerException(String, Throwable) - Constructor for exception org.springframework.cloud.deployer.spi.scheduler.SchedulerException

SchedulerPropertyKeys - Class in org.springframework.cloud.deployer.spi.scheduler

Spring Cloud Scheduler property keys.

SchedulerPropertyKeys() - Constructor for class org.springframework.cloud.deployer.spi.scheduler.SchedulerPropertyKeys

setScheduleName(String) - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

setScheduleProperties(Map<String, String>) - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

setSchedulerProperties(Map<String, String>) - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleRequest

setTaskDefinitionName(String) - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

spiClass(Class) - Method in class org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo.Builder

states(String...) - Method in interface org.springframework.cloud.deployer.spi.app.MultiStateAppDeployer

Return the DeploymentState for all the apps represented by a collection of deployment ids.

statesReactive(String...) - Method in interface org.springframework.cloud.deployer.spi.app.MultiStateAppDeployer

Return the DeploymentState for all the apps represented by a collection of deployment ids.

status(String) - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Return the AppStatus for an app represented by a deployment id.

status(String) - Method in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Returns the TaskStatus for a task represented by the provided id.

statusesReactive(String...) - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Return the AppStatuss for an app represented by a deployment ids.

statusReactive(String) - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Return the AppStatus for an app represented by a deployment id.

T

TaskLauncher - Interface in org.springframework.cloud.deployer.spi.task

SPI defining a runtime environment capable of launching and managing the lifecycle of tasks.

TaskStatus - Class in org.springframework.cloud.deployer.spi.task

Status of a task launch which is initially constructed from an AppDeploymentRequest and runtime properties by a TaskLauncher.

TaskStatus(String, LaunchState, Map<String, String>) - Constructor for class org.springframework.cloud.deployer.spi.task.TaskStatus

Construct a new TaskStatus.

toString() - Method in class org.springframework.cloud.deployer.spi.app.AppScaleRequest

toString() - Method in class org.springframework.cloud.deployer.spi.app.AppStatus

toString() - Method in class org.springframework.cloud.deployer.spi.core.AppDefinition

toString() - Method in class org.springframework.cloud.deployer.spi.core.AppDeploymentRequest

toString() - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleInfo

toString() - Method in class org.springframework.cloud.deployer.spi.scheduler.ScheduleRequest

toString() - Method in class org.springframework.cloud.deployer.spi.task.TaskStatus

Return a string representation of this status.

U

undeploy(String) - Method in interface org.springframework.cloud.deployer.spi.app.AppDeployer

Un-deploy an app using its deployment id.

unschedule(String) - Method in interface org.springframework.cloud.deployer.spi.scheduler.Scheduler

Deletes a schedule that has been created.

UnScheduleException - Exception in org.springframework.cloud.deployer.spi.scheduler

Thrown when a schedule fails to be unscheduled on the scheduler infrastructure.

UnScheduleException(String) - Constructor for exception org.springframework.cloud.deployer.spi.scheduler.UnScheduleException

UnScheduleException(String, Throwable) - Constructor for exception org.springframework.cloud.deployer.spi.scheduler.UnScheduleException

V

valueOf(String) - Static method in enum org.springframework.cloud.deployer.spi.app.DeploymentState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.cloud.deployer.spi.task.LaunchState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.springframework.cloud.deployer.spi.app.DeploymentState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.cloud.deployer.spi.task.LaunchState

Returns an array containing the constants of this enum type, in the order they are declared.

W

with(AppInstanceStatus) - Method in class org.springframework.cloud.deployer.spi.app.AppStatus.Builder

Add an instance of AppInstanceStatus to build the status for the app.

A B C D E G I L M O P R S T U V W