Package software.amazon.awssdk.services.appconfig.model

Class Environment

java.lang.Object

software.amazon.awssdk.services.appconfig.model.Environment

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Environment.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The application ID.
static Environment.Builder	builder()
String	description()	The description of the environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMonitors()	For responses, this returns true if the service returned a value for the Monitors property.
String	id()	The environment ID.
List<Monitor>	monitors()	Amazon CloudWatch alarms monitored during the deployment.
String	name()	The name of the environment.
List<SdkField<?>>	sdkFields()
static Class<? extends Environment.Builder>	serializableBuilderClass()
EnvironmentState	state()	The state of the environment.
String	stateAsString()	The state of the environment.
Environment.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

applicationId

public final String applicationId()

The application ID.

Returns:

The application ID.

id

public final String id()

The environment ID.

Returns:

The environment ID.

name

public final String name()

The name of the environment.

Returns:

The name of the environment.

description

public final String description()

The description of the environment.

Returns:

The description of the environment.

state

public final EnvironmentState state()

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

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

Returns:

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

See Also:

EnvironmentState

stateAsString

public final String stateAsString()

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

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

Returns:

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

See Also:

EnvironmentState

hasMonitors

public final boolean hasMonitors()

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

monitors

public final List<Monitor> monitors()

Amazon CloudWatch alarms monitored during the deployment.

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

Returns:

Amazon CloudWatch alarms monitored during the deployment.

toBuilder

public Environment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Environment.Builder,Environment>

builder

public static Environment.Builder builder()

serializableBuilderClass

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