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.cloud.networkconnectivity.v1.PolicyBasedRoute (2.2.0)

Represents a PolicyBasedRoute.

Package

@google-cloud/network-connectivity

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkconnectivity.v1.IPolicyBasedRoute);

Constructs a new PolicyBasedRoute.

Parameter

Name	Description
properties	`IPolicyBasedRoute` Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

PolicyBasedRoute createTime.

description

public description: string;

PolicyBasedRoute description.

filter

public filter?: (google.cloud.networkconnectivity.v1.PolicyBasedRoute.IFilter|null);

PolicyBasedRoute filter.

interconnectAttachment

public interconnectAttachment?: (google.cloud.networkconnectivity.v1.PolicyBasedRoute.IInterconnectAttachment|null);

PolicyBasedRoute interconnectAttachment.

kind

public kind: string;

PolicyBasedRoute kind.

labels

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

PolicyBasedRoute labels.

name

public name: string;

PolicyBasedRoute name.

network

public network: string;

PolicyBasedRoute network.

nextHop

public nextHop?: "nextHopIlbIp";

PolicyBasedRoute nextHop.

nextHopIlbIp

public nextHopIlbIp?: (string|null);

PolicyBasedRoute nextHopIlbIp.

priority

public priority: number;

PolicyBasedRoute priority.

selfLink

public selfLink: string;

PolicyBasedRoute selfLink.

target

public target?: ("virtualMachine"|"interconnectAttachment");

PolicyBasedRoute target.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

PolicyBasedRoute updateTime.

virtualMachine

public virtualMachine?: (google.cloud.networkconnectivity.v1.PolicyBasedRoute.IVirtualMachine|null);

PolicyBasedRoute virtualMachine.

warnings

public warnings: google.cloud.networkconnectivity.v1.PolicyBasedRoute.IWarnings[];

PolicyBasedRoute warnings.

Methods

create(properties)

public static create(properties?: google.cloud.networkconnectivity.v1.IPolicyBasedRoute): google.cloud.networkconnectivity.v1.PolicyBasedRoute;

Creates a new PolicyBasedRoute instance using the specified properties.

Parameter

Name	Description
properties	`IPolicyBasedRoute` Properties to set

Returns

Type	Description
google.cloud.networkconnectivity.v1.PolicyBasedRoute	PolicyBasedRoute instance

decode(reader, length)

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

Decodes a PolicyBasedRoute 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.networkconnectivity.v1.PolicyBasedRoute	PolicyBasedRoute

decodeDelimited(reader)

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

Decodes a PolicyBasedRoute 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.networkconnectivity.v1.PolicyBasedRoute	PolicyBasedRoute

encode(message, writer)

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

Encodes the specified PolicyBasedRoute message. Does not implicitly messages.

Parameters

Name	Description
message	`IPolicyBasedRoute` PolicyBasedRoute 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.networkconnectivity.v1.IPolicyBasedRoute, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IPolicyBasedRoute` PolicyBasedRoute 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.networkconnectivity.v1.PolicyBasedRoute;

Creates a PolicyBasedRoute 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.networkconnectivity.v1.PolicyBasedRoute	PolicyBasedRoute

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PolicyBasedRoute

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.networkconnectivity.v1.PolicyBasedRoute` PolicyBasedRoute
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 PolicyBasedRoute 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