Class IsolineSideOfStreetOptions

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

Controls how points are matched to specific sides of streets. This is important when the side of the street matters for accessibility - for example, when building entrances or parking lot access points can only be reached from one side of a divided road.

See Also:

  • Method Details

    • 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 [longitude, latitude] coordinates of the point that should be matched to a specific side of the street.

      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 [longitude, latitude] coordinates of the point that should be matched to a specific side of the street.

    • useWith

      public final SideOfStreetMatchingStrategy useWith()

      Controls whether side-of-street matching is applied to any street (AnyStreet) or only to divided roads (DividedStreetOnly). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don't account for necessary U-turns or detours to reach the correct side.

      Default value: DividedStreetOnly

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

      Returns:
      Controls whether side-of-street matching is applied to any street (AnyStreet) or only to divided roads (DividedStreetOnly). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don't account for necessary U-turns or detours to reach the correct side.

      Default value: DividedStreetOnly

      See Also:

    • useWithAsString

      public final String useWithAsString()

      Controls whether side-of-street matching is applied to any street (AnyStreet) or only to divided roads (DividedStreetOnly). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don't account for necessary U-turns or detours to reach the correct side.

      Default value: DividedStreetOnly

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

      Returns:
      Controls whether side-of-street matching is applied to any street (AnyStreet) or only to divided roads (DividedStreetOnly). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don't account for necessary U-turns or detours to reach the correct side.

      Default value: DividedStreetOnly

      See Also:

    • toBuilder

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

    • builder

      public static IsolineSideOfStreetOptions.Builder builder()

    • serializableBuilderClass

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