Class protos.google.cloud.compute.v1.RouterNatRule (4.6.0)

Represents a RouterNatRule.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IRouterNatRule);

Constructs a new RouterNatRule.

Parameter
Name Description
properties IRouterNatRule

Properties to set

Properties

_action

public _action?: "action";

RouterNatRule _action.

_description

public _description?: "description";

RouterNatRule _description.

_match

public _match?: "match";

RouterNatRule _match.

_ruleNumber

public _ruleNumber?: "ruleNumber";

RouterNatRule _ruleNumber.

action

public action?: (google.cloud.compute.v1.IRouterNatRuleAction|null);

RouterNatRule action.

description

public description?: (string|null);

RouterNatRule description.

match

public match?: (string|null);

RouterNatRule match.

ruleNumber

public ruleNumber?: (number|null);

RouterNatRule ruleNumber.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IRouterNatRule): google.cloud.compute.v1.RouterNatRule;

Creates a new RouterNatRule instance using the specified properties.

Parameter
Name Description
properties IRouterNatRule

Properties to set

Returns
Type Description
RouterNatRule

RouterNatRule instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.RouterNatRule;

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

RouterNatRule

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.RouterNatRule;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RouterNatRule

RouterNatRule

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IRouterNatRule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RouterNatRule message. Does not implicitly messages.

Parameters
Name Description
message IRouterNatRule

RouterNatRule 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.cloud.compute.v1.IRouterNatRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRouterNatRule

RouterNatRule 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.cloud.compute.v1.RouterNatRule;

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

RouterNatRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RouterNatRule

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RouterNatRule

RouterNatRule

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