Class protos.google.cloud.networkmanagement.v1.ConnectivityTest (1.0.2)

Represents a ConnectivityTest.

Package

@google-cloud/network-management!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkmanagement.v1.IConnectivityTest);

Constructs a new ConnectivityTest.

Parameter

Name	Description
properties	`IConnectivityTest` Properties to set

Properties

createTime

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

ConnectivityTest createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

description

public description: string;

ConnectivityTest description.

Property Value

Type	Description
string

destination

public destination?: (google.cloud.networkmanagement.v1.IEndpoint|null);

ConnectivityTest destination.

Property Value

Type	Description
(google.cloud.networkmanagement.v1.IEndpoint\|null)

displayName

public displayName: string;

ConnectivityTest displayName.

Property Value

Type	Description
string

labels

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

ConnectivityTest labels.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

ConnectivityTest name.

Property Value

Type	Description
string

protocol

public protocol: string;

ConnectivityTest protocol.

Property Value

Type	Description
string

reachabilityDetails

public reachabilityDetails?: (google.cloud.networkmanagement.v1.IReachabilityDetails|null);

ConnectivityTest reachabilityDetails.

Property Value

Type	Description
(google.cloud.networkmanagement.v1.IReachabilityDetails\|null)

relatedProjects

public relatedProjects: string[];

ConnectivityTest relatedProjects.

Property Value

Type	Description
string[]

source

public source?: (google.cloud.networkmanagement.v1.IEndpoint|null);

ConnectivityTest source.

Property Value

Type	Description
(google.cloud.networkmanagement.v1.IEndpoint\|null)

updateTime

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

ConnectivityTest updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1.IConnectivityTest): google.cloud.networkmanagement.v1.ConnectivityTest;

Creates a new ConnectivityTest instance using the specified properties.

Parameter

Name	Description
properties	`IConnectivityTest` Properties to set

Returns

Type	Description
google.cloud.networkmanagement.v1.ConnectivityTest	ConnectivityTest instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified ConnectivityTest message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IConnectivityTest` ConnectivityTest 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.v1.ConnectivityTest;

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

toJSON()

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

Converts this ConnectivityTest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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