Class AddressComponentPhonemes
- java.lang.Object
-
- software.amazon.awssdk.services.geoplaces.model.AddressComponentPhonemes
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AddressComponentPhonemes.Builder,AddressComponentPhonemes>
@Generated("software.amazon.awssdk:codegen") public final class AddressComponentPhonemes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AddressComponentPhonemes.Builder,AddressComponentPhonemes>
How to pronounce the various components of the address or place.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAddressComponentPhonemes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<PhonemeTranscription>block()How to pronounce the name of the block.static AddressComponentPhonemes.Builderbuilder()List<PhonemeTranscription>country()The alpha-2 or alpha-3 character code for the country that the results will be present in.List<PhonemeTranscription>district()How to pronounce the district or division of a city results should be present in.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasBlock()For responses, this returns true if the service returned a value for the Block property.booleanhasCountry()For responses, this returns true if the service returned a value for the Country property.booleanhasDistrict()For responses, this returns true if the service returned a value for the District property.inthashCode()booleanhasLocality()For responses, this returns true if the service returned a value for the Locality property.booleanhasRegion()For responses, this returns true if the service returned a value for the Region property.booleanhasStreet()For responses, this returns true if the service returned a value for the Street property.booleanhasSubBlock()For responses, this returns true if the service returned a value for the SubBlock property.booleanhasSubDistrict()For responses, this returns true if the service returned a value for the SubDistrict property.booleanhasSubRegion()For responses, this returns true if the service returned a value for the SubRegion property.List<PhonemeTranscription>locality()How to pronounce the city or locality results should be present in.List<PhonemeTranscription>region()How to pronounce the region or state results should be to be present in.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AddressComponentPhonemes.Builder>serializableBuilderClass()List<PhonemeTranscription>street()How to pronounce the name of the street results should be present in.List<PhonemeTranscription>subBlock()How to pronounce the name of the sub-block.List<PhonemeTranscription>subDistrict()How to pronounce the sub-district or division of a city results should be present in.List<PhonemeTranscription>subRegion()How to pronounce the sub-region or county for which results should be present in.AddressComponentPhonemes.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
hasCountry
public final boolean hasCountry()
For responses, this returns true if the service returned a value for the Country property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
country
public final List<PhonemeTranscription> country()
The alpha-2 or alpha-3 character code for the country that the results will be present in.
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
hasCountry()method.- Returns:
- The alpha-2 or alpha-3 character code for the country that the results will be present in.
-
hasRegion
public final boolean hasRegion()
For responses, this returns true if the service returned a value for the Region property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
region
public final List<PhonemeTranscription> region()
How to pronounce the region or state results should be to be present in.
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
hasRegion()method.- Returns:
- How to pronounce the region or state results should be to be present in.
-
hasSubRegion
public final boolean hasSubRegion()
For responses, this returns true if the service returned a value for the SubRegion property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
subRegion
public final List<PhonemeTranscription> subRegion()
How to pronounce the sub-region or county for which results should be present in.
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
hasSubRegion()method.- Returns:
- How to pronounce the sub-region or county for which results should be present in.
-
hasLocality
public final boolean hasLocality()
For responses, this returns true if the service returned a value for the Locality property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
locality
public final List<PhonemeTranscription> locality()
How to pronounce the city or locality results should be present in.
Example:
Vancouver.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
hasLocality()method.- Returns:
- How to pronounce the city or locality results should be present in.
Example:
Vancouver.
-
hasDistrict
public final boolean hasDistrict()
For responses, this returns true if the service returned a value for the District property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
district
public final List<PhonemeTranscription> district()
How to pronounce the district or division of a city results should be present in.
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
hasDistrict()method.- Returns:
- How to pronounce the district or division of a city results should be present in.
-
hasSubDistrict
public final boolean hasSubDistrict()
For responses, this returns true if the service returned a value for the SubDistrict property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
subDistrict
public final List<PhonemeTranscription> subDistrict()
How to pronounce the sub-district or division of a city results should be present in.
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
hasSubDistrict()method.- Returns:
- How to pronounce the sub-district or division of a city results should be present in.
-
hasBlock
public final boolean hasBlock()
For responses, this returns true if the service returned a value for the Block property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
block
public final List<PhonemeTranscription> block()
How to pronounce the name of the block.
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
hasBlock()method.- Returns:
- How to pronounce the name of the block.
-
hasSubBlock
public final boolean hasSubBlock()
For responses, this returns true if the service returned a value for the SubBlock property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
subBlock
public final List<PhonemeTranscription> subBlock()
How to pronounce the name of the sub-block.
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
hasSubBlock()method.- Returns:
- How to pronounce the name of the sub-block.
-
hasStreet
public final boolean hasStreet()
For responses, this returns true if the service returned a value for the Street property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
street
public final List<PhonemeTranscription> street()
How to pronounce the name of the street results should be present in.
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
hasStreet()method.- Returns:
- How to pronounce the name of the street results should be present in.
-
toBuilder
public AddressComponentPhonemes.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AddressComponentPhonemes.Builder,AddressComponentPhonemes>
-
builder
public static AddressComponentPhonemes.Builder builder()
-
serializableBuilderClass
public static Class<? extends AddressComponentPhonemes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-