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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
int | |
setResult
The overall result of active probing.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVerifyTime
The time that reachability was assessed through active probing.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasVerifyTime
clearVerifyTime
setVerifyTime
The time that reachability was assessed through active probing.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
Details about an internal failure or the cancellation of active probing.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
Details about an internal failure or the cancellation of active probing.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAbortCause
The reason probing was aborted.
| Returns | |
|---|---|
| Type | Description |
int | |
setAbortCause
The reason probing was aborted.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 | |
getEndpointInfo
The source and destination endpoints derived from the test input and used for active probing.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\NetworkManagement\V1\EndpointInfo
|
| 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 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\NetworkManagement\V1\ProbingDetails\EdgeLocation
|
| Returns | |
|---|---|
| Type | Description |
$this | |