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:

  • Method Details

    • 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, layerType will return GeospatialLayerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from layerTypeAsString().

      Returns:
      The layer type.
      See Also:

    • layerTypeAsString

      public final String layerTypeAsString()

      The layer type.

      If the service returns an enum value that is not available in the current SDK version, layerType will return GeospatialLayerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from layerTypeAsString().

      Returns:
      The layer type.
      See Also:

    • 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, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      The state of visibility for the layer.
      See Also:

    • 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, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      The state of visibility for the layer.
      See Also:

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

    • 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()
      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<GeospatialLayerItem.Builder,GeospatialLayerItem>
      Returns:
      a builder for type T

    • builder

      public static GeospatialLayerItem.Builder builder()

    • serializableBuilderClass

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