Package cloud.google.com/go/maps/addressvalidation/apiv1/addressvalidationpb (v0.1.0)

Stay organized with collections Save and categorize content based on your preferences.

Variables

AddressComponent_ConfirmationLevel_name, AddressComponent_ConfirmationLevel_value

var (
	AddressComponent_ConfirmationLevel_name = map[int32]string{
		0: "CONFIRMATION_LEVEL_UNSPECIFIED",
		1: "CONFIRMED",
		2: "UNCONFIRMED_BUT_PLAUSIBLE",
		3: "UNCONFIRMED_AND_SUSPICIOUS",
	}
	AddressComponent_ConfirmationLevel_value = map[string]int32{
		"CONFIRMATION_LEVEL_UNSPECIFIED": 0,
		"CONFIRMED":                      1,
		"UNCONFIRMED_BUT_PLAUSIBLE":      2,
		"UNCONFIRMED_AND_SUSPICIOUS":     3,
	}
)

Enum value maps for AddressComponent_ConfirmationLevel.

ProvideValidationFeedbackRequest_ValidationConclusion_name, ProvideValidationFeedbackRequest_ValidationConclusion_value

var (
	ProvideValidationFeedbackRequest_ValidationConclusion_name = map[int32]string{
		0: "VALIDATION_CONCLUSION_UNSPECIFIED",
		1: "VALIDATED_VERSION_USED",
		2: "USER_VERSION_USED",
		3: "UNVALIDATED_VERSION_USED",
		4: "UNUSED",
	}
	ProvideValidationFeedbackRequest_ValidationConclusion_value = map[string]int32{
		"VALIDATION_CONCLUSION_UNSPECIFIED": 0,
		"VALIDATED_VERSION_USED":            1,
		"USER_VERSION_USED":                 2,
		"UNVALIDATED_VERSION_USED":          3,
		"UNUSED":                            4,
	}
)

Enum value maps for ProvideValidationFeedbackRequest_ValidationConclusion.

Verdict_Granularity_name, Verdict_Granularity_value

var (
	Verdict_Granularity_name = map[int32]string{
		0: "GRANULARITY_UNSPECIFIED",
		1: "SUB_PREMISE",
		2: "PREMISE",
		3: "PREMISE_PROXIMITY",
		4: "BLOCK",
		5: "ROUTE",
		6: "OTHER",
	}
	Verdict_Granularity_value = map[string]int32{
		"GRANULARITY_UNSPECIFIED": 0,
		"SUB_PREMISE":             1,
		"PREMISE":                 2,
		"PREMISE_PROXIMITY":       3,
		"BLOCK":                   4,
		"ROUTE":                   5,
		"OTHER":                   6,
	}
)

Enum value maps for Verdict_Granularity.

File_google_maps_addressvalidation_v1_address_proto

var File_google_maps_addressvalidation_v1_address_proto protoreflect.FileDescriptor

File_google_maps_addressvalidation_v1_address_validation_service_proto

var File_google_maps_addressvalidation_v1_address_validation_service_proto protoreflect.FileDescriptor

File_google_maps_addressvalidation_v1_geocode_proto

var File_google_maps_addressvalidation_v1_geocode_proto protoreflect.FileDescriptor

File_google_maps_addressvalidation_v1_metadata_proto

var File_google_maps_addressvalidation_v1_metadata_proto protoreflect.FileDescriptor

File_google_maps_addressvalidation_v1_usps_data_proto

var File_google_maps_addressvalidation_v1_usps_data_proto protoreflect.FileDescriptor

Functions

func RegisterAddressValidationServer

func RegisterAddressValidationServer(s *grpc.Server, srv AddressValidationServer)

Address

type Address struct {
	FormattedAddress string `protobuf:"bytes,2,opt,name=formatted_address,json=formattedAddress,proto3" json:"formatted_address,omitempty"`

	PostalAddress *postaladdress.PostalAddress `protobuf:"bytes,3,opt,name=postal_address,json=postalAddress,proto3" json:"postal_address,omitempty"`

	AddressComponents []*AddressComponent `protobuf:"bytes,4,rep,name=address_components,json=addressComponents,proto3" json:"address_components,omitempty"`

	MissingComponentTypes []string `protobuf:"bytes,5,rep,name=missing_component_types,json=missingComponentTypes,proto3" json:"missing_component_types,omitempty"`

	UnconfirmedComponentTypes []string "" /* 138 byte string literal not displayed */

	UnresolvedTokens []string `protobuf:"bytes,7,rep,name=unresolved_tokens,json=unresolvedTokens,proto3" json:"unresolved_tokens,omitempty"`

}

Details of the address parsed from the input.

func (*Address) Descriptor

func (*Address) Descriptor() ([]byte, []int)

Deprecated: Use Address.ProtoReflect.Descriptor instead.

func (*Address) GetAddressComponents

func (x *Address) GetAddressComponents() []*AddressComponent

func (*Address) GetFormattedAddress

func (x *Address) GetFormattedAddress() string

func (*Address) GetMissingComponentTypes

func (x *Address) GetMissingComponentTypes() []string

func (*Address) GetPostalAddress

func (x *Address) GetPostalAddress() *postaladdress.PostalAddress

func (*Address) GetUnconfirmedComponentTypes

