Class LayoutItem

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

The layout object that contains LayoutDefinitionName, Description, DisplayName, IsDefault, LayoutType, Tags, CreatedAt, LastUpdatedAt

See Also:

  • Method Details

    • layoutDefinitionName

      public final String layoutDefinitionName()

      The unique name of the layout.

      Returns:
      The unique name of the layout.

    • description

      public final String description()

      The description of the layout

      Returns:
      The description of the layout

    • displayName

      public final String displayName()

      The display name of the layout

      Returns:
      The display name of the layout

    • isDefault

      public final Boolean isDefault()

      If set to true for a layout, this layout will be used by default to view data. If set to false, then layout will not be used by default but it can be used to view data by explicit selection on UI.

      Returns:
      If set to true for a layout, this layout will be used by default to view data. If set to false, then layout will not be used by default but it can be used to view data by explicit selection on UI.

    • layoutType

      public final LayoutType layoutType()

      The type of layout that can be used to view data under customer profiles domain.

      If the service returns an enum value that is not available in the current SDK version, layoutType will return LayoutType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from layoutTypeAsString().

      Returns:
      The type of layout that can be used to view data under customer profiles domain.
      See Also:

    • layoutTypeAsString

      public final String layoutTypeAsString()

      The type of layout that can be used to view data under customer profiles domain.

      If the service returns an enum value that is not available in the current SDK version, layoutType will return LayoutType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from layoutTypeAsString().

      Returns:
      The type of layout that can be used to view data under customer profiles domain.
      See Also:

    • 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()

      The tags used to organize, track, or control access for this resource.

      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:
      The tags used to organize, track, or control access for this resource.

    • createdAt

      public final Instant createdAt()

      The timestamp of when the layout was created.

      Returns:
      The timestamp of when the layout was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp of when the layout was most recently updated.

      Returns:
      The timestamp of when the layout was most recently updated.

    • toBuilder

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

    • builder

      public static LayoutItem.Builder builder()

    • serializableBuilderClass

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