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

Represents a ReachabilityDetails.

Package

@google-cloud/network-management!

Constructors

(constructor)(properties)

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

Constructs a new ReachabilityDetails.

Parameter

Name	Description
properties	`IReachabilityDetails` Properties to set

Properties

error

public error?: (google.rpc.IStatus|null);

ReachabilityDetails error.

Property Value

Type	Description
(google.rpc.IStatus\|null)

result

public result: (google.cloud.networkmanagement.v1.ReachabilityDetails.Result|keyof typeof google.cloud.networkmanagement.v1.ReachabilityDetails.Result);

ReachabilityDetails result.

Property Value

Type	Description
(google.cloud.networkmanagement.v1.ReachabilityDetails.Result\|keyof typeof google.cloud.networkmanagement.v1.ReachabilityDetails.Result)

traces

public traces: google.cloud.networkmanagement.v1.ITrace[];

ReachabilityDetails traces.

Property Value

Type	Description
google.cloud.networkmanagement.v1.ITrace[]

verifyTime

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

ReachabilityDetails verifyTime.

Property Value

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

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1.IReachabilityDetails): google.cloud.networkmanagement.v1.ReachabilityDetails;

Creates a new ReachabilityDetails instance using the specified properties.

Parameter

Name	Description
properties	`IReachabilityDetails` Properties to set

Returns

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

decode(reader, length)

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

Decodes a ReachabilityDetails 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.ReachabilityDetails	ReachabilityDetails

decodeDelimited(reader)

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

Decodes a ReachabilityDetails 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.ReachabilityDetails	ReachabilityDetails

encode(message, writer)

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

Encodes the specified ReachabilityDetails message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IReachabilityDetails` ReachabilityDetails 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.ReachabilityDetails;

Creates a ReachabilityDetails 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.ReachabilityDetails	ReachabilityDetails

toJSON()

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

Converts this ReachabilityDetails to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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