Class ScatterPlotCategoricallyAggregatedFieldWells

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

The aggregated field well of a scatter plot.

See Also:

  • Method Details

    • hasXAxis

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

    • xAxis

      public final List<MeasureField> xAxis()

      The x-axis field well of a scatter plot.

      The x-axis is aggregated by category.

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

      Returns:
      The x-axis field well of a scatter plot.

      The x-axis is aggregated by category.

    • hasYAxis

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

    • yAxis

      public final List<MeasureField> yAxis()

      The y-axis field well of a scatter plot.

      The y-axis is aggregated by category.

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

      Returns:
      The y-axis field well of a scatter plot.

      The y-axis is aggregated by category.

    • hasCategory

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

    • category

      public final List<DimensionField> category()

      The category field well of a scatter plot.

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

      Returns:
      The category field well of a scatter plot.

    • hasSize

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

    • size

      public final List<MeasureField> size()

      The size field well of a scatter plot.

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

      Returns:
      The size field well of a scatter plot.

    • hasLabel

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

    • label

      public final List<DimensionField> label()

      The label field well of a scatter plot.

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

      Returns:
      The label field well of a scatter plot.

    • toBuilder

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

    • builder

      public static ScatterPlotCategoricallyAggregatedFieldWells.Builder builder()

    • serializableBuilderClass

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