Class PlatformSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PlatformSummary.Builder,
PlatformSummary>
Summary information about a platform version.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PlatformSummary.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedAddonList property.final boolean
For responses, this returns true if the service returned a value for the SupportedTierList property.final String
The operating system used by the platform version.final String
The version of the operating system used by the platform version.final String
The ARN of the platform version.final String
The state of the platform version's branch in its lifecycle.final String
The platform branch to which the platform version belongs.final String
The category of platform version.final String
The state of the platform version in its lifecycle.final String
The AWS account ID of the person who created the platform version.final PlatformStatus
The status of the platform version.final String
The status of the platform version.final String
The version string of the platform version.static Class
<? extends PlatformSummary.Builder> The additions associated with the platform version.The tiers in which the platform version runs.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
platformArn
The ARN of the platform version.
- Returns:
- The ARN of the platform version.
-
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
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 returnPlatformStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformStatusAsString()
.- Returns:
- The status of the platform version. You can create an environment from the platform version once it is ready.
- See Also:
-
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 returnPlatformStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformStatusAsString()
.- Returns:
- The status of the platform version. You can create an environment from the platform version once it is ready.
- See Also:
-
platformCategory
The category of platform version.
- Returns:
- The category of platform version.
-
operatingSystemName
The operating system used by the platform version.
- Returns:
- The operating system used by the platform version.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The state of the platform version in its lifecycle.
Possible values:
recommended
| emptyIf 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
| emptyIf an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
-
platformVersion
The version string of the platform version.
- Returns:
- The version string of the platform version.
-
platformBranchName
The platform branch to which the platform version belongs.
- Returns:
- The platform branch to which the platform version belongs.
-
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
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 interfaceToCopyableBuilder<PlatformSummary.Builder,
PlatformSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-