Class protos.google.api.QuotaLimit (3.3.0)

Represents a QuotaLimit.

Package

@google-cloud/service-usage

Constructors

(constructor)(properties)

constructor(properties?: google.api.IQuotaLimit);

Constructs a new QuotaLimit.

Parameter
NameDescription
properties IQuotaLimit

Properties to set

Properties

defaultLimit

public defaultLimit: (number|Long|string);

QuotaLimit defaultLimit.

description

public description: string;

QuotaLimit description.

displayName

public displayName: string;

QuotaLimit displayName.

duration

public duration: string;

QuotaLimit duration.

freeTier

public freeTier: (number|Long|string);

QuotaLimit freeTier.

maxLimit

public maxLimit: (number|Long|string);

QuotaLimit maxLimit.

metric

public metric: string;

QuotaLimit metric.

name

public name: string;

QuotaLimit name.

unit

public unit: string;

QuotaLimit unit.

values

public values: { [k: string]: (number|Long|string) };

QuotaLimit values.

Methods

create(properties)

public static create(properties?: google.api.IQuotaLimit): google.api.QuotaLimit;

Creates a new QuotaLimit instance using the specified properties.

Parameter
NameDescription
properties IQuotaLimit

Properties to set

Returns
TypeDescription
QuotaLimit

QuotaLimit instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.QuotaLimit;

Decodes a QuotaLimit message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
QuotaLimit

QuotaLimit

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.QuotaLimit;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
QuotaLimit

QuotaLimit

encode(message, writer)

public static encode(message: google.api.IQuotaLimit, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified QuotaLimit message. Does not implicitly messages.

Parameters
NameDescription
message IQuotaLimit

QuotaLimit message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.api.IQuotaLimit, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IQuotaLimit

QuotaLimit message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.api.QuotaLimit;

Creates a QuotaLimit message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
QuotaLimit

QuotaLimit

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for QuotaLimit

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this QuotaLimit to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.api.QuotaLimit, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message QuotaLimit

QuotaLimit

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a QuotaLimit message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not