Class DevEnvironmentSummary

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

Information about a Dev Environment.

See Also:

  • Method Details

    • spaceName

      public final String spaceName()

      The name of the space.

      Returns:
      The name of the space.

    • projectName

      public final String projectName()

      The name of the project in the space.

      Returns:
      The name of the project in the space.

    • id

      public final String id()

      The system-generated unique ID for the Dev Environment.

      Returns:
      The system-generated unique ID for the Dev Environment.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

      Returns:
      The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • creatorId

      public final String creatorId()

      The system-generated unique ID of the user who created the Dev Environment.

      Returns:
      The system-generated unique ID of the user who created the Dev Environment.

    • status

      public final DevEnvironmentStatus status()

      The status of the Dev Environment.

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

      Returns:
      The status of the Dev Environment.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the Dev Environment.

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

      Returns:
      The status of the Dev Environment.
      See Also:

    • statusReason

      public final String statusReason()

      The reason for the status.

      Returns:
      The reason for the status.

    • hasRepositories

      public final boolean hasRepositories()
      For responses, this returns true if the service returned a value for the Repositories 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.

    • repositories

      public final List<DevEnvironmentRepositorySummary> repositories()

      Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.

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

      Returns:
      Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.

    • alias

      public final String alias()

      The user-specified alias for the Dev Environment.

      Returns:
      The user-specified alias for the Dev Environment.

    • hasIdes

      public final boolean hasIdes()
      For responses, this returns true if the service returned a value for the Ides 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.

    • ides

      public final List<Ide> ides()

      Information about the integrated development environment (IDE) configured for a Dev Environment.

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

      Returns:
      Information about the integrated development environment (IDE) configured for a Dev Environment.

    • instanceType

      public final InstanceType instanceType()

      The Amazon EC2 instace type used for the Dev Environment.

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

      Returns:
      The Amazon EC2 instace type used for the Dev Environment.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The Amazon EC2 instace type used for the Dev Environment.

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

      Returns:
      The Amazon EC2 instace type used for the Dev Environment.
      See Also:

    • inactivityTimeoutMinutes

      public final Integer inactivityTimeoutMinutes()

      The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.

      Returns:
      The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.

    • persistentStorage

      public final PersistentStorage persistentStorage()

      Information about the configuration of persistent storage for the Dev Environment.

      Returns:
      Information about the configuration of persistent storage for the Dev Environment.

    • vpcConnectionName

      public final String vpcConnectionName()

      The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

      Returns:
      The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

    • toBuilder

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

    • builder

      public static DevEnvironmentSummary.Builder builder()

    • serializableBuilderClass

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