Package com.google.maps.addressvalidation.v1

Interface AddressOrBuilder

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

    • Method Detail

      • getFormattedAddress

        String getFormattedAddress()
         The post-processed address, formatted as a single-line address following
 the address formatting rules of the region where the address is located.
        string formatted_address = 2;
        Returns:
        The formattedAddress.

      • getFormattedAddressBytes

        com.google.protobuf.ByteString getFormattedAddressBytes()
         The post-processed address, formatted as a single-line address following
 the address formatting rules of the region where the address is located.
        string formatted_address = 2;
        Returns:
        The bytes for formattedAddress.

      • hasPostalAddress

        boolean hasPostalAddress()
         The post-processed address represented as a postal address.
        .google.type.PostalAddress postal_address = 3;
        Returns:
        Whether the postalAddress field is set.

      • getPostalAddress

        com.google.type.PostalAddress getPostalAddress()
         The post-processed address represented as a postal address.
        .google.type.PostalAddress postal_address = 3;
        Returns:
        The postalAddress.

      • getPostalAddressOrBuilder

        com.google.type.PostalAddressOrBuilder getPostalAddressOrBuilder()
         The post-processed address represented as a postal address.
        .google.type.PostalAddress postal_address = 3;

      • getAddressComponentsList

        List<AddressComponent> getAddressComponentsList()
         Unordered list. The individual address components of the formatted and
 corrected address, along with validation information. This provides
 information on the validation status of the individual components.

 Address components are not ordered in a particular way. Do not make any
 assumptions on the ordering of the address components in the list.
        repeated .google.maps.addressvalidation.v1.AddressComponent address_components = 4 [(.google.api.field_behavior) = UNORDERED_LIST];

      • getAddressComponents

        AddressComponent getAddressComponents​(int index)
         Unordered list. The individual address components of the formatted and
 corrected address, along with validation information. This provides
 information on the validation status of the individual components.

 Address components are not ordered in a particular way. Do not make any
 assumptions on the ordering of the address components in the list.
        repeated .google.maps.addressvalidation.v1.AddressComponent address_components = 4 [(.google.api.field_behavior) = UNORDERED_LIST];

      • getAddressComponentsCount

        int getAddressComponentsCount()
         Unordered list. The individual address components of the formatted and
 corrected address, along with validation information. This provides
 information on the validation status of the individual components.

 Address components are not ordered in a particular way. Do not make any
 assumptions on the ordering of the address components in the list.
        repeated .google.maps.addressvalidation.v1.AddressComponent address_components = 4 [(.google.api.field_behavior) = UNORDERED_LIST];

      • getAddressComponentsOrBuilderList

        List<? extends AddressComponentOrBuilder> getAddressComponentsOrBuilderList()
         Unordered list. The individual address components of the formatted and
 corrected address, along with validation information. This provides
 information on the validation status of the individual components.

 Address components are not ordered in a particular way. Do not make any
 assumptions on the ordering of the address components in the list.
        repeated .google.maps.addressvalidation.v1.AddressComponent address_components = 4 [(.google.api.field_behavior) = UNORDERED_LIST];

      • getAddressComponentsOrBuilder

        AddressComponentOrBuilder getAddressComponentsOrBuilder​(int index)
         Unordered list. The individual address components of the formatted and
 corrected address, along with validation information. This provides
 information on the validation status of the individual components.

 Address components are not ordered in a particular way. Do not make any
 assumptions on the ordering of the address components in the list.
        repeated .google.maps.addressvalidation.v1.AddressComponent address_components = 4 [(.google.api.field_behavior) = UNORDERED_LIST];

      • getMissingComponentTypesList

        List<String> getMissingComponentTypesList()
         The types of components that were expected to be present in a correctly
 formatted mailing address but were not found in the input AND could
 not be inferred. Components of this type are not present in
 `formatted_address`, `postal_address`, or `address_components`. An
 example might be `['street_number', 'route']` for an input like
 "Boulder, Colorado, 80301, USA". The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string missing_component_types = 5;
        Returns:
        A list containing the missingComponentTypes.

      • getMissingComponentTypesCount

        int getMissingComponentTypesCount()
         The types of components that were expected to be present in a correctly
 formatted mailing address but were not found in the input AND could
 not be inferred. Components of this type are not present in
 `formatted_address`, `postal_address`, or `address_components`. An
 example might be `['street_number', 'route']` for an input like
 "Boulder, Colorado, 80301, USA". The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string missing_component_types = 5;
        Returns:
        The count of missingComponentTypes.

      • getMissingComponentTypes

        String getMissingComponentTypes​(int index)
         The types of components that were expected to be present in a correctly
 formatted mailing address but were not found in the input AND could
 not be inferred. Components of this type are not present in
 `formatted_address`, `postal_address`, or `address_components`. An
 example might be `['street_number', 'route']` for an input like
 "Boulder, Colorado, 80301, USA". The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string missing_component_types = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The missingComponentTypes at the given index.

      • getMissingComponentTypesBytes

        com.google.protobuf.ByteString getMissingComponentTypesBytes​(int index)
         The types of components that were expected to be present in a correctly
 formatted mailing address but were not found in the input AND could
 not be inferred. Components of this type are not present in
 `formatted_address`, `postal_address`, or `address_components`. An
 example might be `['street_number', 'route']` for an input like
 "Boulder, Colorado, 80301, USA". The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string missing_component_types = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the missingComponentTypes at the given index.

      • getUnconfirmedComponentTypesList

        List<String> getUnconfirmedComponentTypesList()
         The types of the components that are present in the `address_components`
 but could not be confirmed to be correct. This field is provided for the
 sake of convenience: its contents are equivalent to iterating through the
 `address_components` to find the types of all the components where the
 [confirmation_level][google.maps.addressvalidation.v1.AddressComponent.confirmation_level]
 is not
 [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED]
 or the
 [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred]
 flag is not set to `true`. The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string unconfirmed_component_types = 6;
        Returns:
        A list containing the unconfirmedComponentTypes.

      • getUnconfirmedComponentTypesCount

        int getUnconfirmedComponentTypesCount()
         The types of the components that are present in the `address_components`
 but could not be confirmed to be correct. This field is provided for the
 sake of convenience: its contents are equivalent to iterating through the
 `address_components` to find the types of all the components where the
 [confirmation_level][google.maps.addressvalidation.v1.AddressComponent.confirmation_level]
 is not
 [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED]
 or the
 [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred]
 flag is not set to `true`. The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string unconfirmed_component_types = 6;
        Returns:
        The count of unconfirmedComponentTypes.

      • getUnconfirmedComponentTypes

        String getUnconfirmedComponentTypes​(int index)
         The types of the components that are present in the `address_components`
 but could not be confirmed to be correct. This field is provided for the
 sake of convenience: its contents are equivalent to iterating through the
 `address_components` to find the types of all the components where the
 [confirmation_level][google.maps.addressvalidation.v1.AddressComponent.confirmation_level]
 is not
 [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED]
 or the
 [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred]
 flag is not set to `true`. The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string unconfirmed_component_types = 6;
        Parameters:
        index - The index of the element to return.
        Returns:
        The unconfirmedComponentTypes at the given index.

      • getUnconfirmedComponentTypesBytes

        com.google.protobuf.ByteString getUnconfirmedComponentTypesBytes​(int index)
         The types of the components that are present in the `address_components`
 but could not be confirmed to be correct. This field is provided for the
 sake of convenience: its contents are equivalent to iterating through the
 `address_components` to find the types of all the components where the
 [confirmation_level][google.maps.addressvalidation.v1.AddressComponent.confirmation_level]
 is not
 [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED]
 or the
 [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred]
 flag is not set to `true`. The list of possible types can be found
 [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
        repeated string unconfirmed_component_types = 6;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the unconfirmedComponentTypes at the given index.

      • getUnresolvedTokensList

        List<String> getUnresolvedTokensList()
         Any tokens in the input that could not be resolved. This might be an
 input that was not recognized as a valid part of an address (for example
 in an input like "123235253253 Main St, San Francisco, CA, 94105", the
 unresolved tokens may look like `["123235253253"]` since that does not
 look like a valid street number.
        repeated string unresolved_tokens = 7;
        Returns:
        A list containing the unresolvedTokens.

      • getUnresolvedTokensCount

        int getUnresolvedTokensCount()
         Any tokens in the input that could not be resolved. This might be an
 input that was not recognized as a valid part of an address (for example
 in an input like "123235253253 Main St, San Francisco, CA, 94105", the
 unresolved tokens may look like `["123235253253"]` since that does not
 look like a valid street number.
        repeated string unresolved_tokens = 7;
        Returns:
        The count of unresolvedTokens.

      • getUnresolvedTokens

        String getUnresolvedTokens​(int index)
         Any tokens in the input that could not be resolved. This might be an
 input that was not recognized as a valid part of an address (for example
 in an input like "123235253253 Main St, San Francisco, CA, 94105", the
 unresolved tokens may look like `["123235253253"]` since that does not
 look like a valid street number.
        repeated string unresolved_tokens = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The unresolvedTokens at the given index.

      • getUnresolvedTokensBytes

        com.google.protobuf.ByteString getUnresolvedTokensBytes​(int index)
         Any tokens in the input that could not be resolved. This might be an
 input that was not recognized as a valid part of an address (for example
 in an input like "123235253253 Main St, San Francisco, CA, 94105", the
 unresolved tokens may look like `["123235253253"]` since that does not
 look like a valid street number.
        repeated string unresolved_tokens = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the unresolvedTokens at the given index.