Class protos.google.maps.places.v1.Place.ContainingPlace (2.4.0)

Represents a ContainingPlace.

Package

@googlemaps/places

Constructors

(constructor)(properties)

constructor(properties?: google.maps.places.v1.Place.IContainingPlace);

Constructs a new ContainingPlace.

Parameter
Name Description
properties IContainingPlace

Properties to set

Properties

id

public id: string;

ContainingPlace id.

name

public name: string;

ContainingPlace name.

Methods

create(properties)

public static create(properties?: google.maps.places.v1.Place.IContainingPlace): google.maps.places.v1.Place.ContainingPlace;

Creates a new ContainingPlace instance using the specified properties.

Parameter
Name Description
properties IContainingPlace

Properties to set

Returns
Type Description
ContainingPlace

ContainingPlace instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.places.v1.Place.ContainingPlace;

Decodes a ContainingPlace message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
ContainingPlace

ContainingPlace

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.places.v1.Place.ContainingPlace;

Decodes a ContainingPlace message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ContainingPlace

ContainingPlace

encode(message, writer)

public static encode(message: google.maps.places.v1.Place.IContainingPlace, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ContainingPlace message. Does not implicitly messages.

Parameters
Name Description
message IContainingPlace

ContainingPlace 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.places.v1.Place.IContainingPlace, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ContainingPlace message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IContainingPlace

ContainingPlace 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.places.v1.Place.ContainingPlace;

Creates a ContainingPlace 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
ContainingPlace

ContainingPlace

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ContainingPlace

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 ContainingPlace to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.maps.places.v1.Place.ContainingPlace, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ContainingPlace message. Also converts values to other types if specified.

Parameters
Name Description
message ContainingPlace

ContainingPlace

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 a ContainingPlace message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not