Class App
- All Implemented Interfaces:
Serializable
,Cloneable
A description of the app.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttributesEntry
(String key, String value) Removes all the entries added into Attributes.clone()
boolean
getAppId()
The app ID.ASource
object that describes the app repository.The stack attributes.When the app was created.The app's data sources.A description of the app.The app vhost settings with multiple domains separated by commas.Whether to enable SSL for the app.An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.getName()
The app name.The app's short name.AnSslConfiguration
object with the SSL configuration.The app stack ID.getType()
The app type.int
hashCode()
Whether to enable SSL for the app.void
The app ID.void
setAppSource
(Source appSource) ASource
object that describes the app repository.void
setAttributes
(Map<String, String> attributes) The stack attributes.void
setCreatedAt
(String createdAt) When the app was created.void
setDataSources
(Collection<DataSource> dataSources) The app's data sources.void
setDescription
(String description) A description of the app.void
setDomains
(Collection<String> domains) The app vhost settings with multiple domains separated by commas.void
setEnableSsl
(Boolean enableSsl) Whether to enable SSL for the app.void
setEnvironment
(Collection<EnvironmentVariable> environment) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.void
The app name.void
setShortname
(String shortname) The app's short name.void
setSslConfiguration
(SslConfiguration sslConfiguration) AnSslConfiguration
object with the SSL configuration.void
setStackId
(String stackId) The app stack ID.void
The app type.void
The app type.toString()
Returns a string representation of this object; useful for testing and debugging.The app ID.withAppSource
(Source appSource) ASource
object that describes the app repository.withAttributes
(Map<String, String> attributes) The stack attributes.withCreatedAt
(String createdAt) When the app was created.withDataSources
(DataSource... dataSources) The app's data sources.withDataSources
(Collection<DataSource> dataSources) The app's data sources.withDescription
(String description) A description of the app.withDomains
(String... domains) The app vhost settings with multiple domains separated by commas.withDomains
(Collection<String> domains) The app vhost settings with multiple domains separated by commas.withEnableSsl
(Boolean enableSsl) Whether to enable SSL for the app.withEnvironment
(EnvironmentVariable... environment) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.withEnvironment
(Collection<EnvironmentVariable> environment) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.The app name.withShortname
(String shortname) The app's short name.withSslConfiguration
(SslConfiguration sslConfiguration) AnSslConfiguration
object with the SSL configuration.withStackId
(String stackId) The app stack ID.The app type.The app type.
-
Constructor Details
-
App
public App()
-
-
Method Details
-
setAppId
The app ID.
- Parameters:
appId
- The app ID.
-
getAppId
The app ID.
- Returns:
- The app ID.
-
withAppId
The app ID.
- Parameters:
appId
- The app ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackId
The app stack ID.
- Parameters:
stackId
- The app stack ID.
-
getStackId
The app stack ID.
- Returns:
- The app stack ID.
-
withStackId
The app stack ID.
- Parameters:
stackId
- The app stack ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setShortname
The app's short name.
- Parameters:
shortname
- The app's short name.
-
getShortname
The app's short name.
- Returns:
- The app's short name.
-
withShortname
The app's short name.
- Parameters:
shortname
- The app's short name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
The app name.
- Parameters:
name
- The app name.
-
getName
The app name.
- Returns:
- The app name.
-
withName
The app name.
- Parameters:
name
- The app name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
A description of the app.
- Parameters:
description
- A description of the app.
-
getDescription
A description of the app.
- Returns:
- A description of the app.
-
withDescription
A description of the app.
- Parameters:
description
- A description of the app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDataSources
The app's data sources.
- Returns:
- The app's data sources.
-
setDataSources
The app's data sources.
- Parameters:
dataSources
- The app's data sources.
-
withDataSources
The app's data sources.
NOTE: This method appends the values to the existing list (if any). Use
setDataSources(java.util.Collection)
orwithDataSources(java.util.Collection)
if you want to override the existing values.- Parameters:
dataSources
- The app's data sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDataSources
The app's data sources.
- Parameters:
dataSources
- The app's data sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setType
The app type.
- Parameters:
type
- The app type.- See Also:
-
getType
The app type.
- Returns:
- The app type.
- See Also:
-
withType
The app type.
- Parameters:
type
- The app type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setType
The app type.
- Parameters:
type
- The app type.- See Also:
-
withType
The app type.
- Parameters:
type
- The app type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAppSource
A
Source
object that describes the app repository.- Parameters:
appSource
- ASource
object that describes the app repository.
-
getAppSource
A
Source
object that describes the app repository.- Returns:
- A
Source
object that describes the app repository.
-
withAppSource
A
Source
object that describes the app repository.- Parameters:
appSource
- ASource
object that describes the app repository.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDomains
The app vhost settings with multiple domains separated by commas. For example:
'www.example.com, example.com'
- Returns:
- The app vhost settings with multiple domains separated by commas.
For example:
'www.example.com, example.com'
-
setDomains
The app vhost settings with multiple domains separated by commas. For example:
'www.example.com, example.com'
- Parameters:
domains
- The app vhost settings with multiple domains separated by commas. For example:'www.example.com, example.com'
-
withDomains
The app vhost settings with multiple domains separated by commas. For example:
'www.example.com, example.com'
NOTE: This method appends the values to the existing list (if any). Use
setDomains(java.util.Collection)
orwithDomains(java.util.Collection)
if you want to override the existing values.- Parameters:
domains
- The app vhost settings with multiple domains separated by commas. For example:'www.example.com, example.com'
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDomains
The app vhost settings with multiple domains separated by commas. For example:
'www.example.com, example.com'
- Parameters:
domains
- The app vhost settings with multiple domains separated by commas. For example:'www.example.com, example.com'
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnableSsl
Whether to enable SSL for the app.
- Parameters:
enableSsl
- Whether to enable SSL for the app.
-
getEnableSsl
Whether to enable SSL for the app.
- Returns:
- Whether to enable SSL for the app.
-
withEnableSsl
Whether to enable SSL for the app.
- Parameters:
enableSsl
- Whether to enable SSL for the app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEnableSsl
Whether to enable SSL for the app.
- Returns:
- Whether to enable SSL for the app.
-
setSslConfiguration
An
SslConfiguration
object with the SSL configuration.- Parameters:
sslConfiguration
- AnSslConfiguration
object with the SSL configuration.
-
getSslConfiguration
An
SslConfiguration
object with the SSL configuration.- Returns:
- An
SslConfiguration
object with the SSL configuration.
-
withSslConfiguration
An
SslConfiguration
object with the SSL configuration.- Parameters:
sslConfiguration
- AnSslConfiguration
object with the SSL configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAttributes
The stack attributes.
- Returns:
- The stack attributes.
-
setAttributes
The stack attributes.
- Parameters:
attributes
- The stack attributes.
-
withAttributes
The stack attributes.
- Parameters:
attributes
- The stack attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addAttributesEntry
-
clearAttributesEntries
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together. -
setCreatedAt
When the app was created.
- Parameters:
createdAt
- When the app was created.
-
getCreatedAt
When the app was created.
- Returns:
- When the app was created.
-
withCreatedAt
When the app was created.
- Parameters:
createdAt
- When the app was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getEnvironment
An array of
EnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message. - Returns:
- An array of
EnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message.
-
setEnvironment
An array of
EnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message. - Parameters:
environment
- An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message.
-
withEnvironment
An array of
EnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message. NOTE: This method appends the values to the existing list (if any). Use
setEnvironment(java.util.Collection)
orwithEnvironment(java.util.Collection)
if you want to override the existing values.- Parameters:
environment
- An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEnvironment
An array of
EnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message. - Parameters:
environment
- An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-