Class TrustedAdvisorCheckDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TrustedAdvisorCheckDescription.Builder,
TrustedAdvisorCheckDescription>
The description and metadata for a Trusted Advisor check.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
category()
The category of the Trusted Advisor check.final String
The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).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 Metadata property.final String
id()
The unique identifier for the Trusted Advisor check.metadata()
The column headings for the data returned by the Trusted Advisor check.final String
name()
The display name for the Trusted Advisor check.static Class
<? extends TrustedAdvisorCheckDescription.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 unique identifier for the Trusted Advisor check.
- Returns:
- The unique identifier for the Trusted Advisor check.
-
name
The display name for the Trusted Advisor check.
- Returns:
- The display name for the Trusted Advisor check.
-
description
The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
- Returns:
- The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
-
category
The category of the Trusted Advisor check.
- Returns:
- The category of the Trusted Advisor check.
-
hasMetadata
public final boolean hasMetadata()For responses, this returns true if the service returned a value for the Metadata 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. -
metadata
The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
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
hasMetadata()
method.- Returns:
- The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
-
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<TrustedAdvisorCheckDescription.Builder,
TrustedAdvisorCheckDescription> - 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
-