Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.api.servicecontrol.v1.QuotaOperation (2.2.0)

Represents a QuotaOperation.

Package

@google-cloud/service-control

Constructors

(constructor)(properties)

constructor(properties?: google.api.servicecontrol.v1.IQuotaOperation);

Constructs a new QuotaOperation.

Parameter
Name	Description
`properties`	`IQuotaOperation` Properties to set

Properties

consumerId

public consumerId: string;

QuotaOperation consumerId.

labels

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

QuotaOperation labels.

methodName

public methodName: string;

QuotaOperation methodName.

operationId

public operationId: string;

QuotaOperation operationId.

quotaMetrics

public quotaMetrics: google.api.servicecontrol.v1.IMetricValueSet[];

QuotaOperation quotaMetrics.

quotaMode

public quotaMode: (google.api.servicecontrol.v1.QuotaOperation.QuotaMode|keyof typeof google.api.servicecontrol.v1.QuotaOperation.QuotaMode);

QuotaOperation quotaMode.

Methods

create(properties)

public static create(properties?: google.api.servicecontrol.v1.IQuotaOperation): google.api.servicecontrol.v1.QuotaOperation;

Creates a new QuotaOperation instance using the specified properties.

Parameter
Name	Description
`properties`	`IQuotaOperation` Properties to set

Returns
Type	Description
`google.api.servicecontrol.v1.QuotaOperation`	QuotaOperation instance

decode(reader, length)

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

Decodes a QuotaOperation 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.servicecontrol.v1.QuotaOperation`	QuotaOperation

decodeDelimited(reader)

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

Decodes a QuotaOperation 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.servicecontrol.v1.QuotaOperation`	QuotaOperation

encode(message, writer)

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

Encodes the specified QuotaOperation message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IQuotaOperation` QuotaOperation 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.servicecontrol.v1.IQuotaOperation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IQuotaOperation` QuotaOperation 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.servicecontrol.v1.QuotaOperation;

Creates a QuotaOperation 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.servicecontrol.v1.QuotaOperation`	QuotaOperation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for QuotaOperation

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.api.servicecontrol.v1.QuotaOperation` QuotaOperation
`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 QuotaOperation 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