Class protos.google.cloud.networkmanagement.v1beta1.RouteInfo (3.7.0)

Represents a RouteInfo.

Package

@google-cloud/network-management

Constructors

(constructor)(properties)

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

Constructs a new RouteInfo.

Parameter
Name Description
properties IRouteInfo

Properties to set

Properties

_nccHubUri

public _nccHubUri?: "nccHubUri";

RouteInfo _nccHubUri.

_nccSpokeUri

public _nccSpokeUri?: "nccSpokeUri";

RouteInfo _nccSpokeUri.

destIpRange

public destIpRange: string;

RouteInfo destIpRange.

destPortRanges

public destPortRanges: string[];

RouteInfo destPortRanges.

displayName

public displayName: string;

RouteInfo displayName.

instanceTags

public instanceTags: string[];

RouteInfo instanceTags.

nccHubUri

public nccHubUri?: (string|null);

RouteInfo nccHubUri.

nccSpokeUri

public nccSpokeUri?: (string|null);

RouteInfo nccSpokeUri.

networkUri

public networkUri: string;

RouteInfo networkUri.

nextHop

public nextHop: string;

RouteInfo nextHop.

nextHopType

public nextHopType: (google.cloud.networkmanagement.v1beta1.RouteInfo.NextHopType|keyof typeof google.cloud.networkmanagement.v1beta1.RouteInfo.NextHopType);

RouteInfo nextHopType.

priority

public priority: number;

RouteInfo priority.

protocols

public protocols: string[];

RouteInfo protocols.

routeScope

public routeScope: (google.cloud.networkmanagement.v1beta1.RouteInfo.RouteScope|keyof typeof google.cloud.networkmanagement.v1beta1.RouteInfo.RouteScope);

RouteInfo routeScope.

routeType

public routeType: (google.cloud.networkmanagement.v1beta1.RouteInfo.RouteType|keyof typeof google.cloud.networkmanagement.v1beta1.RouteInfo.RouteType);

RouteInfo routeType.

srcIpRange

public srcIpRange: string;

RouteInfo srcIpRange.

srcPortRanges

public srcPortRanges: string[];

RouteInfo srcPortRanges.

uri

public uri: string;

RouteInfo uri.

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1beta1.IRouteInfo): google.cloud.networkmanagement.v1beta1.RouteInfo;

Creates a new RouteInfo instance using the specified properties.

Parameter
Name Description
properties IRouteInfo

Properties to set
Returns
Type Description
RouteInfo

RouteInfo instance

decode(reader, length)

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

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

RouteInfo

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
RouteInfo

RouteInfo

encode(message, writer)

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

Encodes the specified RouteInfo message. Does not implicitly messages.

Parameters
Name Description
message IRouteInfo

RouteInfo 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.IRouteInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRouteInfo

RouteInfo 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.RouteInfo;

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

RouteInfo

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RouteInfo

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RouteInfo

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