@Generated(value="software.amazon.awssdk:codegen") public final class App extends Object implements SdkPojo, Serializable, ToCopyableBuilder<App.Builder,App>
A description of the app.
Modifier and Type | Class and Description |
---|---|
static interface |
App.Builder |
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAttributes()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasDataSources()
Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasDomains()
Returns true if the Domains property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasEnvironment()
Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
AppType |
type()
The app type.
|
String |
typeAsString()
The app type.
|
copy
public final String appId()
The app ID.
public final String stackId()
The app stack ID.
public final String shortname()
The app's short name.
public final String name()
The app name.
public final String description()
A description of the app.
public final boolean hasDataSources()
public final List<DataSource> dataSources()
The app's data sources.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDataSources()
to see if a value was sent in this field.
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()
.
AppType
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()
.
AppType
public final Source appSource()
A Source
object that describes the app repository.
Source
object that describes the app repository.public final boolean hasDomains()
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.
You can use hasDomains()
to see if a value was sent in this field.
'www.example.com, example.com'
public final Boolean enableSsl()
Whether to enable SSL for the app.
public final SslConfiguration sslConfiguration()
An SslConfiguration
object with the SSL configuration.
SslConfiguration
object with the SSL configuration.public final Map<AppAttributesKeys,String> attributes()
The stack attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final boolean hasAttributes()
public final Map<String,String> attributesAsStrings()
The stack attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
public final String createdAt()
When the app was created.
public final boolean hasEnvironment()
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.
You can use hasEnvironment()
to see if a value was sent in this field.
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.
public App.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<App.Builder,App>
public static App.Builder builder()
public static Class<? extends App.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.