Network Management V1 API - Class Google::Cloud::NetworkManagement::V1::ProbingDetails (v1.0.2)

Reference documentation and code samples for the Network Management V1 API class Google::Cloud::NetworkManagement::V1::ProbingDetails.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#abort_cause

def abort_cause() -> ::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingAbortCause

Returns

(::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingAbortCause) — The reason probing was aborted.

#abort_cause=

def abort_cause=(value) -> ::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingAbortCause

Parameter

value (::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingAbortCause) — The reason probing was aborted.

Returns

(::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingAbortCause) — The reason probing was aborted.

#destination_egress_location

def destination_egress_location() -> ::Google::Cloud::NetworkManagement::V1::ProbingDetails::EdgeLocation

Returns

(::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.

#destination_egress_location=

def destination_egress_location=(value) -> ::Google::Cloud::NetworkManagement::V1::ProbingDetails::EdgeLocation

Parameter

value (::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.

Returns

(::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.

#endpoint_info

def endpoint_info() -> ::Google::Cloud::NetworkManagement::V1::EndpointInfo

Returns

(::Google::Cloud::NetworkManagement::V1::EndpointInfo) — The source and destination endpoints derived from the test input and used for active probing.

#endpoint_info=

def endpoint_info=(value) -> ::Google::Cloud::NetworkManagement::V1::EndpointInfo

Parameter

value (::Google::Cloud::NetworkManagement::V1::EndpointInfo) — The source and destination endpoints derived from the test input and used for active probing.

Returns

(::Google::Cloud::NetworkManagement::V1::EndpointInfo) — The source and destination endpoints derived from the test input and used for active probing.

#error

def error() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — Details about an internal failure or the cancellation of active probing.

#error=

def error=(value) -> ::Google::Rpc::Status

Parameter

value (::Google::Rpc::Status) — Details about an internal failure or the cancellation of active probing.

Returns

(::Google::Rpc::Status) — Details about an internal failure or the cancellation of active probing.

#probing_latency

def probing_latency() -> ::Google::Cloud::NetworkManagement::V1::LatencyDistribution

Returns

(::Google::Cloud::NetworkManagement::V1::LatencyDistribution) — Latency as measured by active probing in one direction: from the source to the destination endpoint.

#probing_latency=

def probing_latency=(value) -> ::Google::Cloud::NetworkManagement::V1::LatencyDistribution

Parameter

value (::Google::Cloud::NetworkManagement::V1::LatencyDistribution) — Latency as measured by active probing in one direction: from the source to the destination endpoint.

Returns

(::Google::Cloud::NetworkManagement::V1::LatencyDistribution) — Latency as measured by active probing in one direction: from the source to the destination endpoint.

#result

def result() -> ::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingResult

Returns

(::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingResult) — The overall result of active probing.

#result=

def result=(value) -> ::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingResult

Parameter

value (::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingResult) — The overall result of active probing.

Returns

(::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingResult) — The overall result of active probing.

#sent_probe_count

def sent_probe_count() -> ::Integer

Returns

(::Integer) — Number of probes sent.

#sent_probe_count=

def sent_probe_count=(value) -> ::Integer

Parameter

value (::Integer) — Number of probes sent.

Returns

(::Integer) — Number of probes sent.

#successful_probe_count

def successful_probe_count() -> ::Integer

Returns

(::Integer) — Number of probes that reached the destination.

#successful_probe_count=

def successful_probe_count=(value) -> ::Integer

Parameter

value (::Integer) — Number of probes that reached the destination.

Returns

(::Integer) — Number of probes that reached the destination.

#verify_time

def verify_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The time that reachability was assessed through active probing.

#verify_time=

def verify_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The time that reachability was assessed through active probing.

Returns

(::Google::Protobuf::Timestamp) — The time that reachability was assessed through active probing.