org.cloudfoundry.client.v2.applications

Class CreateApplicationRequest

java.lang.Object

org.cloudfoundry.client.v2.applications.CreateApplicationRequest

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class CreateApplicationRequest
extends Object

The request payload for the v2 Create Application request

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateApplicationRequest.Builder Builds instances of type CreateApplicationRequest.

Method Summary

Modifier and Type	Method and Description
static CreateApplicationRequest.Builder	builder() Creates a builder for CreateApplicationRequest.
boolean	equals(Object another) This instance is equal to all instances of CreateApplicationRequest that have equal attribute values.
String	getBuildpack() Buildpack to build the application
String	getCommand() The command to start the application after it is staged
Boolean	getConsole() Deprecated.
String	getDebug() Deprecated.
String	getDetectedStartCommand() The command detected by the buildpack during staging
Boolean	getDiego() Use diego to stage and to run when available
Integer	getDiskQuota() The maximum amount of disk available to an instance of an application.
DockerCredentials	getDockerCredentials() Docker credentials for pulling docker image
String	getDockerImage() Name of the Docker image containing the application
Boolean	getEnableSsh() Enable SSHing into the application
Map<String,Object>	getEnvironmentJsons() Key/value pairs of all the environment variables to run in your application.
String	getHealthCheckHttpEndpoint() The HTTP endpoint to check for health
Integer	getHealthCheckTimeout() Timeout for health checking of an staged applcation when starting up
String	getHealthCheckType() Type of health check to perform
Integer	getInstances() The number of instances of the application to run.
Integer	getMemory() The amount of memory each instance should have.
String	getName() The name of the application
List<Integer>	getPorts() The ports on which the application may listen
Boolean	getProduction() Deprecated.
String	getSpaceId() The id of the associated space
String	getStackId() The id of the associated stack
String	getState() The current desired state of the application
int	hashCode() Computes a hash code from attributes: buildpack, command, console, debug, detectedStartCommand, diego, diskQuota, dockerCredentials, dockerImage, enableSsh, environmentJsons, healthCheckHttpEndpoint, healthCheckTimeout, healthCheckType, instances, memory, name, ports, production, spaceId, stackId, state.
String	toString() Prints the immutable value CreateApplicationRequest with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getBuildpack

public String getBuildpack()

Buildpack to build the application

getCommand

public String getCommand()

The command to start the application after it is staged

getConsole

@Deprecated
public Boolean getConsole()

Deprecated.

Open the console port for the application (at $CONSOLE_PORT)

getDebug

@Deprecated
public String getDebug()

Deprecated.

Open the debug port for the application (at $DEBUG_PORT)

getDetectedStartCommand

public String getDetectedStartCommand()

The command detected by the buildpack during staging

getDiego

public Boolean getDiego()

Use diego to stage and to run when available

getDiskQuota

public Integer getDiskQuota()

The maximum amount of disk available to an instance of an application. In megabytes.

getDockerCredentials

public DockerCredentials getDockerCredentials()

Docker credentials for pulling docker image

getDockerImage

public String getDockerImage()

Name of the Docker image containing the application

getEnableSsh

public Boolean getEnableSsh()

Enable SSHing into the application

getEnvironmentJsons

public Map<String,Object> getEnvironmentJsons()

Key/value pairs of all the environment variables to run in your application. Does not include any system or service variables.

getHealthCheckHttpEndpoint

public String getHealthCheckHttpEndpoint()

The HTTP endpoint to check for health

getHealthCheckTimeout

public Integer getHealthCheckTimeout()

Timeout for health checking of an staged applcation when starting up

getHealthCheckType

public String getHealthCheckType()

Type of health check to perform

getInstances

public Integer getInstances()

The number of instances of the application to run. To ensure optimal availability, ensure there are at least 2 instances.

getMemory

public Integer getMemory()

The amount of memory each instance should have. In megabytes.

getName

public String getName()

The name of the application

getPorts

public List<Integer> getPorts()

The ports on which the application may listen

getProduction

@Deprecated
public Boolean getProduction()

Deprecated.

Whether to open the production port

getSpaceId

public String getSpaceId()

The id of the associated space

getStackId

public String getStackId()

The id of the associated stack

getState

public String getState()

The current desired state of the application

equals

public boolean equals(Object another)

This instance is equal to all instances of CreateApplicationRequest that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: buildpack, command, console, debug, detectedStartCommand, diego, diskQuota, dockerCredentials, dockerImage, enableSsh, environmentJsons, healthCheckHttpEndpoint, healthCheckTimeout, healthCheckType, instances, memory, name, ports, production, spaceId, stackId, state.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CreateApplicationRequest with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static CreateApplicationRequest.Builder builder()

Creates a builder for CreateApplicationRequest.

 CreateApplicationRequest.builder()
    .buildpack(String | null) // nullable buildpack
    .command(String | null) // nullable command
    .console(Boolean | null) // nullable console
    .debug(String | null) // nullable debug
    .detectedStartCommand(String | null) // nullable detectedStartCommand
    .diego(Boolean | null) // nullable diego
    .diskQuota(Integer | null) // nullable diskQuota
    .dockerCredentials(org.cloudfoundry.client.v2.applications.DockerCredentials | null) // nullable dockerCredentials
    .dockerImage(String | null) // nullable dockerImage
    .enableSsh(Boolean | null) // nullable enableSsh
    .environmentJsons(Map<String, Object> | null) // nullable environmentJsons
    .healthCheckHttpEndpoint(String | null) // nullable healthCheckHttpEndpoint
    .healthCheckTimeout(Integer | null) // nullable healthCheckTimeout
    .healthCheckType(String | null) // nullable healthCheckType
    .instances(Integer | null) // nullable instances
    .memory(Integer | null) // nullable memory
    .name(String) // required name
    .ports(List<Integer> | null) // nullable ports
    .production(Boolean | null) // nullable production
    .spaceId(String) // required spaceId
    .stackId(String | null) // nullable stackId
    .state(String | null) // nullable state
    .build();
 

Returns:

A new CreateApplicationRequest builder