Class Theme

java.lang.Object
software.amazon.awssdk.services.amplifyuibuilder.model.Theme
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Theme.Builder,Theme>
@Generated("software.amazon.awssdk:codegen") public final class Theme extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Theme.Builder,Theme>

A theme is a collection of style settings that apply globally to the components associated with an Amplify application.

See Also:

  • Method Details

    • appId

      public final String appId()

      The unique ID for the Amplify app associated with the theme.

      Returns:
      The unique ID for the Amplify app associated with the theme.

    • environmentName

      public final String environmentName()

      The name of the backend environment that is a part of the Amplify app.

      Returns:
      The name of the backend environment that is a part of the Amplify app.

    • id

      public final String id()

      The ID for the theme.

      Returns:
      The ID for the theme.

    • name

      public final String name()

      The name of the theme.

      Returns:
      The name of the theme.

    • createdAt

      public final Instant createdAt()

      The time that the theme was created.

      Returns:
      The time that the theme was created.

    • modifiedAt

      public final Instant modifiedAt()

      The time that the theme was modified.

      Returns:
      The time that the theme was modified.

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values 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.

    • values

      public final List<ThemeValues> values()

      A list of key-value pairs that defines the properties of the theme.

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

      Returns:
      A list of key-value pairs that defines the properties of the theme.

    • 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 List<ThemeValues> overrides()

      Describes the properties that can be overriden to customize a theme.

      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:
      Describes the properties that can be overriden to customize a theme.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      One or more key-value pairs to use when tagging the theme.

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

      Returns:
      One or more key-value pairs to use when tagging the theme.

    • toBuilder

      public Theme.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<Theme.Builder,Theme>
      Returns:
      a builder for type T

    • builder

      public static Theme.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.