Class RouteTransitOptions

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

Options related to transit routing.

Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

See Also:

  • Method Details

    • accessibilityAttributes

      public final List<RouteAccessibilityAttribute> accessibilityAttributes()

      Accessibility attributes to consider when calculating the route.

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

      Returns:
      Accessibility attributes to consider when calculating the route.

    • hasAccessibilityAttributes

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

    • accessibilityAttributesAsStrings

      public final List<String> accessibilityAttributesAsStrings()

      Accessibility attributes to consider when calculating the route.

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

      Returns:
      Accessibility attributes to consider when calculating the route.

    • allowedModes

      public final List<RouteTransitMode> allowedModes()

      Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with ExcludedModes.

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

      Returns:
      Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with ExcludedModes.

    • hasAllowedModes

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

    • allowedModesAsStrings

      public final List<String> allowedModesAsStrings()

      Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with ExcludedModes.

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

      Returns:
      Allowed transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with ExcludedModes.

    • excludedModes

      public final List<RouteTransitMode> excludedModes()

      Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with AllowedModes.

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

      Returns:
      Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with AllowedModes.

    • hasExcludedModes

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

    • excludedModesAsStrings

      public final List<String> excludedModesAsStrings()

      Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with AllowedModes.

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

      Returns:
      Excluded transit transport modes when calculating the route. By default, all transport modes are allowed. Cannot be used together with AllowedModes.

    • maxTransfers

      public final Integer maxTransfers()

      Maximum number of transfers allowed when calculating the route.

      Returns:
      Maximum number of transfers allowed when calculating the route.

    • pedestrian

      public final RouteTransitPedestrianOptions pedestrian()

      Options for the pedestrian leg of the transit route.

      Returns:
      Options for the pedestrian leg of the transit route.

    • toBuilder

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

    • builder

      public static RouteTransitOptions.Builder builder()

    • serializableBuilderClass

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