Represents an AddressComponent.
Package
@googlemaps/addressvalidationConstructors
(constructor)(properties)
constructor(properties?: google.maps.addressvalidation.v1.IAddressComponent);
Constructs a new AddressComponent.
Parameter | |
---|---|
Name | Description |
properties |
IAddressComponent
Properties to set |
Properties
componentName
public componentName?: (google.maps.addressvalidation.v1.IComponentName|null);
AddressComponent componentName.
componentType
public componentType: string;
AddressComponent componentType.
confirmationLevel
public confirmationLevel: (google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel|keyof typeof google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel);
AddressComponent confirmationLevel.
inferred
public inferred: boolean;
AddressComponent inferred.
replaced
public replaced: boolean;
AddressComponent replaced.
spellCorrected
public spellCorrected: boolean;
AddressComponent spellCorrected.
unexpected
public unexpected: boolean;
AddressComponent unexpected.
Methods
create(properties)
public static create(properties?: google.maps.addressvalidation.v1.IAddressComponent): google.maps.addressvalidation.v1.AddressComponent;
Creates a new AddressComponent instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IAddressComponent
Properties to set |
Returns | |
---|---|
Type | Description |
google.maps.addressvalidation.v1.AddressComponent | AddressComponent instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.addressvalidation.v1.AddressComponent;
Decodes an AddressComponent message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
google.maps.addressvalidation.v1.AddressComponent | AddressComponent |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.addressvalidation.v1.AddressComponent;
Decodes an AddressComponent message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
google.maps.addressvalidation.v1.AddressComponent | AddressComponent |
encode(message, writer)
public static encode(message: google.maps.addressvalidation.v1.IAddressComponent, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AddressComponent message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAddressComponent
AddressComponent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.maps.addressvalidation.v1.IAddressComponent, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AddressComponent message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAddressComponent
AddressComponent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.maps.addressvalidation.v1.AddressComponent;
Creates an AddressComponent message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
google.maps.addressvalidation.v1.AddressComponent | AddressComponent |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for AddressComponent
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this AddressComponent to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.maps.addressvalidation.v1.AddressComponent, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an AddressComponent message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
google.maps.addressvalidation.v1.AddressComponent
AddressComponent |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an AddressComponent message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|