Class EnvironmentSummary

java.lang.Object
software.amazon.awssdk.services.m2.model.EnvironmentSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EnvironmentSummary.Builder,EnvironmentSummary>
@Generated("software.amazon.awssdk:codegen") public final class EnvironmentSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EnvironmentSummary.Builder,EnvironmentSummary>

Contains a subset of the possible runtime environment attributes. Used in the environment list.

See Also:

  • Method Details

    • creationTime

      public final Instant creationTime()

      The timestamp when the runtime environment was created.

      Returns:
      The timestamp when the runtime environment was created.

    • engineType

      public final EngineType engineType()

      The target platform for the runtime environment.

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

      Returns:
      The target platform for the runtime environment.
      See Also:

    • engineTypeAsString

      public final String engineTypeAsString()

      The target platform for the runtime environment.

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

      Returns:
      The target platform for the runtime environment.
      See Also:

    • engineVersion

      public final String engineVersion()

      The version of the runtime engine.

      Returns:
      The version of the runtime engine.

    • environmentArn

      public final String environmentArn()

      The Amazon Resource Name (ARN) of a particular runtime environment.

      Returns:
      The Amazon Resource Name (ARN) of a particular runtime environment.

    • environmentId

      public final String environmentId()

      The unique identifier of a particular runtime environment.

      Returns:
      The unique identifier of a particular runtime environment.

    • instanceType

      public final String instanceType()

      The instance type of the runtime environment.

      Returns:
      The instance type of the runtime environment.

    • name

      public final String name()

      The name of the runtime environment.

      Returns:
      The name of the runtime environment.

    • networkType

      public final NetworkType networkType()

      The network type supported by the runtime environment.

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

      Returns:
      The network type supported by the runtime environment.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      The network type supported by the runtime environment.

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

      Returns:
      The network type supported by the runtime environment.
      See Also:

    • status

      public final EnvironmentLifecycle status()

      The status of the runtime environment

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

      Returns:
      The status of the runtime environment
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the runtime environment

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

      Returns:
      The status of the runtime environment
      See Also:

    • toBuilder

      public EnvironmentSummary.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<EnvironmentSummary.Builder,EnvironmentSummary>
      Returns:
      a builder for type T

    • builder

      public static EnvironmentSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EnvironmentSummary.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)
      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 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.