Interface ValidateE911AddressResponse.Builder

  • Method Details

    • validationResult

      ValidateE911AddressResponse.Builder validationResult(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • addressExternalId

      ValidateE911AddressResponse.Builder addressExternalId(String addressExternalId)

      The ID that represents the address.

      Parameters:
      addressExternalId - The ID that represents the address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • address

      The validated address.

      Parameters:
      address - The validated address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • address

      The validated address.

      This is a convenience method that creates an instance of the Address.Builder avoiding the need to create one manually via Address.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to address(Address).

      Parameters:
      address - a consumer that will call methods on Address.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • candidateAddressList

      ValidateE911AddressResponse.Builder candidateAddressList(Collection<CandidateAddress> candidateAddressList)

      The list of address suggestions..

      Parameters:
      candidateAddressList - The list of address suggestions..
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • candidateAddressList

      ValidateE911AddressResponse.Builder candidateAddressList(CandidateAddress... candidateAddressList)

      The list of address suggestions..

      Parameters:
      candidateAddressList - The list of address suggestions..
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • candidateAddressList

      ValidateE911AddressResponse.Builder candidateAddressList(Consumer<CandidateAddress.Builder>... candidateAddressList)

      The list of address suggestions..

      This is a convenience method that creates an instance of the CandidateAddress.Builder avoiding the need to create one manually via CandidateAddress.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to candidateAddressList(List<CandidateAddress>).

      Parameters:
      candidateAddressList - a consumer that will call methods on CandidateAddress.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: