App (AWS Java SDK :: Services :: AWS OpsWorks 2.20.52 API)

java.lang.Object
- software.amazon.awssdk.services.opsworks.model.App

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<App.Builder,App>

@Generated(value="software.amazon.awssdk:codegen")
public final class App
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<App.Builder,App>

A description of the app.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface App.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`App.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`appId()` The app ID.
`Source`	`appSource()` A `Source` object that describes the app repository.
`Map<AppAttributesKeys,String>`	`attributes()` The stack attributes.
`Map<String,String>`	`attributesAsStrings()` The stack attributes.
`static App.Builder`	`builder()`
`String`	`createdAt()` When the app was created.
`List<DataSource>`	`dataSources()` The app's data sources.
`String`	`description()` A description of the app.
`List<String>`	`domains()` The app vhost settings with multiple domains separated by commas.
`Boolean`	`enableSsl()` Whether to enable SSL for the app.
`List<EnvironmentVariable>`	`environment()` An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` For responses, this returns true if the service returned a value for the Attributes property.
`boolean`	`hasDataSources()` For responses, this returns true if the service returned a value for the DataSources property.
`boolean`	`hasDomains()` For responses, this returns true if the service returned a value for the Domains property.
`boolean`	`hasEnvironment()` For responses, this returns true if the service returned a value for the Environment property.
`int`	`hashCode()`
`String`	`name()` The app name.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends App.Builder>`	`serializableBuilderClass()`
`String`	`shortname()` The app's short name.
`SslConfiguration`	`sslConfiguration()` An `SslConfiguration` object with the SSL configuration.
`String`	`stackId()` The app stack ID.
`App.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`AppType`	`type()` The app type.
`String`	`typeAsString()` The app type.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    AppType
  - 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:
    
    AppType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<App.Builder,App>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class App

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

appId

stackId

shortname

name

description

hasDataSources

dataSources

type

typeAsString

appSource

hasDomains

domains

enableSsl

sslConfiguration

attributes

hasAttributes

attributesAsStrings

createdAt

hasEnvironment

environment

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields