Google Cloud Network Management V1 Client - Class ProbingDetails (1.4.2)

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

Results of active probing from the last run of the test.

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

Namespace

Google \ Cloud \ NetworkManagement \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ result int

The overall result of active probing.

↳ verify_time Google\Protobuf\Timestamp

The time that reachability was assessed through active probing.

↳ error Google\Rpc\Status

Details about an internal failure or the cancellation of active probing.

↳ abort_cause int

The reason probing was aborted.

↳ sent_probe_count int

Number of probes sent.

↳ successful_probe_count int

Number of probes that reached the destination.

↳ endpoint_info Google\Cloud\NetworkManagement\V1\EndpointInfo

The source and destination endpoints derived from the test input and used for active probing.

↳ 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 Google\Cloud\NetworkManagement\V1\ProbingDetails\EdgeLocation

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

getResult

The overall result of active probing.

Returns
TypeDescription
int

setResult

The overall result of active probing.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getVerifyTime

The time that reachability was assessed through active probing.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasVerifyTime

clearVerifyTime

setVerifyTime

The time that reachability was assessed through active probing.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getError

Details about an internal failure or the cancellation of active probing.

Returns
TypeDescription
Google\Rpc\Status|null

hasError

clearError

setError

Details about an internal failure or the cancellation of active probing.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getAbortCause

The reason probing was aborted.

Returns
TypeDescription
int

setAbortCause

The reason probing was aborted.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSentProbeCount

Number of probes sent.

Returns
TypeDescription
int

setSentProbeCount

Number of probes sent.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSuccessfulProbeCount

Number of probes that reached the destination.

Returns
TypeDescription
int

setSuccessfulProbeCount

Number of probes that reached the destination.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEndpointInfo

The source and destination endpoints derived from the test input and used for active probing.

Returns
TypeDescription
Google\Cloud\NetworkManagement\V1\EndpointInfo|null

hasEndpointInfo

clearEndpointInfo

setEndpointInfo

The source and destination endpoints derived from the test input and used for active probing.

Parameter
NameDescription
var Google\Cloud\NetworkManagement\V1\EndpointInfo
Returns
TypeDescription
$this

getProbingLatency

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\NetworkManagement\V1\LatencyDistribution
Returns
TypeDescription
$this

getDestinationEgressLocation

The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network.

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

Returns
TypeDescription
Google\Cloud\NetworkManagement\V1\ProbingDetails\EdgeLocation|null

hasDestinationEgressLocation

clearDestinationEgressLocation

setDestinationEgressLocation

The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network.

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

Parameter
NameDescription
var Google\Cloud\NetworkManagement\V1\ProbingDetails\EdgeLocation
Returns
TypeDescription
$this