Class protos.google.maps.solar.v1.SavingsOverTime (0.1.0)

Represents a SavingsOverTime.

Package

@googlemaps/solar

Constructors

(constructor)(properties)

constructor(properties?: google.maps.solar.v1.ISavingsOverTime);

Constructs a new SavingsOverTime.

Parameter
Name Description
properties ISavingsOverTime

Properties to set

Properties

financiallyViable

public financiallyViable: boolean;

SavingsOverTime financiallyViable.

presentValueOfSavingsLifetime

public presentValueOfSavingsLifetime?: (google.type.IMoney|null);

SavingsOverTime presentValueOfSavingsLifetime.

presentValueOfSavingsYear20

public presentValueOfSavingsYear20?: (google.type.IMoney|null);

SavingsOverTime presentValueOfSavingsYear20.

savingsLifetime

public savingsLifetime?: (google.type.IMoney|null);

SavingsOverTime savingsLifetime.

savingsYear1

public savingsYear1?: (google.type.IMoney|null);

SavingsOverTime savingsYear1.

savingsYear20

public savingsYear20?: (google.type.IMoney|null);

SavingsOverTime savingsYear20.

Methods

create(properties)

public static create(properties?: google.maps.solar.v1.ISavingsOverTime): google.maps.solar.v1.SavingsOverTime;

Creates a new SavingsOverTime instance using the specified properties.

Parameter
Name Description
properties ISavingsOverTime

Properties to set

Returns
Type Description
SavingsOverTime

SavingsOverTime instance

decode(reader, length)

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

Decodes a SavingsOverTime 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
SavingsOverTime

SavingsOverTime

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.solar.v1.SavingsOverTime;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SavingsOverTime

SavingsOverTime

encode(message, writer)

public static encode(message: google.maps.solar.v1.ISavingsOverTime, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SavingsOverTime message. Does not implicitly messages.

Parameters
Name Description
message ISavingsOverTime

SavingsOverTime 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.solar.v1.ISavingsOverTime, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISavingsOverTime

SavingsOverTime 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.solar.v1.SavingsOverTime;

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

SavingsOverTime

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SavingsOverTime

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SavingsOverTime

SavingsOverTime

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 SavingsOverTime 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