Class EnvironmentSummary

java.lang.Object
software.amazon.awssdk.services.evs.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>

A list of environments with summarized environment details.

See Also:

  • Method Details

    • environmentId

      public final String environmentId()

      A unique ID for the environment.

      Returns:
      A unique ID for the environment.

    • environmentName

      public final String environmentName()

      The name of the environment.

      Returns:
      The name of the environment.

    • vcfVersion

      public final VcfVersion vcfVersion()

      The VCF version of the environment.

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

      Returns:
      The VCF version of the environment.
      See Also:

    • vcfVersionAsString

      public final String vcfVersionAsString()

      The VCF version of the environment.

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

      Returns:
      The VCF version of the environment.
      See Also:

    • environmentStatus

      public final CheckResult environmentStatus()

      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

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

      Returns:
      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
      See Also:

    • environmentStatusAsString

      public final String environmentStatusAsString()

      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

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

      Returns:
      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
      See Also:

    • environmentState

      public final EnvironmentState environmentState()

      The state of an environment.

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

      Returns:
      The state of an environment.
      See Also:

    • environmentStateAsString

      public final String environmentStateAsString()

      The state of an environment.

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

      Returns:
      The state of an environment.
      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time that the environment was created.

      Returns:
      The date and time that the environment was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time that the environment was modified.

      Returns:
      The date and time that the environment was modified.

    • environmentArn

      public final String environmentArn()

      The Amazon Resource Name (ARN) that is associated with the environment.

      Returns:
      The Amazon Resource Name (ARN) that is associated with the environment.

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