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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<ComponentVariant.Builder,ComponentVariant>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.