com.google.maps.addressvalidation.v1

Interface VerdictOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Verdict, Verdict.Builder

public interface VerdictOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAddressComplete() The address is considered complete if there are no unresolved tokens, no unexpected or missing address components.
Verdict.Granularity	getGeocodeGranularity() Information about the granularity of the [`geocode`][google.maps.addressvalidation.v1.ValidationResult.geocode].
int	getGeocodeGranularityValue() Information about the granularity of the [`geocode`][google.maps.addressvalidation.v1.ValidationResult.geocode].
boolean	getHasInferredComponents() At least one address component was inferred (added) that wasn't in the input, see [google.maps.addressvalidation.v1.Address.address_components] for details.
boolean	getHasReplacedComponents() At least one address component was replaced, see [google.maps.addressvalidation.v1.Address.address_components] for details.
boolean	getHasUnconfirmedComponents() At least one address component cannot be categorized or validated, see [google.maps.addressvalidation.v1.Address.address_components] for details.
Verdict.Granularity	getInputGranularity() The granularity of the **input** address.
int	getInputGranularityValue() The granularity of the **input** address.
Verdict.Granularity	getValidationGranularity() The granularity level that the API can fully **validate** the address to.
int	getValidationGranularityValue() The granularity level that the API can fully **validate** the address to.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getInputGranularityValue

int getInputGranularityValue()

 The granularity of the **input** address. This is the result of parsing the
 input address and does not give any validation signals. For validation
 signals, refer to `validation_granularity` below.

 For example, if the input address includes a specific apartment number,
 then the `input_granularity` here will be `SUB_PREMISE`. If we cannot match
 the apartment number in the databases or the apartment number is invalid,
 the `validation_granularity` will likely be `PREMISE` or below.
 

.google.maps.addressvalidation.v1.Verdict.Granularity input_granularity = 1;

Returns:

The enum numeric value on the wire for inputGranularity.

getInputGranularity

Verdict.Granularity getInputGranularity()

 The granularity of the **input** address. This is the result of parsing the
 input address and does not give any validation signals. For validation
 signals, refer to `validation_granularity` below.

 For example, if the input address includes a specific apartment number,
 then the `input_granularity` here will be `SUB_PREMISE`. If we cannot match
 the apartment number in the databases or the apartment number is invalid,
 the `validation_granularity` will likely be `PREMISE` or below.
 

.google.maps.addressvalidation.v1.Verdict.Granularity input_granularity = 1;

Returns:

The inputGranularity.

getValidationGranularityValue

int getValidationGranularityValue()

 The granularity level that the API can fully **validate** the address to.
 For example, an `validation_granularity` of `PREMISE` indicates all address
 components at the level of `PREMISE` or more coarse can be validated.

 Per address component validation result can be found in
 [google.maps.addressvalidation.v1.Address.address_components].
 

.google.maps.addressvalidation.v1.Verdict.Granularity validation_granularity = 2;

Returns:

The enum numeric value on the wire for validationGranularity.

getValidationGranularity

Verdict.Granularity getValidationGranularity()

 The granularity level that the API can fully **validate** the address to.
 For example, an `validation_granularity` of `PREMISE` indicates all address
 components at the level of `PREMISE` or more coarse can be validated.

 Per address component validation result can be found in
 [google.maps.addressvalidation.v1.Address.address_components].
 

.google.maps.addressvalidation.v1.Verdict.Granularity validation_granularity = 2;

Returns:

The validationGranularity.

getGeocodeGranularityValue

int getGeocodeGranularityValue()

 Information about the granularity of the
 [`geocode`][google.maps.addressvalidation.v1.ValidationResult.geocode].
 This can be understood as the semantic meaning of how coarse or fine the
 geocoded location is.

 This can differ from the `validation_granularity` above occasionally. For
 example, our database might record the existence of an apartment number but
 do not have a precise location for the apartment within a big apartment
 complex. In that case, the `validation_granularity` will be `SUB_PREMISE`
 but the `geocode_granularity` will be `PREMISE`.
 

.google.maps.addressvalidation.v1.Verdict.Granularity geocode_granularity = 3;

Returns:

The enum numeric value on the wire for geocodeGranularity.

getGeocodeGranularity

Verdict.Granularity getGeocodeGranularity()

 Information about the granularity of the
 [`geocode`][google.maps.addressvalidation.v1.ValidationResult.geocode].
 This can be understood as the semantic meaning of how coarse or fine the
 geocoded location is.

 This can differ from the `validation_granularity` above occasionally. For
 example, our database might record the existence of an apartment number but
 do not have a precise location for the apartment within a big apartment
 complex. In that case, the `validation_granularity` will be `SUB_PREMISE`
 but the `geocode_granularity` will be `PREMISE`.
 

.google.maps.addressvalidation.v1.Verdict.Granularity geocode_granularity = 3;

Returns:

The geocodeGranularity.

getAddressComplete

boolean getAddressComplete()

 The address is considered complete if there are no unresolved tokens, no
 unexpected or missing address components. See
 [`missing_component_types`][google.maps.addressvalidation.v1.Address.missing_component_types],
 [`unresolved_tokens`][google.maps.addressvalidation.v1.Address.unresolved_tokens]
 or
 [`unexpected`][google.maps.addressvalidation.v1.AddressComponent.unexpected]
 fields for more details.
 

bool address_complete = 4;

Returns:

The addressComplete.

getHasUnconfirmedComponents

boolean getHasUnconfirmedComponents()

 At least one address component cannot be categorized or validated, see
 [google.maps.addressvalidation.v1.Address.address_components] for
 details.
 

bool has_unconfirmed_components = 5;

Returns:

The hasUnconfirmedComponents.

getHasInferredComponents

boolean getHasInferredComponents()

 At least one address component was inferred (added) that wasn't in the
 input, see
 [google.maps.addressvalidation.v1.Address.address_components] for
 details.
 

bool has_inferred_components = 6;

Returns:

The hasInferredComponents.

getHasReplacedComponents

boolean getHasReplacedComponents()

 At least one address component was replaced, see
 [google.maps.addressvalidation.v1.Address.address_components] for
 details.
 

bool has_replaced_components = 7;

Returns:

The hasReplacedComponents.