Class PlatformDescription

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

Detailed information about a platform version.

See Also:

  • Method Details

    • platformArn

      public final String platformArn()

      The ARN of the platform version.

      Returns:
      The ARN of the platform version.

    • platformOwner

      public final String platformOwner()

      The AWS account ID of the person who created the platform version.

      Returns:
      The AWS account ID of the person who created the platform version.

    • platformName

      public final String platformName()

      The name of the platform version.

      Returns:
      The name of the platform version.

    • platformVersion

      public final String platformVersion()

      The version of the platform version.

      Returns:
      The version of the platform version.

    • solutionStackName

      public final String solutionStackName()

      The name of the solution stack used by the platform version.

      Returns:
      The name of the solution stack used by the platform version.

    • platformStatus

      public final PlatformStatus platformStatus()

      The status of the platform version.

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

      Returns:
      The status of the platform version.
      See Also:

    • platformStatusAsString

      public final String platformStatusAsString()

      The status of the platform version.

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

      Returns:
      The status of the platform version.
      See Also:

    • dateCreated

      public final Instant dateCreated()

      The date when the platform version was created.

      Returns:
      The date when the platform version was created.

    • dateUpdated

      public final Instant dateUpdated()

      The date when the platform version was last updated.

      Returns:
      The date when the platform version was last updated.

    • platformCategory

      public final String platformCategory()

      The category of the platform version.

      Returns:
      The category of the platform version.

    • description

      public final String description()

      The description of the platform version.

      Returns:
      The description of the platform version.

    • maintainer

      public final String maintainer()

      Information about the maintainer of the platform version.

      Returns:
      Information about the maintainer of the platform version.

    • operatingSystemName

      public final String operatingSystemName()

      The operating system used by the platform version.

      Returns:
      The operating system used by the platform version.

    • operatingSystemVersion

      public final String operatingSystemVersion()

      The version of the operating system used by the platform version.

      Returns:
      The version of the operating system used by the platform version.

    • hasProgrammingLanguages

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

    • programmingLanguages

      public final List<PlatformProgrammingLanguage> programmingLanguages()

      The programming languages supported by the platform version.

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

      Returns:
      The programming languages supported by the platform version.

    • hasFrameworks

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

    • frameworks

      public final List<PlatformFramework> frameworks()

      The frameworks supported by the platform version.

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

      Returns:
      The frameworks supported by the platform version.

    • hasCustomAmiList

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

    • customAmiList

      public final List<CustomAmi> customAmiList()

      The custom AMIs supported by the platform version.

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

      Returns:
      The custom AMIs supported by the platform version.

    • hasSupportedTierList

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

    • supportedTierList

      public final List<String> supportedTierList()

      The tiers supported by the platform version.

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

      Returns:
      The tiers supported by the platform version.

    • hasSupportedAddonList

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

    • supportedAddonList

      public final List<String> supportedAddonList()

      The additions supported by the platform version.

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

      Returns:
      The additions supported by the platform version.

    • platformLifecycleState

      public final String platformLifecycleState()

      The state of the platform version in its lifecycle.

      Possible values: Recommended | null

      If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.

      Returns:
      The state of the platform version in its lifecycle.

      Possible values: Recommended | null

      If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.

    • platformBranchName

      public final String platformBranchName()

      The platform branch to which the platform version belongs.

      Returns:
      The platform branch to which the platform version belongs.

    • platformBranchLifecycleState

      public final String platformBranchLifecycleState()

      The state of the platform version's branch in its lifecycle.

      Possible values: Beta | Supported | Deprecated | Retired

      Returns:
      The state of the platform version's branch in its lifecycle.

      Possible values: Beta | Supported | Deprecated | Retired

    • toBuilder

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

    • builder

      public static PlatformDescription.Builder builder()

    • serializableBuilderClass

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