Package software.amazon.awssdk.services.support.model

Class TrustedAdvisorCheckDescription

java.lang.Object

software.amazon.awssdk.services.support.model.TrustedAdvisorCheckDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TrustedAdvisorCheckDescription.Builder,TrustedAdvisorCheckDescription>

@Generated("software.amazon.awssdk:codegen")
public final class TrustedAdvisorCheckDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TrustedAdvisorCheckDescription.Builder,TrustedAdvisorCheckDescription>

The description and metadata for a Trusted Advisor check.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TrustedAdvisorCheckDescription.Builder

Method Summary

Modifier and Type	Method	Description
static TrustedAdvisorCheckDescription.Builder	builder()
String	category()	The category of the Trusted Advisor check.
String	description()	The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadata()	For responses, this returns true if the service returned a value for the Metadata property.
String	id()	The unique identifier for the Trusted Advisor check.
List<String>	metadata()	The column headings for the data returned by the Trusted Advisor check.
String	name()	The display name for the Trusted Advisor check.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TrustedAdvisorCheckDescription.Builder>	serializableBuilderClass()
TrustedAdvisorCheckDescription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The unique identifier for the Trusted Advisor check.

Returns:

The unique identifier for the Trusted Advisor check.

name

public final String name()

The display name for the Trusted Advisor check.

Returns:

The display name for the Trusted Advisor check.

description

public final String 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

public final String 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 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.

metadata

public final List<String> 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

public TrustedAdvisorCheckDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TrustedAdvisorCheckDescription.Builder,TrustedAdvisorCheckDescription>

builder

public static TrustedAdvisorCheckDescription.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo