Class App

java.lang.Object
software.amazon.awssdk.services.opsworks.model.App
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<App.Builder,App>
@Generated("software.amazon.awssdk:codegen") public final class App extends Object implements SdkPojo, Serializable, ToCopyableBuilder<App.Builder,App>

A description of the app.

See Also:

  • Method Details

    • appId

      public final String appId()

      The app ID.

      Returns:
      The app ID.

    • stackId

      public final String stackId()

      The app stack ID.

      Returns:
      The app stack ID.

    • shortname

      public final String shortname()

      The app's short name.

      Returns:
      The app's short name.

    • name

      public final String name()

      The app name.

      Returns:
      The app name.

    • description

      public final String description()

      A description of the app.

      Returns:
      A description of the app.

    • hasDataSources

      public final boolean hasDataSources()
      For responses, this returns true if the service returned a value for the DataSources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dataSources

      public final List<DataSource> dataSources()

      The app's data sources.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataSources() method.

      Returns:
      The app's data sources.

    • type

      public final AppType type()

      The app type.

      If the service returns an enum value that is not available in the current SDK version, type will return AppType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The app type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The app type.

      If the service returns an enum value that is not available in the current SDK version, type will return AppType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The app type.
      See Also:

    • appSource

      public final Source appSource()

      A Source object that describes the app repository.

      Returns:
      A Source object that describes the app repository.

    • hasDomains

      public final boolean hasDomains()
      For responses, this returns true if the service returned a value for the Domains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • domains

      public final List<String> domains()

      The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDomains() method.

      Returns:
      The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

    • enableSsl

      public final Boolean enableSsl()

      Whether to enable SSL for the app.

      Returns:
      Whether to enable SSL for the app.

    • sslConfiguration

      public final SslConfiguration sslConfiguration()

      An SslConfiguration object with the SSL configuration.

      Returns:
      An SslConfiguration object with the SSL configuration.

    • attributes

      public final Map<AppAttributesKeys,String> attributes()

      The stack attributes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      The stack attributes.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributesAsStrings

      public final Map<String,String> attributesAsStrings()

      The stack attributes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      The stack attributes.

    • createdAt

      public final String createdAt()

      When the app was created.

      Returns:
      When the app was created.

    • hasEnvironment

      public final boolean hasEnvironment()
      For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • environment

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironment() method.

      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 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.

    • toBuilder

      public App.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<App.Builder,App>
      Returns:
      a builder for type T

    • builder

      public static App.Builder builder()

    • serializableBuilderClass

      public static Class<? extends App.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.