Class Insight
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Insight.Builder,
Insight>
A check that provides recommendations to remedy potential upgrade-impacting issues.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionLinks to sources that provide additional context on the insight.static Insight.Builder
builder()
final Category
category()
The category of the insight.final String
The category of the insight.Summary information that relates to the category of the insight.final String
The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).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 boolean
For responses, this returns true if the service returned a value for the AdditionalInfo property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Resources property.final String
id()
The ID of the insight.final InsightStatus
An object containing more detail on the status of the insight resource.final String
The Kubernetes minor version associated with an insight if applicable.final Instant
The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.final Instant
The time the status of the insight last changed.final String
name()
The name of the insight.final String
A summary of how to remediate the finding of this insight if applicable.final List
<InsightResourceDetail> The details about each resource listed in the insight check result.static Class
<? extends Insight.Builder> 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
-
id
The ID of the insight.
- Returns:
- The ID of the insight.
-
name
The name of the insight.
- Returns:
- The name of the insight.
-
category
The category of the insight.
If the service returns an enum value that is not available in the current SDK version,
category
will returnCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- The category of the insight.
- See Also:
-
categoryAsString
The category of the insight.
If the service returns an enum value that is not available in the current SDK version,
category
will returnCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- The category of the insight.
- See Also:
-
kubernetesVersion
The Kubernetes minor version associated with an insight if applicable.
- Returns:
- The Kubernetes minor version associated with an insight if applicable.
-
lastRefreshTime
The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.
- Returns:
- The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.
-
lastTransitionTime
The time the status of the insight last changed.
- Returns:
- The time the status of the insight last changed.
-
description
The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).
- Returns:
- The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).
-
insightStatus
An object containing more detail on the status of the insight resource.
- Returns:
- An object containing more detail on the status of the insight resource.
-
recommendation
A summary of how to remediate the finding of this insight if applicable.
- Returns:
- A summary of how to remediate the finding of this insight if applicable.
-
hasAdditionalInfo
public final boolean hasAdditionalInfo()For responses, this returns true if the service returned a value for the AdditionalInfo 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. -
additionalInfo
Links to sources that provide additional context on the insight.
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
hasAdditionalInfo()
method.- Returns:
- Links to sources that provide additional context on the insight.
-
hasResources
public final boolean hasResources()For responses, this returns true if the service returned a value for the Resources 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. -
resources
The details about each resource listed in the insight check result.
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
hasResources()
method.- Returns:
- The details about each resource listed in the insight check result.
-
categorySpecificSummary
Summary information that relates to the category of the insight. Currently only returned with certain insights having category
UPGRADE_READINESS
.- Returns:
- Summary information that relates to the category of the insight. Currently only returned with certain
insights having category
UPGRADE_READINESS
.
-
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<Insight.Builder,
Insight> - 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
-