Class PlatformSummary

    • Method Detail

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

        public final PlatformStatus platformStatus()

        The status of the platform version. You can create an environment from the platform version once it is ready.

        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. You can create an environment from the platform version once it is ready.
        See Also:
        PlatformStatus
      • platformStatusAsString

        public final String platformStatusAsString()

        The status of the platform version. You can create an environment from the platform version once it is ready.

        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. You can create an environment from the platform version once it is ready.
        See Also:
        PlatformStatus
      • platformCategory

        public final String platformCategory()

        The category of platform version.

        Returns:
        The category of 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.
      • 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 in which the platform version runs.

        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 in which the platform version runs.
      • 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 associated with 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 associated with the platform version.
      • platformLifecycleState

        public final String platformLifecycleState()

        The state of the platform version in its lifecycle.

        Possible values: recommended | empty

        If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.

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

        Possible values: recommended | empty

        If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.

      • platformVersion

        public final String platformVersion()

        The version string of the platform version.

        Returns:
        The version string of the platform version.
      • 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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)