Class App
- java.lang.Object
-
- com.amazonaws.services.opsworks.model.App
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class App extends Object implements Serializable, Cloneable
A description of the app.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description App()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description App
addAttributesEntry(String key, String value)
App
clearAttributesEntries()
Removes all the entries added into Attributes.App
clone()
boolean
equals(Object obj)
String
getAppId()
The app ID.Source
getAppSource()
ASource
object that describes the app repository.Map<String,String>
getAttributes()
The stack attributes.String
getCreatedAt()
When the app was created.List<DataSource>
getDataSources()
The app's data sources.String
getDescription()
A description of the app.List<String>
getDomains()
The app vhost settings with multiple domains separated by commas.Boolean
getEnableSsl()
Whether to enable SSL for the app.List<EnvironmentVariable>
getEnvironment()
An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.String
getName()
The app name.String
getShortname()
The app's short name.SslConfiguration
getSslConfiguration()
AnSslConfiguration
object with the SSL configuration.String
getStackId()
The app stack ID.String
getType()
The app type.int
hashCode()
Boolean
isEnableSsl()
Whether to enable SSL for the app.void
setAppId(String appId)
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
setName(String name)
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
setType(AppType type)
The app type.void
setType(String type)
The app type.String
toString()
Returns a string representation of this object; useful for testing and debugging.App
withAppId(String appId)
The app ID.App
withAppSource(Source appSource)
ASource
object that describes the app repository.App
withAttributes(Map<String,String> attributes)
The stack attributes.App
withCreatedAt(String createdAt)
When the app was created.App
withDataSources(DataSource... dataSources)
The app's data sources.App
withDataSources(Collection<DataSource> dataSources)
The app's data sources.App
withDescription(String description)
A description of the app.App
withDomains(String... domains)
The app vhost settings with multiple domains separated by commas.App
withDomains(Collection<String> domains)
The app vhost settings with multiple domains separated by commas.App
withEnableSsl(Boolean enableSsl)
Whether to enable SSL for the app.App
withEnvironment(EnvironmentVariable... environment)
An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.App
withEnvironment(Collection<EnvironmentVariable> environment)
An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.App
withName(String name)
The app name.App
withShortname(String shortname)
The app's short name.App
withSslConfiguration(SslConfiguration sslConfiguration)
AnSslConfiguration
object with the SSL configuration.App
withStackId(String stackId)
The app stack ID.App
withType(AppType type)
The app type.App
withType(String type)
The app type.
-
-
-
Method Detail
-
setAppId
public void setAppId(String appId)
The app ID.
- Parameters:
appId
- The app ID.
-
getAppId
public String getAppId()
The app ID.
- Returns:
- The app ID.
-
withAppId
public App withAppId(String appId)
The app ID.
- Parameters:
appId
- The app ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackId
public void setStackId(String stackId)
The app stack ID.
- Parameters:
stackId
- The app stack ID.
-
getStackId
public String getStackId()
The app stack ID.
- Returns:
- The app stack ID.
-
withStackId
public App withStackId(String stackId)
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
public void setShortname(String shortname)
The app's short name.
- Parameters:
shortname
- The app's short name.
-
getShortname
public String getShortname()
The app's short name.
- Returns:
- The app's short name.
-
withShortname
public App withShortname(String shortname)
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
public void setName(String name)
The app name.
- Parameters:
name
- The app name.
-
getName
public String getName()
The app name.
- Returns:
- The app name.
-
withName
public App withName(String name)
The app name.
- Parameters:
name
- The app name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
A description of the app.
- Parameters:
description
- A description of the app.
-
getDescription
public String getDescription()
A description of the app.
- Returns:
- A description of the app.
-
withDescription
public App withDescription(String description)
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
public List<DataSource> getDataSources()
The app's data sources.
- Returns:
- The app's data sources.
-
setDataSources
public void setDataSources(Collection<DataSource> dataSources)
The app's data sources.
- Parameters:
dataSources
- The app's data sources.
-
withDataSources
public App withDataSources(DataSource... dataSources)
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
public App withDataSources(Collection<DataSource> dataSources)
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
public void setType(String type)
The app type.
- Parameters:
type
- The app type.- See Also:
AppType
-
withType
public App withType(String type)
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:
AppType
-
setType
public void setType(AppType type)
The app type.
- Parameters:
type
- The app type.- See Also:
AppType
-
withType
public App withType(AppType type)
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:
AppType
-
setAppSource
public void setAppSource(Source appSource)
A
Source
object that describes the app repository.- Parameters:
appSource
- ASource
object that describes the app repository.
-
getAppSource
public Source getAppSource()
A
Source
object that describes the app repository.- Returns:
- A
Source
object that describes the app repository.
-
withAppSource
public App withAppSource(Source appSource)
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
public List<String> 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
public void setDomains(Collection<String> domains)
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
public App withDomains(String... domains)
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
public App withDomains(Collection<String> domains)
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
public void setEnableSsl(Boolean enableSsl)
Whether to enable SSL for the app.
- Parameters:
enableSsl
- Whether to enable SSL for the app.
-
getEnableSsl
public Boolean getEnableSsl()
Whether to enable SSL for the app.
- Returns:
- Whether to enable SSL for the app.
-
withEnableSsl
public App withEnableSsl(Boolean enableSsl)
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
public Boolean isEnableSsl()
Whether to enable SSL for the app.
- Returns:
- Whether to enable SSL for the app.
-
setSslConfiguration
public void setSslConfiguration(SslConfiguration sslConfiguration)
An
SslConfiguration
object with the SSL configuration.- Parameters:
sslConfiguration
- AnSslConfiguration
object with the SSL configuration.
-
getSslConfiguration
public SslConfiguration getSslConfiguration()
An
SslConfiguration
object with the SSL configuration.- Returns:
- An
SslConfiguration
object with the SSL configuration.
-
withSslConfiguration
public App withSslConfiguration(SslConfiguration sslConfiguration)
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
public Map<String,String> getAttributes()
The stack attributes.
- Returns:
- The stack attributes.
-
setAttributes
public void setAttributes(Map<String,String> attributes)
The stack attributes.
- Parameters:
attributes
- The stack attributes.
-
withAttributes
public App withAttributes(Map<String,String> attributes)
The stack attributes.
- Parameters:
attributes
- The stack attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clearAttributesEntries
public App clearAttributesEntries()
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together.
-
setCreatedAt
public void setCreatedAt(String createdAt)
When the app was created.
- Parameters:
createdAt
- When the app was created.
-
getCreatedAt
public String getCreatedAt()
When the app was created.
- Returns:
- When the app was created.
-
withCreatedAt
public App withCreatedAt(String createdAt)
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
public List<EnvironmentVariable> 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
public void setEnvironment(Collection<EnvironmentVariable> environment)
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
public App withEnvironment(EnvironmentVariable... environment)
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
public App withEnvironment(Collection<EnvironmentVariable> environment)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-