Package software.amazon.awssdk.services.elasticbeanstalk.model

Class ConfigurationSettingsDescription

java.lang.Object

software.amazon.awssdk.services.elasticbeanstalk.model.ConfigurationSettingsDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConfigurationSettingsDescription.Builder,ConfigurationSettingsDescription>

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

Describes the settings for a configuration set.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigurationSettingsDescription.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationName()	The name of the application associated with this configuration set.
static ConfigurationSettingsDescription.Builder	builder()
Instant	dateCreated()	The date (in UTC time) when this configuration set was created.
Instant	dateUpdated()	The date (in UTC time) when this configuration set was last modified.
ConfigurationDeploymentStatus	deploymentStatus()	If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
String	deploymentStatusAsString()	If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:
String	description()	Describes this configuration set.
String	environmentName()	If not null, the name of the environment for this configuration set.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptionSettings()	For responses, this returns true if the service returned a value for the OptionSettings property.
List<ConfigurationOptionSetting>	optionSettings()	A list of the configuration options and their values in this configuration set.
String	platformArn()	The ARN of the platform version.
List<SdkField<?>>	sdkFields()
static Class<? extends ConfigurationSettingsDescription.Builder>	serializableBuilderClass()
String	solutionStackName()	The name of the solution stack this configuration set uses.
String	templateName()	If not null, the name of the configuration template for this configuration set.
ConfigurationSettingsDescription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

solutionStackName

public final String solutionStackName()

The name of the solution stack this configuration set uses.

Returns:

The name of the solution stack this configuration set uses.

platformArn

public final String platformArn()

The ARN of the platform version.

Returns:

The ARN of the platform version.

applicationName

public final String applicationName()

The name of the application associated with this configuration set.

Returns:

The name of the application associated with this configuration set.

templateName

public final String templateName()

If not null, the name of the configuration template for this configuration set.

Returns:

If not null, the name of the configuration template for this configuration set.

description

public final String description()

Describes this configuration set.

Returns:

Describes this configuration set.

environmentName

public final String environmentName()

If not null, the name of the environment for this configuration set.

Returns:

If not null, the name of the environment for this configuration set.

deploymentStatus

public final ConfigurationDeploymentStatus deploymentStatus()

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

• null: This configuration is not associated with a running environment.

• pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

• deployed: This is the configuration that is currently deployed to the associated running environment.

• failed: This is a draft configuration that failed to successfully deploy.

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

Returns:

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

• null: This configuration is not associated with a running environment.

• pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

• deployed: This is the configuration that is currently deployed to the associated running environment.

• failed: This is a draft configuration that failed to successfully deploy.

See Also:

ConfigurationDeploymentStatus

deploymentStatusAsString

public final String deploymentStatusAsString()

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

• null: This configuration is not associated with a running environment.

• pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

• deployed: This is the configuration that is currently deployed to the associated running environment.

• failed: This is a draft configuration that failed to successfully deploy.

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

Returns:

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

• null: This configuration is not associated with a running environment.

• pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

• deployed: This is the configuration that is currently deployed to the associated running environment.

• failed: This is a draft configuration that failed to successfully deploy.

See Also:

ConfigurationDeploymentStatus

dateCreated

public final Instant dateCreated()

The date (in UTC time) when this configuration set was created.

Returns:

The date (in UTC time) when this configuration set was created.

dateUpdated

public final Instant dateUpdated()

The date (in UTC time) when this configuration set was last modified.

Returns:

The date (in UTC time) when this configuration set was last modified.

hasOptionSettings

public final boolean hasOptionSettings()

For responses, this returns true if the service returned a value for the OptionSettings 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.

optionSettings

public final List<ConfigurationOptionSetting> optionSettings()

A list of the configuration options and their values in this configuration set.

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 hasOptionSettings() method.

Returns:

A list of the configuration options and their values in this configuration set.

toBuilder

public ConfigurationSettingsDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigurationSettingsDescription.Builder,ConfigurationSettingsDescription>

builder

public static ConfigurationSettingsDescription.Builder builder()

serializableBuilderClass

public static Class<? extends ConfigurationSettingsDescription.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