Class PluginVisualFieldWell
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.PluginVisualFieldWell
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PluginVisualFieldWell.Builder,PluginVisualFieldWell>
@Generated("software.amazon.awssdk:codegen") public final class PluginVisualFieldWell extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PluginVisualFieldWell.Builder,PluginVisualFieldWell>
A collection of field wells for a plugin visual.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePluginVisualFieldWell.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PluginVisualAxisNameaxisName()The semantic axis name for the field well.StringaxisNameAsString()The semantic axis name for the field well.static PluginVisualFieldWell.Builderbuilder()List<DimensionField>dimensions()A list of dimensions for the field well.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDimensions()For responses, this returns true if the service returned a value for the Dimensions property.inthashCode()booleanhasMeasures()For responses, this returns true if the service returned a value for the Measures property.booleanhasUnaggregated()For responses, this returns true if the service returned a value for the Unaggregated property.List<MeasureField>measures()A list of measures that exist in the field well.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PluginVisualFieldWell.Builder>serializableBuilderClass()PluginVisualFieldWell.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<UnaggregatedField>unaggregated()A list of unaggregated fields that exist in the field well.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
axisName
public final PluginVisualAxisName axisName()
The semantic axis name for the field well.
If the service returns an enum value that is not available in the current SDK version,
axisNamewill returnPluginVisualAxisName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaxisNameAsString().- Returns:
- The semantic axis name for the field well.
- See Also:
PluginVisualAxisName
-
axisNameAsString
public final String axisNameAsString()
The semantic axis name for the field well.
If the service returns an enum value that is not available in the current SDK version,
axisNamewill returnPluginVisualAxisName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaxisNameAsString().- Returns:
- The semantic axis name for the field well.
- See Also:
PluginVisualAxisName
-
hasDimensions
public final boolean hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
dimensions
public final List<DimensionField> dimensions()
A list of dimensions for the field well.
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
hasDimensions()method.- Returns:
- A list of dimensions for the field well.
-
hasMeasures
public final boolean hasMeasures()
For responses, this returns true if the service returned a value for the Measures property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
measures
public final List<MeasureField> measures()
A list of measures that exist in the field well.
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
hasMeasures()method.- Returns:
- A list of measures that exist in the field well.
-
hasUnaggregated
public final boolean hasUnaggregated()
For responses, this returns true if the service returned a value for the Unaggregated property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
unaggregated
public final List<UnaggregatedField> unaggregated()
A list of unaggregated fields that exist in the field well.
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
hasUnaggregated()method.- Returns:
- A list of unaggregated fields that exist in the field well.
-
toBuilder
public PluginVisualFieldWell.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PluginVisualFieldWell.Builder,PluginVisualFieldWell>
-
builder
public static PluginVisualFieldWell.Builder builder()
-
serializableBuilderClass
public static Class<? extends PluginVisualFieldWell.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-