Class GeospatialLayerItem
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.GeospatialLayerItem
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<GeospatialLayerItem.Builder,GeospatialLayerItem>
@Generated("software.amazon.awssdk:codegen") public final class GeospatialLayerItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GeospatialLayerItem.Builder,GeospatialLayerItem>
The properties for a single geospatial layer.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGeospatialLayerItem.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<LayerCustomAction>actions()A list of custom actions for a layer.static GeospatialLayerItem.Builderbuilder()GeospatialDataSourceItemdataSource()The data source for the layer.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActions()For responses, this returns true if the service returned a value for the Actions property.inthashCode()GeospatialLayerJoinDefinitionjoinDefinition()The join definition properties for a layer.Stringlabel()The label that is displayed for the layer.GeospatialLayerDefinitionlayerDefinition()The definition properties for a layer.StringlayerId()The ID of the layer.GeospatialLayerTypelayerType()The layer type.StringlayerTypeAsString()The layer type.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GeospatialLayerItem.Builder>serializableBuilderClass()GeospatialLayerItem.BuildertoBuilder()TooltipOptionstooltip()Returns the value of the Tooltip property for this object.StringtoString()Returns a string representation of this object.Visibilityvisibility()The state of visibility for the layer.StringvisibilityAsString()The state of visibility for the layer.-
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
-
layerId
public final String layerId()
The ID of the layer.
- Returns:
- The ID of the layer.
-
layerType
public final GeospatialLayerType layerType()
The layer type.
If the service returns an enum value that is not available in the current SDK version,
layerTypewill returnGeospatialLayerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlayerTypeAsString().- Returns:
- The layer type.
- See Also:
GeospatialLayerType
-
layerTypeAsString
public final String layerTypeAsString()
The layer type.
If the service returns an enum value that is not available in the current SDK version,
layerTypewill returnGeospatialLayerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlayerTypeAsString().- Returns:
- The layer type.
- See Also:
GeospatialLayerType
-
dataSource
public final GeospatialDataSourceItem dataSource()
The data source for the layer.
- Returns:
- The data source for the layer.
-
label
public final String label()
The label that is displayed for the layer.
- Returns:
- The label that is displayed for the layer.
-
visibility
public final Visibility visibility()
The state of visibility for the layer.
If the service returns an enum value that is not available in the current SDK version,
visibilitywill returnVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvisibilityAsString().- Returns:
- The state of visibility for the layer.
- See Also:
Visibility
-
visibilityAsString
public final String visibilityAsString()
The state of visibility for the layer.
If the service returns an enum value that is not available in the current SDK version,
visibilitywill returnVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvisibilityAsString().- Returns:
- The state of visibility for the layer.
- See Also:
Visibility
-
layerDefinition
public final GeospatialLayerDefinition layerDefinition()
The definition properties for a layer.
- Returns:
- The definition properties for a layer.
-
tooltip
public final TooltipOptions tooltip()
Returns the value of the Tooltip property for this object.- Returns:
- The value of the Tooltip property for this object.
-
joinDefinition
public final GeospatialLayerJoinDefinition joinDefinition()
The join definition properties for a layer.
- Returns:
- The join definition properties for a layer.
-
hasActions
public final boolean hasActions()
For responses, this returns true if the service returned a value for the Actions 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.
-
actions
public final List<LayerCustomAction> actions()
A list of custom actions for a layer.
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
hasActions()method.- Returns:
- A list of custom actions for a layer.
-
toBuilder
public GeospatialLayerItem.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GeospatialLayerItem.Builder,GeospatialLayerItem>
-
builder
public static GeospatialLayerItem.Builder builder()
-
serializableBuilderClass
public static Class<? extends GeospatialLayerItem.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
-
-