Class App

    • Constructor Detail

      • App

        public App()
    • 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) or withDataSources(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
      • getType

        public String getType()

        The app type.

        Returns:
        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 - A Source 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 - A Source 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) or withDomains(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 - An SslConfiguration 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 - An SslConfiguration 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.
      • addAttributesEntry

        public App addAttributesEntry​(String key,
                                      String value)
      • 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 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.
      • 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) or withEnvironment(java.util.Collection) if you want to override the existing values.

        Parameters:
        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.
        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 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:
        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 class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object