software.amazon.awssdk.services.opsworks.model

Class App

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

Method Summary

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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

appId

public String appId()

The app ID.

Returns:

The app ID.

stackId

public String stackId()

The app stack ID.

Returns:

The app stack ID.

shortname

public String shortname()

The app's short name.

Returns:

The app's short name.

name

public String name()

The app name.

Returns:

The app name.

description

public String description()

A description of the app.

Returns:

A description of the app.

hasDataSources

public 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). For responses returned by the SDK, the sender is the AWS service.

dataSources

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

Returns:

The app's data sources.

type

public 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 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 Source appSource()

A Source object that describes the app repository.

Returns:

A Source object that describes the app repository.

hasDomains

public 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). For responses returned by the SDK, the sender is the AWS service.

domains

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

Returns:

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

enableSsl

public Boolean enableSsl()

Whether to enable SSL for the app.

Returns:

Whether to enable SSL for the app.

sslConfiguration

public SslConfiguration sslConfiguration()

An SslConfiguration object with the SSL configuration.

Returns:

An SslConfiguration object with the SSL configuration.

attributes

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

Returns:

The stack attributes.

hasAttributes

public 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). For responses returned by the SDK, the sender is the AWS service.

attributesAsStrings

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

Returns:

The stack attributes.

createdAt

public String createdAt()

When the app was created.

Returns:

When the app was created.

hasEnvironment

public 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). For responses returned by the SDK, the sender is the AWS service.

environment

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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