Class RelatedPlace

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

Place that is related to the result item.

See Also:

  • Method Details

    • placeId

      public final String placeId()

      The PlaceId of the place result.

      Returns:
      The PlaceId of the place result.

    • placeType

      public final PlaceType placeType()

      A PlaceType is a category that the result place must belong to.

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

      Returns:
      A PlaceType is a category that the result place must belong to.
      See Also:

    • placeTypeAsString

      public final String placeTypeAsString()

      A PlaceType is a category that the result place must belong to.

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

      Returns:
      A PlaceType is a category that the result place must belong to.
      See Also:

    • title

      public final String title()

      The localized display name of this result item based on request parameter language.

      Returns:
      The localized display name of this result item based on request parameter language.

    • address

      public final Address address()
      Returns the value of the Address property for this object.
      Returns:
      The value of the Address property for this object.

    • hasPosition

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

    • position

      public final List<Double> position()

      The position, in longitude and latitude.

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

      Returns:
      The position, in longitude and latitude.

    • hasAccessPoints

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

    • accessPoints

      public final List<AccessPoint> accessPoints()

      Position of the access point represented by longitude and latitude.

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

      Returns:
      Position of the access point represented by longitude and latitude.

    • toBuilder

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

    • builder

      public static RelatedPlace.Builder builder()

    • serializableBuilderClass

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