Class Widget

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

A configurable visualization component within a dashboard that displays specific cost and usage metrics. Each widget can show data as charts or tables and includes settings for data querying, filtering, and visual presentation.

See Also:

  • Method Details

    • title

      public final String title()

      The title of the widget.

      Returns:
      The title of the widget.

    • description

      public final String description()

      A description of the widget's purpose or the data it displays.

      Returns:
      A description of the widget's purpose or the data it displays.

    • width

      public final Integer width()

      The width of the widget in column spans. The dashboard layout consists of a grid system.

      Returns:
      The width of the widget in column spans. The dashboard layout consists of a grid system.

    • height

      public final Integer height()

      The height of the widget in row spans. The dashboard layout consists of a grid system.

      Returns:
      The height of the widget in row spans. The dashboard layout consists of a grid system.

    • horizontalOffset

      public final Integer horizontalOffset()

      Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.

      Returns:
      Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.

    • hasConfigs

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

    • configs

      public final List<WidgetConfig> configs()

      An array of configurations that define the data queries and display settings for the widget.

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

      Returns:
      An array of configurations that define the data queries and display settings for the widget.

    • toBuilder

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

    • builder

      public static Widget.Builder builder()

    • serializableBuilderClass

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