ConfigurationSettingsDescription (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.elasticbeanstalk.model.ConfigurationSettingsDescription

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

@Generated(value="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 and Description

static interface ConfigurationSettingsDescription.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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()` Returns true if the OptionSettings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 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 String platformArn()
```
    The ARN of the platform version.
    
    Returns:
    
    The ARN of the platform version.
  - applicationName
```
public 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 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 String description()
```
    Describes this configuration set.
    
    Returns:
    
    Describes this configuration set.
  - environmentName
```
public 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 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 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 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 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 boolean hasOptionSettings()
```
    Returns true if the OptionSettings 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.
  - optionSettings
```
public 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.
    
    You can use hasOptionSettings() to see if a value was sent in this field.
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ConfigurationSettingsDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

solutionStackName

platformArn

applicationName

templateName

description

environmentName

deploymentStatus

deploymentStatusAsString

dateCreated

dateUpdated

hasOptionSettings

optionSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields