Class App
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<App.Builder,
App>
A description of the app.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
appId()
The app ID.final Source
ASource
object that describes the app repository.final Map
<AppAttributesKeys, String> The stack attributes.The stack attributes.static App.Builder
builder()
final String
When the app was created.final List
<DataSource> The app's data sources.final String
A description of the app.domains()
The app vhost settings with multiple domains separated by commas.final Boolean
Whether to enable SSL for the app.final List
<EnvironmentVariable> An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attributes property.final boolean
For responses, this returns true if the service returned a value for the DataSources property.final boolean
For responses, this returns true if the service returned a value for the Domains property.final boolean
For responses, this returns true if the service returned a value for the Environment property.final int
hashCode()
final String
name()
The app name.static Class
<? extends App.Builder> final String
The app's short name.final SslConfiguration
AnSslConfiguration
object with the SSL configuration.final String
stackId()
The app stack ID.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final AppType
type()
The app type.final String
The app type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appId
The app ID.
- Returns:
- The app ID.
-
stackId
The app stack ID.
- Returns:
- The app stack ID.
-
shortname
The app's short name.
- Returns:
- The app's short name.
-
name
The app name.
- Returns:
- The app name.
-
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 theisEmpty()
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
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
The app type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The app type.
- See Also:
-
typeAsString
The app type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The app type.
- See Also:
-
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 theisEmpty()
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
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
Whether to enable SSL for the app.
- Returns:
- Whether to enable SSL for the app.
-
sslConfiguration
An
SslConfiguration
object with the SSL configuration.- Returns:
- An
SslConfiguration
object with the SSL configuration.
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<App.Builder,
App> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-