Package software.amazon.awssdk.services.geoplaces.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreetComponents.Builder

Method Summary

Modifier and Type	Method	Description
String	baseName()	Base name part of the street name.
static StreetComponents.Builder	builder()
String	direction()	Indicates the official directional identifiers assigned to highways.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	language()	A BCP 47 compliant language codes for the results to be rendered in.
String	prefix()	A prefix is a directional identifier that precedes, but is not included in, the base name of a road.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StreetComponents.Builder>	serializableBuilderClass()
String	suffix()	A suffix is a directional identifier that follows, but is not included in, the base name of a road.
StreetComponents.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	Street type part of the street name.
TypePlacement	typePlacement()	Defines if the street type is before or after the base name.
String	typePlacementAsString()	Defines if the street type is before or after the base name.
String	typeSeparator()	What character(s) separates the string from its type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

TypePlacement

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:

TypePlacement

typeSeparator

public final String typeSeparator()

What character(s) separates the string from its type.

Returns:

What character(s) separates the string from its 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()

Specified by:

toBuilder in interface ToCopyableBuilder<StreetComponents.Builder,StreetComponents>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo