Class DisplayConfig

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

Defines how the widget's data should be visualized, including chart type, color schemes, axis configurations, and other display preferences.

See Also:

  • Method Details

    • hasGraph

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

    • graph

      public final Map<String,GraphDisplayConfig> graph()

      The configuration for graphical display of the widget data, including chart type and visual options.

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

      Returns:
      The configuration for graphical display of the widget data, including chart type and visual options.

    • table

      public final TableDisplayConfigStruct table()

      The configuration for tabular display of the widget data.

      Returns:
      The configuration for tabular display of the widget data.

    • toBuilder

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

    • builder

      public static DisplayConfig.Builder builder()

    • serializableBuilderClass

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

    • fromGraph

      public static DisplayConfig fromGraph(Map<String,GraphDisplayConfig> graph)
      Create an instance of this class with graph() initialized to the given value.

      The configuration for graphical display of the widget data, including chart type and visual options.

      Parameters:
      graph - The configuration for graphical display of the widget data, including chart type and visual options.

    • fromTable

      public static DisplayConfig fromTable(TableDisplayConfigStruct table)
      Create an instance of this class with table() initialized to the given value.

      The configuration for tabular display of the widget data.

      Parameters:
      table - The configuration for tabular display of the widget data.

    • fromTable

      public static DisplayConfig fromTable(Consumer<TableDisplayConfigStruct.Builder> table)
      Create an instance of this class with table() initialized to the given value.

      The configuration for tabular display of the widget data.

      Parameters:
      table - The configuration for tabular display of the widget data.

    • type

      public DisplayConfig.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be DisplayConfig.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be DisplayConfig.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.