Class protos.google.api.serviceusage.v1beta1.QuotaBucket (1.1.4)

Represents a QuotaBucket.

Package

@google-cloud/service-usage!

Constructors

(constructor)(properties)

constructor(properties?: google.api.serviceusage.v1beta1.IQuotaBucket);

Constructs a new QuotaBucket.

Parameter

Name	Description
properties	`IQuotaBucket` Properties to set

Properties

adminOverride

public adminOverride?: (google.api.serviceusage.v1beta1.IQuotaOverride|null);

QuotaBucket adminOverride.

Property Value

Type	Description
(google.api.serviceusage.v1beta1.IQuotaOverride\|null)

consumerOverride

public consumerOverride?: (google.api.serviceusage.v1beta1.IQuotaOverride|null);

QuotaBucket consumerOverride.

Property Value

Type	Description
(google.api.serviceusage.v1beta1.IQuotaOverride\|null)

defaultLimit

public defaultLimit: (number|Long|string);

QuotaBucket defaultLimit.

Property Value

Type	Description
(number\|Long\|string)

dimensions

public dimensions: { [k: string]: string };

QuotaBucket dimensions.

Property Value

Type	Description
{ [k: string]: string }

effectiveLimit

public effectiveLimit: (number|Long|string);

QuotaBucket effectiveLimit.

Property Value

Type	Description
(number\|Long\|string)

producerOverride

public producerOverride?: (google.api.serviceusage.v1beta1.IQuotaOverride|null);

QuotaBucket producerOverride.

Property Value

Type	Description
(google.api.serviceusage.v1beta1.IQuotaOverride\|null)

Methods

create(properties)

public static create(properties?: google.api.serviceusage.v1beta1.IQuotaBucket): google.api.serviceusage.v1beta1.QuotaBucket;

Creates a new QuotaBucket instance using the specified properties.

Parameter

Name	Description
properties	`IQuotaBucket` Properties to set

Returns

Type	Description
google.api.serviceusage.v1beta1.QuotaBucket	QuotaBucket instance

decode(reader, length)

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

Decodes a QuotaBucket 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.api.serviceusage.v1beta1.QuotaBucket	QuotaBucket

decodeDelimited(reader)

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

Decodes a QuotaBucket 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.api.serviceusage.v1beta1.QuotaBucket	QuotaBucket

encode(message, writer)

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

Encodes the specified QuotaBucket message. Does not implicitly messages.

Parameters

Name	Description
message	`IQuotaBucket` QuotaBucket 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.api.serviceusage.v1beta1.IQuotaBucket, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IQuotaBucket` QuotaBucket 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.api.serviceusage.v1beta1.QuotaBucket;

Creates a QuotaBucket 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.api.serviceusage.v1beta1.QuotaBucket	QuotaBucket

toJSON()

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

Converts this QuotaBucket to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.api.serviceusage.v1beta1.QuotaBucket` QuotaBucket
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 QuotaBucket 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