Class StreetComponents

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

Components of a street.

See Also:

  • Method Details

    • baseName

      public final String baseName()

      Base name part of the street name.

      Example: Younge from the "Younge street".

      Returns:
      Base name part of the street name.

      Example: Younge from the "Younge street".

    • type

      public final String type()

      Street type part of the street name.

      Example: "avenue".

      Returns:
      Street type part of the street name.

      Example: "avenue".

    • typePlacement

      public final TypePlacement typePlacement()

      Defines if the street type is before or after the base name.

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

      Returns:
      Defines if the street type is before or after the base name.
      See Also:

    • typePlacementAsString

      public final String typePlacementAsString()

      Defines if the street type is before or after the base name.

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

      Returns:
      Defines if the street type is before or after the base name.
      See Also:

    • typeSeparator

      public final String typeSeparator()

      Defines a separator character such as "" or " " between the base name and type.

      Returns:
      Defines a separator character such as "" or " " between the base name and type.

    • prefix

      public final String prefix()

      A prefix is a directional identifier that precedes, but is not included in, the base name of a road.

      Example: E for East.

      Returns:
      A prefix is a directional identifier that precedes, but is not included in, the base name of a road.

      Example: E for East.

    • suffix

      public final String suffix()

      A suffix is a directional identifier that follows, but is not included in, the base name of a road.

      Example W for West.

      Returns:
      A suffix is a directional identifier that follows, but is not included in, the base name of a road.

      Example W for West.

    • direction

      public final String direction()

      Indicates the official directional identifiers assigned to highways.

      Returns:
      Indicates the official directional identifiers assigned to highways.

    • language

      public final String language()

      A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

      Returns:
      A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

    • toBuilder

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

    • builder

      public static StreetComponents.Builder builder()

    • serializableBuilderClass

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