Class protos.google.api.UsageRule (1.1.3)

Represents a UsageRule.

Package

Constructors

(constructor)(properties)

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

Constructs a new UsageRule.

Parameter

Name	Description
properties	`IUsageRule` Properties to set

Properties

allowUnregisteredCalls

public allowUnregisteredCalls: boolean;

UsageRule allowUnregisteredCalls.

selector

public selector: string;

UsageRule selector.

skipServiceControl

public skipServiceControl: boolean;

UsageRule skipServiceControl.

Methods

create(properties)

public static create(properties?: google.api.IUsageRule): google.api.UsageRule;

Creates a new UsageRule instance using the specified properties.

Parameter

Name	Description
properties	`IUsageRule` Properties to set

Returns

Type	Description
google.api.UsageRule	UsageRule instance

decode(reader, length)

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

Decodes a UsageRule 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.UsageRule	UsageRule

decodeDelimited(reader)

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

Decodes a UsageRule 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.UsageRule	UsageRule

encode(message, writer)

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

Encodes the specified UsageRule message. Does not implicitly messages.

Parameters

Name	Description
message	`IUsageRule` UsageRule 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.IUsageRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IUsageRule` UsageRule 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.UsageRule;

Creates a UsageRule 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.UsageRule	UsageRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UsageRule

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.api.UsageRule` UsageRule
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 UsageRule 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