Package com.google.maps.addressvalidation.v1

Class Address

  • All Implemented Interfaces:
    AddressOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Address
extends com.google.protobuf.GeneratedMessageV3
implements AddressOrBuilder
     Details of the post-processed address. Post-processing includes
 correcting misspelled parts of the address, replacing incorrect parts, and
 inferring missing parts.
    Protobuf type google.maps.addressvalidation.v1.Address
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Address.Builder
      Details of the post-processed address.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • FORMATTED_ADDRESS_FIELD_NUMBER

        public static final int FORMATTED_ADDRESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POSTAL_ADDRESS_FIELD_NUMBER

        public static final int POSTAL_ADDRESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDRESS_COMPONENTS_FIELD_NUMBER

        public static final int ADDRESS_COMPONENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MISSING_COMPONENT_TYPES_FIELD_NUMBER

        public static final int MISSING_COMPONENT_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNCONFIRMED_COMPONENT_TYPES_FIELD_NUMBER

        public static final int UNCONFIRMED_COMPONENT_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNRESOLVED_TOKENS_FIELD_NUMBER

        public static final int UNRESOLVED_TOKENS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getFormattedAddress

        public 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;
        Specified by:
        getFormattedAddress in interface AddressOrBuilder
        Returns:
        The formattedAddress.

      • getFormattedAddressBytes

        public 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;
        Specified by:
        getFormattedAddressBytes in interface AddressOrBuilder
        Returns:
        The bytes for formattedAddress.

      • hasPostalAddress

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

      • getPostalAddress

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

      • getPostalAddressOrBuilder

        public com.google.type.PostalAddressOrBuilder getPostalAddressOrBuilder()
         The post-processed address represented as a postal address.
        .google.type.PostalAddress postal_address = 3;
        Specified by:
        getPostalAddressOrBuilder in interface AddressOrBuilder

      • getAddressComponentsList

        public 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];
        Specified by:
        getAddressComponentsList in interface AddressOrBuilder

      • getAddressComponentsOrBuilderList

        public 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];
        Specified by:
        getAddressComponentsOrBuilderList in interface AddressOrBuilder

      • getAddressComponentsCount

        public 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];
        Specified by:
        getAddressComponentsCount in interface AddressOrBuilder

      • getAddressComponents

        public 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];
        Specified by:
        getAddressComponents in interface AddressOrBuilder

      • getAddressComponentsOrBuilder

        public 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];
        Specified by:
        getAddressComponentsOrBuilder in interface AddressOrBuilder

      • getMissingComponentTypesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getMissingComponentTypesList in interface AddressOrBuilder
        Returns:
        A list containing the missingComponentTypes.

      • getMissingComponentTypesCount

        public 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;
        Specified by:
        getMissingComponentTypesCount in interface AddressOrBuilder
        Returns:
        The count of missingComponentTypes.

      • getMissingComponentTypes

        public 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;
        Specified by:
        getMissingComponentTypes in interface AddressOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The missingComponentTypes at the given index.

      • getMissingComponentTypesBytes

        public 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;
        Specified by:
        getMissingComponentTypesBytes in interface AddressOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the missingComponentTypes at the given index.

      • getUnconfirmedComponentTypesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getUnconfirmedComponentTypesList in interface AddressOrBuilder
        Returns:
        A list containing the unconfirmedComponentTypes.

      • getUnconfirmedComponentTypesCount

        public 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;
        Specified by:
        getUnconfirmedComponentTypesCount in interface AddressOrBuilder
        Returns:
        The count of unconfirmedComponentTypes.

      • getUnconfirmedComponentTypes

        public 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;
        Specified by:
        getUnconfirmedComponentTypes in interface AddressOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The unconfirmedComponentTypes at the given index.

      • getUnconfirmedComponentTypesBytes

        public 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;
        Specified by:
        getUnconfirmedComponentTypesBytes in interface AddressOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the unconfirmedComponentTypes at the given index.

      • getUnresolvedTokensList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getUnresolvedTokensList in interface AddressOrBuilder
        Returns:
        A list containing the unresolvedTokens.

      • getUnresolvedTokensCount

        public 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;
        Specified by:
        getUnresolvedTokensCount in interface AddressOrBuilder
        Returns:
        The count of unresolvedTokens.

      • getUnresolvedTokens

        public 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;
        Specified by:
        getUnresolvedTokens in interface AddressOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The unresolvedTokens at the given index.

      • getUnresolvedTokensBytes

        public 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;
        Specified by:
        getUnresolvedTokensBytes in interface AddressOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the unresolvedTokens at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Address parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Address parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Address parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Address parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Address parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Address parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Address parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Address.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Address.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Address.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Address getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Address> parser()

      • getParserForType

        public com.google.protobuf.Parser<Address> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Address getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder