Class PlatformBranchSummary

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

Summary information about a platform branch.

See Also:

  • Method Details

    • platformName

      public final String platformName()

      The name of the platform to which this platform branch belongs.

      Returns:
      The name of the platform to which this platform branch belongs.

    • branchName

      public final String branchName()

      The name of the platform branch.

      Returns:
      The name of the platform branch.

    • lifecycleState

      public final String lifecycleState()

      The support life cycle state of the platform branch.

      Possible values: beta | supported | deprecated | retired

      Returns:
      The support life cycle state of the platform branch.

      Possible values: beta | supported | deprecated | retired

    • branchOrder

      public final Integer branchOrder()

      An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.

      A larger BranchOrder value designates a newer platform branch within the platform.

      Returns:
      An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.

      A larger BranchOrder value designates a newer platform branch within the platform.

    • 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 environment tiers that platform versions in this branch support.

      Possible values: WebServer/Standard | Worker/SQS/HTTP

      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 environment tiers that platform versions in this branch support.

      Possible values: WebServer/Standard | Worker/SQS/HTTP

    • toBuilder

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

    • builder

      public static PlatformBranchSummary.Builder builder()

    • serializableBuilderClass

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