Package software.amazon.awssdk.services.chime.model

Class ValidateE911AddressResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.chime.model.ChimeResponse

software.amazon.awssdk.services.chime.model.ValidateE911AddressResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ValidateE911AddressResponse.Builder,ValidateE911AddressResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ValidateE911AddressResponse
extends ChimeResponse
implements ToCopyableBuilder<ValidateE911AddressResponse.Builder,ValidateE911AddressResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ValidateE911AddressResponse.Builder

Method Summary

Modifier and Type	Method	Description
Address	address()	The validated address.
String	addressExternalId()	The ID that represents the address.
static ValidateE911AddressResponse.Builder	builder()
List<CandidateAddress>	candidateAddressList()	The list of address suggestions.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCandidateAddressList()	For responses, this returns true if the service returned a value for the CandidateAddressList property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ValidateE911AddressResponse.Builder>	serializableBuilderClass()
ValidateE911AddressResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	validationResult()	Number indicating the result of address validation.

Methods inherited from class software.amazon.awssdk.services.chime.model.ChimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

validationResult

public final Integer validationResult()

Number indicating the result of address validation. 0 means the address was perfect as is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

Returns:

Number indicating the result of address validation. 0 means the address was perfect as is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

addressExternalId

public final String addressExternalId()

The ID that represents the address.

Returns:

The ID that represents the address.

address

public final Address address()

The validated address.

Returns:

The validated address.

hasCandidateAddressList

public final boolean hasCandidateAddressList()

For responses, this returns true if the service returned a value for the CandidateAddressList 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.

candidateAddressList

public final List<CandidateAddress> candidateAddressList()

The list of address suggestions.

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

Returns:

The list of address suggestions.

toBuilder

public ValidateE911AddressResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ValidateE911AddressResponse.Builder,ValidateE911AddressResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ValidateE911AddressResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ValidateE911AddressResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

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