Class FreeFormLayoutElement

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

An element within a free-form layout.

See Also:

  • Method Details

    • elementId

      public final String elementId()

      A unique identifier for an element within a free-form layout.

      Returns:
      A unique identifier for an element within a free-form layout.

    • elementType

      public final LayoutElementType elementType()

      The type of element.

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

      Returns:
      The type of element.
      See Also:

    • elementTypeAsString

      public final String elementTypeAsString()

      The type of element.

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

      Returns:
      The type of element.
      See Also:

    • xAxisLocation

      public final String xAxisLocation()

      The x-axis coordinate of the element.

      Returns:
      The x-axis coordinate of the element.

    • yAxisLocation

      public final String yAxisLocation()

      The y-axis coordinate of the element.

      Returns:
      The y-axis coordinate of the element.

    • width

      public final String width()

      The width of an element within a free-form layout.

      Returns:
      The width of an element within a free-form layout.

    • height

      public final String height()

      The height of an element within a free-form layout.

      Returns:
      The height of an element within a free-form layout.

    • visibility

      public final Visibility visibility()

      The visibility of an element within a free-form layout.

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

      Returns:
      The visibility of an element within a free-form layout.
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      The visibility of an element within a free-form layout.

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

      Returns:
      The visibility of an element within a free-form layout.
      See Also:

    • hasRenderingRules

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

    • renderingRules

      public final List<SheetElementRenderingRule> renderingRules()

      The rendering rules that determine when an element should be displayed within a free-form layout.

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

      Returns:
      The rendering rules that determine when an element should be displayed within a free-form layout.

    • borderStyle

      public final FreeFormLayoutElementBorderStyle borderStyle()

      The border style configuration of a free-form layout element.

      Returns:
      The border style configuration of a free-form layout element.

    • selectedBorderStyle

      public final FreeFormLayoutElementBorderStyle selectedBorderStyle()

      The border style configuration of a free-form layout element. This border style is used when the element is selected.

      Returns:
      The border style configuration of a free-form layout element. This border style is used when the element is selected.

    • backgroundStyle

      public final FreeFormLayoutElementBackgroundStyle backgroundStyle()

      The background style configuration of a free-form layout element.

      Returns:
      The background style configuration of a free-form layout element.

    • loadingAnimation

      public final LoadingAnimation loadingAnimation()

      The loading animation configuration of a free-form layout element.

      Returns:
      The loading animation configuration of a free-form layout element.

    • toBuilder

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

    • builder

      public static FreeFormLayoutElement.Builder builder()

    • serializableBuilderClass

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