Package software.amazon.awssdk.services.chimesdkvoice.model

Class ValidateE911AddressResponse

    • Method Detail

      • validationResult

        public final Integer validationResult()

        Number indicating the result of address validation.

        Each possible result is defined as follows:

        • 0 - Address validation succeeded.

        • 1 - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.

        • 2 - Address validation failed. You should re-submit the validation request with candidates from the CandidateAddressList result, if it's a close match.

        Returns:
        Number indicating the result of address validation.

        Each possible result is defined as follows:

        • 0 - Address validation succeeded.

        • 1 - Address validation succeeded. The address was a close enough match and has been corrected as part of the address object.

        • 2 - Address validation failed. You should re-submit the validation request with candidates from the CandidateAddressList result, if it's a close match.

      • 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..

      • 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