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

Represents a FinancialAnalysis.

Package

@googlemaps/solar

Constructors

(constructor)(properties)

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

Constructs a new FinancialAnalysis.

Parameter
Name Description
properties IFinancialAnalysis

Properties to set

Properties

_panelConfigIndex

public _panelConfigIndex?: "panelConfigIndex";

FinancialAnalysis _panelConfigIndex.

averageKwhPerMonth

public averageKwhPerMonth: number;

FinancialAnalysis averageKwhPerMonth.

cashPurchaseSavings

public cashPurchaseSavings?: (google.maps.solar.v1.ICashPurchaseSavings|null);

FinancialAnalysis cashPurchaseSavings.

defaultBill

public defaultBill: boolean;

FinancialAnalysis defaultBill.

financedPurchaseSavings

public financedPurchaseSavings?: (google.maps.solar.v1.IFinancedPurchaseSavings|null);

FinancialAnalysis financedPurchaseSavings.

financialDetails

public financialDetails?: (google.maps.solar.v1.IFinancialDetails|null);

FinancialAnalysis financialDetails.

leasingSavings

public leasingSavings?: (google.maps.solar.v1.ILeasingSavings|null);

FinancialAnalysis leasingSavings.

monthlyBill

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

FinancialAnalysis monthlyBill.

panelConfigIndex

public panelConfigIndex?: (number|null);

FinancialAnalysis panelConfigIndex.

Methods

create(properties)

public static create(properties?: google.maps.solar.v1.IFinancialAnalysis): google.maps.solar.v1.FinancialAnalysis;

Creates a new FinancialAnalysis instance using the specified properties.

Parameter
Name Description
properties IFinancialAnalysis

Properties to set

Returns
Type Description
FinancialAnalysis

FinancialAnalysis instance

decode(reader, length)

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

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

FinancialAnalysis

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FinancialAnalysis

FinancialAnalysis

encode(message, writer)

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

Encodes the specified FinancialAnalysis message. Does not implicitly messages.

Parameters
Name Description
message IFinancialAnalysis

FinancialAnalysis 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.IFinancialAnalysis, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFinancialAnalysis

FinancialAnalysis 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.FinancialAnalysis;

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

FinancialAnalysis

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FinancialAnalysis

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FinancialAnalysis

FinancialAnalysis

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