Google Cloud Network Management V1 Client - Class SingleEdgeResponse (2.7.0)

Reference documentation and code samples for the Google Cloud Network Management V1 Client class SingleEdgeResponse.

Probing results for a single edge device.

Generated from protobuf message google.cloud.networkmanagement.v1.ProbingDetails.SingleEdgeResponse

Namespace

Google \ Cloud \ NetworkManagement \ V1 \ ProbingDetails

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ result int

The overall result of active probing for this egress device.

↳ sent_probe_count int

Number of probes sent.

↳ successful_probe_count int

Number of probes that reached the destination.

↳ probing_latency Google\Cloud\NetworkManagement\V1\LatencyDistribution

Latency as measured by active probing in one direction: from the source to the destination endpoint.

↳ destination_egress_location EdgeLocation

The EdgeLocation from which a packet, destined to the internet, will egress the Google network. This will only be populated for a connectivity test which has an internet destination address. The absence of this field must not be used as an indication that the destination is part of the Google network.

↳ destination_router string

Router name in the format '{router}.{metroshard}'. For example: pf01.aaa01, pr02.aaa01.

getResult

The overall result of active probing for this egress device.

Returns
Type Description
int Enum of type ProbingResult.

setResult

The overall result of active probing for this egress device.

Parameter
Name Description
var int

Enum of type ProbingResult.

Returns
Type Description
$this

getSentProbeCount

Number of probes sent.

Returns
Type Description
int

setSentProbeCount

Number of probes sent.

Parameter
Name Description
var int
Returns
Type Description
$this

getSuccessfulProbeCount

Number of probes that reached the destination.

Returns
Type Description
int

setSuccessfulProbeCount

Number of probes that reached the destination.

Parameter
Name Description
var int
Returns
Type Description
$this

getProbingLatency

Latency as measured by active probing in one direction: from the source to the destination endpoint.

Returns
Type Description
Google\Cloud\NetworkManagement\V1\LatencyDistribution|null

hasProbingLatency

clearProbingLatency

setProbingLatency

Latency as measured by active probing in one direction: from the source to the destination endpoint.

Parameter
Name Description
var Google\Cloud\NetworkManagement\V1\LatencyDistribution
Returns
Type Description
$this

getDestinationEgressLocation

The EdgeLocation from which a packet, destined to the internet, will egress the Google network.

This will only be populated for a connectivity test which has an internet destination address. The absence of this field must not be used as an indication that the destination is part of the Google network.

Returns
Type Description
EdgeLocation|null

hasDestinationEgressLocation

clearDestinationEgressLocation

setDestinationEgressLocation

The EdgeLocation from which a packet, destined to the internet, will egress the Google network.

This will only be populated for a connectivity test which has an internet destination address. The absence of this field must not be used as an indication that the destination is part of the Google network.

Parameter
Name Description
var EdgeLocation
Returns
Type Description
$this

getDestinationRouter

Router name in the format '{router}.{metroshard}'. For example: pf01.aaa01, pr02.aaa01.

Returns
Type Description
string

setDestinationRouter

Router name in the format '{router}.{metroshard}'. For example: pf01.aaa01, pr02.aaa01.

Parameter
Name Description
var string
Returns
Type Description
$this