Class protos.google.cloud.networkmanagement.v1beta1.Step (1.1.2)

Represents a Step.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkmanagement.v1beta1.IStep);

Constructs a new Step.

Parameter

Name	Description
properties	`IStep` Properties to set

Properties

abort

public abort?: (google.cloud.networkmanagement.v1beta1.IAbortInfo|null);

Step abort.

causesDrop

public causesDrop: boolean;

Step causesDrop.

cloudSqlInstance

public cloudSqlInstance?: (google.cloud.networkmanagement.v1beta1.ICloudSQLInstanceInfo|null);

Step cloudSqlInstance.

deliver

public deliver?: (google.cloud.networkmanagement.v1beta1.IDeliverInfo|null);

Step deliver.

description

public description: string;

Step description.

drop

public drop?: (google.cloud.networkmanagement.v1beta1.IDropInfo|null);

Step drop.

endpoint

public endpoint?: (google.cloud.networkmanagement.v1beta1.IEndpointInfo|null);

Step endpoint.

firewall

public firewall?: (google.cloud.networkmanagement.v1beta1.IFirewallInfo|null);

Step firewall.

forward

public forward?: (google.cloud.networkmanagement.v1beta1.IForwardInfo|null);

Step forward.

forwardingRule

public forwardingRule?: (google.cloud.networkmanagement.v1beta1.IForwardingRuleInfo|null);

Step forwardingRule.

gkeMaster

public gkeMaster?: (google.cloud.networkmanagement.v1beta1.IGKEMasterInfo|null);

Step gkeMaster.

instance

public instance?: (google.cloud.networkmanagement.v1beta1.IInstanceInfo|null);

Step instance.

loadBalancer

public loadBalancer?: (google.cloud.networkmanagement.v1beta1.ILoadBalancerInfo|null);

Step loadBalancer.

network

public network?: (google.cloud.networkmanagement.v1beta1.INetworkInfo|null);

Step network.

projectId

public projectId: string;

Step projectId.

route

public route?: (google.cloud.networkmanagement.v1beta1.IRouteInfo|null);

Step route.

state

public state: (google.cloud.networkmanagement.v1beta1.Step.State|keyof typeof google.cloud.networkmanagement.v1beta1.Step.State);

Step state.

stepInfo

public stepInfo?: ("instance"|"firewall"|"route"|"endpoint"|"forwardingRule"|"vpnGateway"|"vpnTunnel"|"deliver"|"forward"|"abort"|"drop"|"loadBalancer"|"network"|"gkeMaster"|"cloudSqlInstance");

Step stepInfo.

vpnGateway

public vpnGateway?: (google.cloud.networkmanagement.v1beta1.IVpnGatewayInfo|null);

Step vpnGateway.

vpnTunnel

public vpnTunnel?: (google.cloud.networkmanagement.v1beta1.IVpnTunnelInfo|null);

Step vpnTunnel.

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1beta1.IStep): google.cloud.networkmanagement.v1beta1.Step;

Creates a new Step instance using the specified properties.

Parameter

Name	Description
properties	`IStep` Properties to set

Returns

Type	Description
google.cloud.networkmanagement.v1beta1.Step	Step instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkmanagement.v1beta1.Step;

Decodes a Step 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.cloud.networkmanagement.v1beta1.Step	Step

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkmanagement.v1beta1.Step;

Decodes a Step 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.cloud.networkmanagement.v1beta1.Step	Step

encode(message, writer)

public static encode(message: google.cloud.networkmanagement.v1beta1.IStep, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Step message. Does not implicitly messages.

Parameters

Name	Description
message	`IStep` Step 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.networkmanagement.v1beta1.IStep, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IStep` Step 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.networkmanagement.v1beta1.Step;

Creates a Step 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.cloud.networkmanagement.v1beta1.Step	Step

toJSON()

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

Converts this Step to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.networkmanagement.v1beta1.Step` Step
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 Step 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