Package software.amazon.awssdk.services.amplifyuibuilder.model

Class ComponentVariant

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.ComponentVariant

All Implemented Interfaces:

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

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

Describes the style configuration of a unique variation of a main component.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComponentVariant.Builder

Method Summary

Modifier and Type	Method	Description
static ComponentVariant.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOverrides()	For responses, this returns true if the service returned a value for the Overrides property.
boolean	hasVariantValues()	For responses, this returns true if the service returned a value for the VariantValues property.
Map<String,Map<String,String>>	overrides()	The properties of the component variant that can be overriden when customizing an instance of the component.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentVariant.Builder>	serializableBuilderClass()
ComponentVariant.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,String>	variantValues()	The combination of variants that comprise this variant.

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

hasVariantValues

public final boolean hasVariantValues()

For responses, this returns true if the service returned a value for the VariantValues 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.

variantValues

public final Map<String,String> variantValues()

The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

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 hasVariantValues() method.

Returns:

The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.

hasOverrides

public final boolean hasOverrides()

For responses, this returns true if the service returned a value for the Overrides 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.

overrides

public final Map<String,Map<String,String>> overrides()

The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

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 hasOverrides() method.

Returns:

The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.

toBuilder

public ComponentVariant.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentVariant.Builder,ComponentVariant>

builder

public static ComponentVariant.Builder builder()

serializableBuilderClass

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