func (x *Address) GetUnconfirmedComponentTypes() []string

func (*Address) GetUnresolvedTokens

func (x *Address) GetUnresolvedTokens() []string

func (*Address) ProtoMessage

func (*Address) ProtoMessage()

func (*Address) ProtoReflect

func (x *Address) ProtoReflect() protoreflect.Message

func (*Address) Reset

func (x *Address) Reset()

func (*Address) String

func (x *Address) String() string

AddressComponent

type AddressComponent struct {
	ComponentName *ComponentName `protobuf:"bytes,1,opt,name=component_name,json=componentName,proto3" json:"component_name,omitempty"`

	ComponentType string `protobuf:"bytes,2,opt,name=component_type,json=componentType,proto3" json:"component_type,omitempty"`

	ConfirmationLevel AddressComponent_ConfirmationLevel "" /* 186 byte string literal not displayed */

	Inferred bool `protobuf:"varint,4,opt,name=inferred,proto3" json:"inferred,omitempty"`

	SpellCorrected bool `protobuf:"varint,5,opt,name=spell_corrected,json=spellCorrected,proto3" json:"spell_corrected,omitempty"`

	Replaced bool `protobuf:"varint,6,opt,name=replaced,proto3" json:"replaced,omitempty"`

	Unexpected bool `protobuf:"varint,7,opt,name=unexpected,proto3" json:"unexpected,omitempty"`

}

Represents an address component, such as a street, city, or state.

func (*AddressComponent) Descriptor

func (*AddressComponent) Descriptor() ([]byte, []int)

Deprecated: Use AddressComponent.ProtoReflect.Descriptor instead.

func (*AddressComponent) GetComponentName

func (x *AddressComponent) GetComponentName() *ComponentName

func (*AddressComponent) GetComponentType

func (x *AddressComponent) GetComponentType() string

func (*AddressComponent) GetConfirmationLevel

func (x *AddressComponent) GetConfirmationLevel() AddressComponent_ConfirmationLevel

func (*AddressComponent) GetInferred

func (x *AddressComponent) GetInferred() bool

func (*AddressComponent) GetReplaced

func (x *AddressComponent) GetReplaced() bool

func (*AddressComponent) GetSpellCorrected

func (x *AddressComponent) GetSpellCorrected() bool

func (*AddressComponent) GetUnexpected

func (x *AddressComponent) GetUnexpected() bool

func (*AddressComponent) ProtoMessage

func (*AddressComponent) ProtoMessage()

func (*AddressComponent) ProtoReflect

func (x *AddressComponent) ProtoReflect() protoreflect.Message

func (*AddressComponent) Reset

func (x *AddressComponent) Reset()

func (*AddressComponent) String

func (x *AddressComponent) String() string

AddressComponent_ConfirmationLevel

type AddressComponent_ConfirmationLevel int32

The different possible values for confirmation levels.

AddressComponent_CONFIRMATION_LEVEL_UNSPECIFIED, AddressComponent_CONFIRMED, AddressComponent_UNCONFIRMED_BUT_PLAUSIBLE, AddressComponent_UNCONFIRMED_AND_SUSPICIOUS

const (
	// Default value. This value is unused.
	AddressComponent_CONFIRMATION_LEVEL_UNSPECIFIED AddressComponent_ConfirmationLevel = 0
	// We were able to verify that this component exists and makes sense in the
	// context of the rest of the address.
	AddressComponent_CONFIRMED AddressComponent_ConfirmationLevel = 1
	// This component could not be confirmed, but it is plausible that it
	// exists. For example, a street number within a known valid range of
	// numbers on a street where specific house numbers are not known.
	AddressComponent_UNCONFIRMED_BUT_PLAUSIBLE AddressComponent_ConfirmationLevel = 2
	// This component was not confirmed and is likely to be wrong. For
	// example, a neighborhood that does not fit the rest of the address.
	AddressComponent_UNCONFIRMED_AND_SUSPICIOUS AddressComponent_ConfirmationLevel = 3
)

func (AddressComponent_ConfirmationLevel) Descriptor

func (AddressComponent_ConfirmationLevel) Enum

func (AddressComponent_ConfirmationLevel) EnumDescriptor

