Interface App.Builder

All Superinterfaces:
Buildable, CopyableBuilder<App.Builder,App>, SdkBuilder<App.Builder,App>, SdkPojo
Enclosing class:
App

public static interface App.Builder extends SdkPojo, CopyableBuilder<App.Builder,App>
  • Method Details

    • appId

      App.Builder appId(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.
    • stackId

      App.Builder stackId(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.
    • shortname

      App.Builder shortname(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.
    • name

      App.Builder name(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.
    • description

      App.Builder description(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.
    • dataSources

      App.Builder dataSources(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.
    • dataSources

      App.Builder dataSources(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.
    • dataSources

      App.Builder dataSources(Consumer<DataSource.Builder>... dataSources)

      The app's data sources.

      This is a convenience method that creates an instance of the DataSource.Builder avoiding the need to create one manually via DataSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSources(List<DataSource>).

      Parameters:
      dataSources - a consumer that will call methods on DataSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      App.Builder type(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:
    • type

      App.Builder type(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:
    • appSource

      App.Builder appSource(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.
    • appSource

      default App.Builder appSource(Consumer<Source.Builder> appSource)

      A Source object that describes the app repository.

      This is a convenience method that creates an instance of the Source.Builder avoiding the need to create one manually via Source.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to appSource(Source).

      Parameters:
      appSource - a consumer that will call methods on Source.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • domains

      App.Builder domains(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.
    • domains

      App.Builder domains(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.
    • enableSsl

      App.Builder enableSsl(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.
    • sslConfiguration

      App.Builder sslConfiguration(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.
    • sslConfiguration

      default App.Builder sslConfiguration(Consumer<SslConfiguration.Builder> sslConfiguration)

      An SslConfiguration object with the SSL configuration.

      This is a convenience method that creates an instance of the SslConfiguration.Builder avoiding the need to create one manually via SslConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sslConfiguration(SslConfiguration).

      Parameters:
      sslConfiguration - a consumer that will call methods on SslConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • attributesWithStrings

      App.Builder attributesWithStrings(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.
    • attributes

      App.Builder attributes(Map<AppAttributesKeys,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.
    • createdAt

      App.Builder createdAt(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.
    • environment

      App.Builder environment(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 variable names, values, and protected flag values - cannot exceed 20 KB. 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 20 KB)" 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 variable names, values, and protected flag values - cannot exceed 20 KB. 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 20 KB)" message.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • environment

      App.Builder environment(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 variable names, values, and protected flag values - cannot exceed 20 KB. 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 20 KB)" 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 variable names, values, and protected flag values - cannot exceed 20 KB. 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 20 KB)" message.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • environment

      App.Builder environment(Consumer<EnvironmentVariable.Builder>... 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 variable names, values, and protected flag values - cannot exceed 20 KB. 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 20 KB)" message.

      This is a convenience method that creates an instance of the EnvironmentVariable.Builder avoiding the need to create one manually via EnvironmentVariable.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to environment(List<EnvironmentVariable>).

      Parameters:
      environment - a consumer that will call methods on EnvironmentVariable.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: