Package com.google.maps.addressvalidation.v1

Interface ValidateAddressRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ValidateAddressRequest, ValidateAddressRequest.Builder
    public interface ValidateAddressRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.type.PostalAddress getAddress()
      Required.
      com.google.type.PostalAddressOrBuilder getAddressOrBuilder()
      Required.
      boolean getEnableUspsCass()
      Enables USPS CASS compatible mode.
      String getPreviousResponseId()
      This field must be empty for the first address validation request.
      com.google.protobuf.ByteString getPreviousResponseIdBytes()
      This field must be empty for the first address validation request.
      boolean hasAddress()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasAddress

        boolean hasAddress()
         Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
        .google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the address field is set.

      • getAddress

        com.google.type.PostalAddress getAddress()
         Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
        .google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The address.

      • getAddressOrBuilder

        com.google.type.PostalAddressOrBuilder getAddressOrBuilder()
         Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
        .google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

      • getPreviousResponseId

        String getPreviousResponseId()
         This field must be empty for the first address validation request. If
 more requests are necessary to fully validate a single address (for
 example if the changes the user makes after the initial validation need to
 be re-validated), then each followup request must populate this field with
 the
 [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id]
 from the very first response in the validation sequence.
        string previous_response_id = 2;
        Returns:
        The previousResponseId.

      • getPreviousResponseIdBytes

        com.google.protobuf.ByteString getPreviousResponseIdBytes()
         This field must be empty for the first address validation request. If
 more requests are necessary to fully validate a single address (for
 example if the changes the user makes after the initial validation need to
 be re-validated), then each followup request must populate this field with
 the
 [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id]
 from the very first response in the validation sequence.
        string previous_response_id = 2;
        Returns:
        The bytes for previousResponseId.

      • getEnableUspsCass

        boolean getEnableUspsCass()
         Enables USPS CASS compatible mode. This affects _only_ the
 [google.maps.addressvalidation.v1.ValidationResult.usps_data] field of
 [google.maps.addressvalidation.v1.ValidationResult]. Note: for USPS CASS
 enabled requests for addresses in Puerto Rico, a
 [google.type.PostalAddress.region_code] of the `address` must be provided
 as "PR", or an [google.type.PostalAddress.administrative_area] of the
 `address` must be provided as "Puerto Rico" (case-insensitive) or "PR".

 It's recommended to use a componentized `address`, or alternatively specify
 at least two [google.type.PostalAddress.address_lines] where the first line
 contains the street number and name and the second line contains the city,
 state, and zip code.
        bool enable_usps_cass = 3;
        Returns:
        The enableUspsCass.