func (AddressComponent_ConfirmationLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use AddressComponent_ConfirmationLevel.Descriptor instead.

func (AddressComponent_ConfirmationLevel) Number

func (AddressComponent_ConfirmationLevel) String

func (AddressComponent_ConfirmationLevel) Type

AddressMetadata

type AddressMetadata struct {

	// Indicates that this is the address of a business.
	// If unset, indicates that the value is unknown.
	Business *bool `protobuf:"varint,2,opt,name=business,proto3,oneof" json:"business,omitempty"`
	// Indicates that the address of a PO box.
	// If unset, indicates that the value is unknown.
	PoBox *bool `protobuf:"varint,3,opt,name=po_box,json=poBox,proto3,oneof" json:"po_box,omitempty"`
	// Indicates that this is the address of a residence.
	// If unset, indicates that the value is unknown.
	Residential *bool `protobuf:"varint,6,opt,name=residential,proto3,oneof" json:"residential,omitempty"`
	// contains filtered or unexported fields
}

The metadata for the address.

func (*AddressMetadata) Descriptor

func (*AddressMetadata) Descriptor() ([]byte, []int)

Deprecated: Use AddressMetadata.ProtoReflect.Descriptor instead.

func (*AddressMetadata) GetBusiness

func (x *AddressMetadata) GetBusiness() bool

func (*AddressMetadata) GetPoBox

func (x *AddressMetadata) GetPoBox() bool

func (*AddressMetadata) GetResidential

func (x *AddressMetadata) GetResidential() bool

func (*AddressMetadata) ProtoMessage

func (*AddressMetadata) ProtoMessage()

func (*AddressMetadata) ProtoReflect

func (x *AddressMetadata) ProtoReflect() protoreflect.Message

func (*AddressMetadata) Reset

func (x *AddressMetadata) Reset()

func (*AddressMetadata) String

func (x *AddressMetadata) String() string

AddressValidationClient

type AddressValidationClient interface {
	// Validates an address.
	ValidateAddress(ctx context.Context, in *ValidateAddressRequest, opts ...grpc.CallOption) (*ValidateAddressResponse, error)
	// Feedback about the outcome of the sequence of validation attempts. This
	// should be the last call made after a sequence of validation calls for the
	// same address, and should be called once the transaction is concluded. This
	// should only be sent once for the sequence of `ValidateAddress` requests
	// needed to validate an address fully.
	ProvideValidationFeedback(ctx context.Context, in *ProvideValidationFeedbackRequest, opts ...grpc.CallOption) (*ProvideValidationFeedbackResponse, error)
}

AddressValidationClient is the client API for AddressValidation service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAddressValidationClient

func NewAddressValidationClient(cc grpc.ClientConnInterface) AddressValidationClient

AddressValidationServer

type AddressValidationServer interface {
	// Validates an address.
	ValidateAddress(context.Context, *ValidateAddressRequest) (*ValidateAddressResponse, error)
	// Feedback about the outcome of the sequence of validation attempts. This
	// should be the last call made after a sequence of validation calls for the
	// same address, and should be called once the transaction is concluded. This
	// should only be sent once for the sequence of `ValidateAddress` requests
	// needed to validate an address fully.
	ProvideValidationFeedback(context.Context, *ProvideValidationFeedbackRequest) (*ProvideValidationFeedbackResponse, error)
}

AddressValidationServer is the server API for AddressValidation service.

ComponentName

type ComponentName struct {

	// The name text. For example, "5th Avenue" for a street name or "1253" for a
	// street number.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// The BCP-47 language code. This will not be present if the component name is
	// not associated with a language, such as a street number.
	LanguageCode string `protobuf:"bytes,2,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// contains filtered or unexported fields
}

A wrapper for the name of the component.

func (*ComponentName) Descriptor

func (*ComponentName) Descriptor() ([]byte, []int)

Deprecated: Use ComponentName.ProtoReflect.Descriptor instead.

func (*ComponentName) GetLanguageCode

func (x *ComponentName) GetLanguageCode() string

func (*ComponentName) GetText

func (x *ComponentName) GetText() string

func (*ComponentName) ProtoMessage

func (*ComponentName) ProtoMessage()

func (*ComponentName) ProtoReflect

func (x *ComponentName) ProtoReflect() protoreflect.Message

func (*ComponentName) Reset

func (x *ComponentName) Reset()

func (*ComponentName) String

func (x *ComponentName) String() string

Geocode

type Geocode struct {

	// The geocoded location of the input.
	//
	// Using place IDs is preferred over using addresses,
	// latitude/longitude coordinates, or plus codes. Using coordinates when
	// routing or calculating driving directions will always result in the point
	// being snapped to the road nearest to those coordinates. This may not be a
	// road that will quickly or safely lead to the destination and may not be
	// near an access point to the property. Additionally, when a location is
	// reverse geocoded, there is no guarantee that the returned address will
	// match the original.
	Location *latlng.LatLng `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// The plus code corresponding to the `location`.
	PlusCode *PlusCode `protobuf:"bytes,2,opt,name=plus_code,json=plusCode,proto3" json:"plus_code,omitempty"`
	// The bounds of the geocoded place.
	Bounds *viewport.Viewport `protobuf:"bytes,4,opt,name=bounds,proto3" json:"bounds,omitempty"`
	// The size of the geocoded place, in meters. This is another measure of the
	// coarseness of the geocoded location, but in physical size rather than in
	// semantic meaning.
	FeatureSizeMeters float32 `protobuf:"fixed32,5,opt,name=feature_size_meters,json=featureSizeMeters,proto3" json:"feature_size_meters,omitempty"`
	// The PlaceID of the place this input geocodes to.
	//
	// For more information about Place IDs see
	// [here](https://developers.google.com/maps/documentation/places/web-service/place-id).
	PlaceId string `protobuf:"bytes,6,opt,name=place_id,json=placeId,proto3" json:"place_id,omitempty"`
	// The type(s) of place that the input geocoded to. For example,
	// `['locality', 'political']`. The full list of types can be found
	// [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
	PlaceTypes []string `protobuf:"bytes,7,rep,name=place_types,json=placeTypes,proto3" json:"place_types,omitempty"`
	// contains filtered or unexported fields
}

Contains information about the place the input was geocoded to.

func (*Geocode) Descriptor

func (*Geocode) Descriptor() ([]byte, []int)

Deprecated: Use Geocode.ProtoReflect.Descriptor instead.

func (*Geocode) GetBounds

func (x *Geocode) GetBounds() *viewport.Viewport

func (*Geocode) GetFeatureSizeMeters

func (x *Geocode) GetFeatureSizeMeters() float32

func (*Geocode) GetLocation

func (x *Geocode) GetLocation() *latlng.LatLng

func (*Geocode) GetPlaceId

func (x *Geocode) GetPlaceId() string

func (*Geocode) GetPlaceTypes

func (x *Geocode) GetPlaceTypes() []string

func (*Geocode) GetPlusCode

func (x *Geocode) GetPlusCode() *PlusCode

func (*Geocode) ProtoMessage

func (*Geocode) ProtoMessage()

func (*Geocode) ProtoReflect

func (x *Geocode) ProtoReflect() protoreflect.Message

func (*Geocode) Reset

func (x *Geocode) Reset()

func (*Geocode) String

func (x *Geocode) String() string

PlusCode

type PlusCode struct {

	// Place's global (full) code, such as "9FWM33GV+HQ", representing an
	// 1/8000 by 1/8000 degree area (~14 by 14 meters).
	GlobalCode string `protobuf:"bytes,1,opt,name=global_code,json=globalCode,proto3" json:"global_code,omitempty"`
	// Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing
	// the suffix of the global code and replacing the prefix with a formatted
	// name of a reference entity.
	CompoundCode string `protobuf:"bytes,2,opt,name=compound_code,json=compoundCode,proto3" json:"compound_code,omitempty"`
	// contains filtered or unexported fields
}

Plus code (http://plus.codes) is a location reference with two formats: global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle, and compound code, replacing the prefix with a reference location.

func (*PlusCode) Descriptor

func (*PlusCode) Descriptor() ([]byte, []int)

Deprecated: Use PlusCode.ProtoReflect.Descriptor instead.

func (*PlusCode) GetCompoundCode

func (x *PlusCode) GetCompoundCode() string

func (*PlusCode) GetGlobalCode

func (x *PlusCode) GetGlobalCode() string

func (*PlusCode) ProtoMessage

func (*PlusCode) ProtoMessage()

func (*PlusCode) ProtoReflect

func (x *PlusCode) ProtoReflect() protoreflect.Message

func (*PlusCode) Reset

func (x *PlusCode) Reset()

func (*PlusCode) String

func (x *PlusCode) String() string

ProvideValidationFeedbackRequest

type ProvideValidationFeedbackRequest struct {
	Conclusion ProvideValidationFeedbackRequest_ValidationConclusion "" /* 166 byte string literal not displayed */

	ResponseId string `protobuf:"bytes,2,opt,name=response_id,json=responseId,proto3" json:"response_id,omitempty"`

}

The request for sending validation feedback.

func (*ProvideValidationFeedbackRequest) Descriptor

func (*ProvideValidationFeedbackRequest) Descriptor() ([]byte, []int)

Deprecated: Use ProvideValidationFeedbackRequest.ProtoReflect.Descriptor instead.

func (*ProvideValidationFeedbackRequest) GetConclusion

func (*ProvideValidationFeedbackRequest) GetResponseId

func (x *ProvideValidationFeedbackRequest) GetResponseId() string

func (*ProvideValidationFeedbackRequest) ProtoMessage

func (*ProvideValidationFeedbackRequest) ProtoMessage()

func (*ProvideValidationFeedbackRequest) ProtoReflect

func (*ProvideValidationFeedbackRequest) Reset

func (*ProvideValidationFeedbackRequest) String

ProvideValidationFeedbackRequest_ValidationConclusion

type ProvideValidationFeedbackRequest_ValidationConclusion int32

The possible final outcomes of the sequence of address validation requests needed to validate an address.

ProvideValidationFeedbackRequest_VALIDATION_CONCLUSION_UNSPECIFIED, ProvideValidationFeedbackRequest_VALIDATED_VERSION_USED, ProvideValidationFeedbackRequest_USER_VERSION_USED, ProvideValidationFeedbackRequest_UNVALIDATED_VERSION_USED, ProvideValidationFeedbackRequest_UNUSED

const (
	// This value is unused.
	// If the `ProvideValidationFeedbackRequest.conclusion` field is set to
	// `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error will be
	// returned.
	ProvideValidationFeedbackRequest_VALIDATION_CONCLUSION_UNSPECIFIED ProvideValidationFeedbackRequest_ValidationConclusion = 0
	// The version of the address returned by the Address Validation API was
	// used for the transaction.
	ProvideValidationFeedbackRequest_VALIDATED_VERSION_USED ProvideValidationFeedbackRequest_ValidationConclusion = 1
	// The version of the address provided by the user was used for the
	// transaction
	ProvideValidationFeedbackRequest_USER_VERSION_USED ProvideValidationFeedbackRequest_ValidationConclusion = 2
	// A version of the address that was entered after the last validation
	// attempt but that was not re-validated was used for the transaction.
	ProvideValidationFeedbackRequest_UNVALIDATED_VERSION_USED ProvideValidationFeedbackRequest_ValidationConclusion = 3
	// The transaction was abandoned and the address was not used.
	ProvideValidationFeedbackRequest_UNUSED ProvideValidationFeedbackRequest_ValidationConclusion = 4
)

func (ProvideValidationFeedbackRequest_ValidationConclusion) Descriptor

func (ProvideValidationFeedbackRequest_ValidationConclusion) Enum

func (ProvideValidationFeedbackRequest_ValidationConclusion) EnumDescriptor

Deprecated: Use ProvideValidationFeedbackRequest_ValidationConclusion.Descriptor instead.

func (ProvideValidationFeedbackRequest_ValidationConclusion) Number

func (ProvideValidationFeedbackRequest_ValidationConclusion) String

func (ProvideValidationFeedbackRequest_ValidationConclusion) Type

ProvideValidationFeedbackResponse

type ProvideValidationFeedbackResponse struct {
	// contains filtered or unexported fields
}

The response for validation feedback.

The response is empty if the feedback is sent successfully.

func (*ProvideValidationFeedbackResponse) Descriptor

func (*ProvideValidationFeedbackResponse) Descriptor() ([]byte, []int)

Deprecated: Use ProvideValidationFeedbackResponse.ProtoReflect.Descriptor instead.

func (*ProvideValidationFeedbackResponse) ProtoMessage

func (*ProvideValidationFeedbackResponse) ProtoMessage()

func (*ProvideValidationFeedbackResponse) ProtoReflect

func (*ProvideValidationFeedbackResponse) Reset

func (*ProvideValidationFeedbackResponse) String

UnimplementedAddressValidationServer

type UnimplementedAddressValidationServer struct {
}

UnimplementedAddressValidationServer can be embedded to have forward compatible implementations.

func (*UnimplementedAddressValidationServer) ProvideValidationFeedback

func (*UnimplementedAddressValidationServer) ValidateAddress

UspsAddress

type UspsAddress struct {
	FirstAddressLine string `protobuf:"bytes,1,opt,name=first_address_line,json=firstAddressLine,proto3" json:"first_address_line,omitempty"`

	Firm string `protobuf:"bytes,2,opt,name=firm,proto3" json:"firm,omitempty"`

	SecondAddressLine string `protobuf:"bytes,3,opt,name=second_address_line,json=secondAddressLine,proto3" json:"second_address_line,omitempty"`

	Urbanization string `protobuf:"bytes,4,opt,name=urbanization,proto3" json:"urbanization,omitempty"`

	CityStateZipAddressLine string "" /* 136 byte string literal not displayed */

	City string `protobuf:"bytes,6,opt,name=city,proto3" json:"city,omitempty"`

	State string `protobuf:"bytes,7,opt,name=state,proto3" json:"state,omitempty"`

	ZipCode string `protobuf:"bytes,8,opt,name=zip_code,json=zipCode,proto3" json:"zip_code,omitempty"`

	ZipCodeExtension string `protobuf:"bytes,9,opt,name=zip_code_extension,json=zipCodeExtension,proto3" json:"zip_code_extension,omitempty"`

}

USPS representation of a US address.

func (*UspsAddress) Descriptor

func (*UspsAddress) Descriptor() ([]byte, []int)

Deprecated: Use UspsAddress.ProtoReflect.Descriptor instead.

func (*UspsAddress) GetCity

func (x *UspsAddress) GetCity() string

func (*UspsAddress) GetCityStateZipAddressLine

func (x *UspsAddress) GetCityStateZipAddressLine() string

func (*UspsAddress) GetFirm

func (x *UspsAddress) GetFirm() string

func (*UspsAddress) GetFirstAddressLine

func (x *UspsAddress) GetFirstAddressLine() string

func (*UspsAddress) GetSecondAddressLine

func (x *UspsAddress) GetSecondAddressLine() string

func (*UspsAddress) GetState

func (x *UspsAddress) GetState() string

func (*UspsAddress) GetUrbanization

func (x *UspsAddress) GetUrbanization() string

func (*UspsAddress) GetZipCode

func (x *UspsAddress) GetZipCode() string

func (*UspsAddress) GetZipCodeExtension

func (x *UspsAddress) GetZipCodeExtension() string

func (*UspsAddress) ProtoMessage

func (*UspsAddress) ProtoMessage()

func (*UspsAddress) ProtoReflect

func (x *UspsAddress) ProtoReflect() protoreflect.Message

func (*UspsAddress) Reset

func (x *UspsAddress) Reset()

func (*UspsAddress) String

func (x *UspsAddress) String() string

UspsData

type UspsData struct {
	StandardizedAddress *UspsAddress `protobuf:"bytes,1,opt,name=standardized_address,json=standardizedAddress,proto3" json:"standardized_address,omitempty"`

	DeliveryPointCode string `protobuf:"bytes,2,opt,name=delivery_point_code,json=deliveryPointCode,proto3" json:"delivery_point_code,omitempty"`

	DeliveryPointCheckDigit string "" /* 134 byte string literal not displayed */

	DpvConfirmation string `protobuf:"bytes,4,opt,name=dpv_confirmation,json=dpvConfirmation,proto3" json:"dpv_confirmation,omitempty"`

	DpvFootnote string `protobuf:"bytes,5,opt,name=dpv_footnote,json=dpvFootnote,proto3" json:"dpv_footnote,omitempty"`

	DpvCmra string `protobuf:"bytes,6,opt,name=dpv_cmra,json=dpvCmra,proto3" json:"dpv_cmra,omitempty"`

	DpvVacant string `protobuf:"bytes,7,opt,name=dpv_vacant,json=dpvVacant,proto3" json:"dpv_vacant,omitempty"`

	DpvNoStat string `protobuf:"bytes,8,opt,name=dpv_no_stat,json=dpvNoStat,proto3" json:"dpv_no_stat,omitempty"`

	CarrierRoute string `protobuf:"bytes,9,opt,name=carrier_route,json=carrierRoute,proto3" json:"carrier_route,omitempty"`

	CarrierRouteIndicator string "" /* 127 byte string literal not displayed */

	EwsNoMatch bool `protobuf:"varint,11,opt,name=ews_no_match,json=ewsNoMatch,proto3" json:"ews_no_match,omitempty"`

	PostOfficeCity string `protobuf:"bytes,12,opt,name=post_office_city,json=postOfficeCity,proto3" json:"post_office_city,omitempty"`

	PostOfficeState string `protobuf:"bytes,13,opt,name=post_office_state,json=postOfficeState,proto3" json:"post_office_state,omitempty"`

	AbbreviatedCity string `protobuf:"bytes,14,opt,name=abbreviated_city,json=abbreviatedCity,proto3" json:"abbreviated_city,omitempty"`

	FipsCountyCode string `protobuf:"bytes,15,opt,name=fips_county_code,json=fipsCountyCode,proto3" json:"fips_county_code,omitempty"`

	County string `protobuf:"bytes,16,opt,name=county,proto3" json:"county,omitempty"`

	ElotNumber string `protobuf:"bytes,17,opt,name=elot_number,json=elotNumber,proto3" json:"elot_number,omitempty"`

	ElotFlag string `protobuf:"bytes,18,opt,name=elot_flag,json=elotFlag,proto3" json:"elot_flag,omitempty"`

	LacsLinkReturnCode string `protobuf:"bytes,19,opt,name=lacs_link_return_code,json=lacsLinkReturnCode,proto3" json:"lacs_link_return_code,omitempty"`

	LacsLinkIndicator string `protobuf:"bytes,20,opt,name=lacs_link_indicator,json=lacsLinkIndicator,proto3" json:"lacs_link_indicator,omitempty"`

	PoBoxOnlyPostalCode bool `protobuf:"varint,21,opt,name=po_box_only_postal_code,json=poBoxOnlyPostalCode,proto3" json:"po_box_only_postal_code,omitempty"`

	SuitelinkFootnote string `protobuf:"bytes,22,opt,name=suitelink_footnote,json=suitelinkFootnote,proto3" json:"suitelink_footnote,omitempty"`

	PmbDesignator string `protobuf:"bytes,23,opt,name=pmb_designator,json=pmbDesignator,proto3" json:"pmb_designator,omitempty"`

	PmbNumber string `protobuf:"bytes,24,opt,name=pmb_number,json=pmbNumber,proto3" json:"pmb_number,omitempty"`

	AddressRecordType string `protobuf:"bytes,25,opt,name=address_record_type,json=addressRecordType,proto3" json:"address_record_type,omitempty"`

	DefaultAddress bool `protobuf:"varint,26,opt,name=default_address,json=defaultAddress,proto3" json:"default_address,omitempty"`

	ErrorMessage string `protobuf:"bytes,27,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`

	CassProcessed bool `protobuf:"varint,28,opt,name=cass_processed,json=cassProcessed,proto3" json:"cass_processed,omitempty"`

}

The USPS data for the address.

func (*UspsData) Descriptor

func (*UspsData) Descriptor() ([]byte, []int)

Deprecated: Use UspsData.ProtoReflect.Descriptor instead.

func (*UspsData) GetAbbreviatedCity

func (x *UspsData) GetAbbreviatedCity() string

func (*UspsData) GetAddressRecordType

func (x *UspsData) GetAddressRecordType() string

func (*UspsData) GetCarrierRoute

func (x *UspsData) GetCarrierRoute() string

func (*UspsData) GetCarrierRouteIndicator

func (x *UspsData) GetCarrierRouteIndicator() string

func (*UspsData) GetCassProcessed

func (x *UspsData) GetCassProcessed() bool

func (*UspsData) GetCounty

func (x *UspsData) GetCounty() string

func (*UspsData) GetDefaultAddress

func (x *UspsData) GetDefaultAddress() bool

func (*UspsData) GetDeliveryPointCheckDigit

func (x *UspsData) GetDeliveryPointCheckDigit() string

func (*UspsData) GetDeliveryPointCode

func (x *UspsData) GetDeliveryPointCode() string

func (*UspsData) GetDpvCmra

func (x *UspsData) GetDpvCmra() string

func (*UspsData) GetDpvConfirmation

func (x *UspsData) GetDpvConfirmation() string

func (*UspsData) GetDpvFootnote

func (x *UspsData) GetDpvFootnote() string

func (*UspsData) GetDpvNoStat

func (x *UspsData) GetDpvNoStat() string

func (*UspsData) GetDpvVacant

func (x *UspsData) GetDpvVacant() string

func (*UspsData) GetElotFlag

func (x *UspsData) GetElotFlag() string

func (*UspsData) GetElotNumber

func (x *UspsData) GetElotNumber() string

func (*UspsData) GetErrorMessage

func (x *UspsData) GetErrorMessage() string

func (*UspsData) GetEwsNoMatch

func (x *UspsData) GetEwsNoMatch() bool

func (*UspsData) GetFipsCountyCode

func (x *UspsData) GetFipsCountyCode() string

func (*UspsData) GetLacsLinkIndicator

func (x *UspsData) GetLacsLinkIndicator() string

func (*UspsData) GetLacsLinkReturnCode

func (x *UspsData) GetLacsLinkReturnCode() string

func (*UspsData) GetPmbDesignator

func (x *UspsData) GetPmbDesignator() string

func (*UspsData) GetPmbNumber

func (x *UspsData) GetPmbNumber() string

func (*UspsData) GetPoBoxOnlyPostalCode

func (x *UspsData) GetPoBoxOnlyPostalCode() bool

func (*UspsData) GetPostOfficeCity

func (x *UspsData) GetPostOfficeCity() string

func (*UspsData) GetPostOfficeState

func (x *UspsData) GetPostOfficeState() string

func (*UspsData) GetStandardizedAddress

func (x *UspsData) GetStandardizedAddress() *UspsAddress

func (*UspsData) GetSuitelinkFootnote

func (x *UspsData) GetSuitelinkFootnote() string

func (*UspsData) ProtoMessage

func (*UspsData) ProtoMessage()

func (*UspsData) ProtoReflect

func (x *UspsData) ProtoReflect() protoreflect.Message

func (*UspsData) Reset

func (x *UspsData) Reset()

func (*UspsData) String

func (x *UspsData) String() string

ValidateAddressRequest

type ValidateAddressRequest struct {

	// 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.
	Address *postaladdress.PostalAddress `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// 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.
	PreviousResponseId string `protobuf:"bytes,2,opt,name=previous_response_id,json=previousResponseId,proto3" json:"previous_response_id,omitempty"`
	// 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.
	EnableUspsCass bool `protobuf:"varint,3,opt,name=enable_usps_cass,json=enableUspsCass,proto3" json:"enable_usps_cass,omitempty"`
	// contains filtered or unexported fields
}

The request for validating an address.

func (*ValidateAddressRequest) Descriptor

func (*ValidateAddressRequest) Descriptor() ([]byte, []int)

Deprecated: Use ValidateAddressRequest.ProtoReflect.Descriptor instead.

func (*ValidateAddressRequest) GetAddress

func (*ValidateAddressRequest) GetEnableUspsCass

func (x *ValidateAddressRequest) GetEnableUspsCass() bool

func (*ValidateAddressRequest) GetPreviousResponseId

func (x *ValidateAddressRequest) GetPreviousResponseId() string

func (*ValidateAddressRequest) ProtoMessage

func (*ValidateAddressRequest) ProtoMessage()

func (*ValidateAddressRequest) ProtoReflect

func (x *ValidateAddressRequest) ProtoReflect() protoreflect.Message

func (*ValidateAddressRequest) Reset

func (x *ValidateAddressRequest) Reset()

func (*ValidateAddressRequest) String

func (x *ValidateAddressRequest) String() string

ValidateAddressResponse

type ValidateAddressResponse struct {

	// The result of the address validation.
	Result *ValidationResult `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	// The UUID that identifies this response. If the address needs to be
	// re-validated, this UUID *must* accompany the new request.
	ResponseId string `protobuf:"bytes,2,opt,name=response_id,json=responseId,proto3" json:"response_id,omitempty"`
	// contains filtered or unexported fields
}

The response to an address validation request.

func (*ValidateAddressResponse) Descriptor

func (*ValidateAddressResponse) Descriptor() ([]byte, []int)

Deprecated: Use ValidateAddressResponse.ProtoReflect.Descriptor instead.

func (*ValidateAddressResponse) GetResponseId

func (x *ValidateAddressResponse) GetResponseId() string

func (*ValidateAddressResponse) GetResult

func (x *ValidateAddressResponse) GetResult() *ValidationResult

func (*ValidateAddressResponse) ProtoMessage

func (*ValidateAddressResponse) ProtoMessage()

func (*ValidateAddressResponse) ProtoReflect

func (x *ValidateAddressResponse) ProtoReflect() protoreflect.Message

func (*ValidateAddressResponse) Reset

func (x *ValidateAddressResponse) Reset()

func (*ValidateAddressResponse) String

func (x *ValidateAddressResponse) String() string

ValidationResult

type ValidationResult struct {

	// Overall verdict flags
	Verdict *Verdict `protobuf:"bytes,1,opt,name=verdict,proto3" json:"verdict,omitempty"`
	// Information about the address itself as opposed to the geocode.
	Address *Address `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// Information about the location and place that the address geocoded to.
	Geocode *Geocode `protobuf:"bytes,3,opt,name=geocode,proto3" json:"geocode,omitempty"`
	// Other information relevant to deliverability.
	Metadata *AddressMetadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Extra deliverability flags provided by USPS. Only provided in region `US`
	// and `PR`.
	UspsData *UspsData `protobuf:"bytes,5,opt,name=usps_data,json=uspsData,proto3" json:"usps_data,omitempty"`
	// contains filtered or unexported fields
}

The result of validating an address.

func (*ValidationResult) Descriptor

func (*ValidationResult) Descriptor() ([]byte, []int)

Deprecated: Use ValidationResult.ProtoReflect.Descriptor instead.

func (*ValidationResult) GetAddress

func (x *ValidationResult) GetAddress() *Address

func (*ValidationResult) GetGeocode

func (x *ValidationResult) GetGeocode() *Geocode

func (*ValidationResult) GetMetadata

func (x *ValidationResult) GetMetadata() *AddressMetadata

func (*ValidationResult) GetUspsData

func (x *ValidationResult) GetUspsData() *UspsData

func (*ValidationResult) GetVerdict

func (x *ValidationResult) GetVerdict() *Verdict

func (*ValidationResult) ProtoMessage

func (*ValidationResult) ProtoMessage()

func (*ValidationResult) ProtoReflect

func (x *ValidationResult) ProtoReflect() protoreflect.Message

func (*ValidationResult) Reset

func (x *ValidationResult) Reset()

func (*ValidationResult) String

func (x *ValidationResult) String() string

Verdict

type Verdict struct {
	InputGranularity Verdict_Granularity "" /* 168 byte string literal not displayed */

	ValidationGranularity Verdict_Granularity "" /* 183 byte string literal not displayed */

	GeocodeGranularity Verdict_Granularity "" /* 174 byte string literal not displayed */

	AddressComplete bool `protobuf:"varint,4,opt,name=address_complete,json=addressComplete,proto3" json:"address_complete,omitempty"`

	HasUnconfirmedComponents bool "" /* 136 byte string literal not displayed */

	HasInferredComponents bool "" /* 127 byte string literal not displayed */

	HasReplacedComponents bool "" /* 127 byte string literal not displayed */

}

High level overview of the address validation result and geocode.

func (*Verdict) Descriptor

func (*Verdict) Descriptor() ([]byte, []int)

Deprecated: Use Verdict.ProtoReflect.Descriptor instead.

func (*Verdict) GetAddressComplete

func (x *Verdict) GetAddressComplete() bool

func (*Verdict) GetGeocodeGranularity

func (x *Verdict) GetGeocodeGranularity() Verdict_Granularity

func (*Verdict) GetHasInferredComponents

func (x *Verdict) GetHasInferredComponents() bool

func (*Verdict) GetHasReplacedComponents

func (x *Verdict) GetHasReplacedComponents() bool

func (*Verdict) GetHasUnconfirmedComponents

func (x *Verdict) GetHasUnconfirmedComponents() bool

func (*Verdict) GetInputGranularity

func (x *Verdict) GetInputGranularity() Verdict_Granularity

func (*Verdict) GetValidationGranularity

func (x *Verdict) GetValidationGranularity() Verdict_Granularity

func (*Verdict) ProtoMessage

func (*Verdict) ProtoMessage()

func (*Verdict) ProtoReflect

func (x *Verdict) ProtoReflect() protoreflect.Message

func (*Verdict) Reset

func (x *Verdict) Reset()

func (*Verdict) String

func (x *Verdict) String() string

Verdict_Granularity

type Verdict_Granularity int32

The various granularities that an address or a geocode can have. When used to indicate granularity for an address, these values indicate with how fine a granularity the address identifies a mailing destination. For example, an address such as "123 Main Street, Redwood City, CA, 94061" identifies a PREMISE while something like "Redwood City, CA, 94061" identifies a LOCALITY. However, if we are unable to find a geocode for "123 Main Street" in Redwood City, the geocode returned might be of LOCALITY granularity even though the address is more granular.

Verdict_GRANULARITY_UNSPECIFIED, Verdict_SUB_PREMISE, Verdict_PREMISE, Verdict_PREMISE_PROXIMITY, Verdict_BLOCK, Verdict_ROUTE, Verdict_OTHER

const (
	// Default value. This value is unused.
	Verdict_GRANULARITY_UNSPECIFIED Verdict_Granularity = 0
	// Below-building level result, such as an apartment.
	Verdict_SUB_PREMISE Verdict_Granularity = 1
	// Building-level result.
	Verdict_PREMISE Verdict_Granularity = 2
	// A geocode that should be very close to the building-level location of
	// the address. Only used for geocodes and not for addresses.
	Verdict_PREMISE_PROXIMITY Verdict_Granularity = 3
	// The address or geocode indicates a block. Only used in regions which
	// have block-level addressing, such as Japan.
	Verdict_BLOCK Verdict_Granularity = 4
	// The geocode or address is granular to route, such as a street, road, or
	// highway.
	Verdict_ROUTE Verdict_Granularity = 5
	// All other granularities, which are bucketed together since they are not
	// deliverable.
	Verdict_OTHER Verdict_Granularity = 6
)

func (Verdict_Granularity) Descriptor

func (Verdict_Granularity) Enum

func (Verdict_Granularity) EnumDescriptor

func (Verdict_Granularity) EnumDescriptor() ([]byte, []int)

Deprecated: Use Verdict_Granularity.Descriptor instead.

func (Verdict_Granularity) Number

func (Verdict_Granularity) String

func (x Verdict_Granularity) String() string

func (Verdict_Granularity) Type