Class: Google::Apis::NetworkmanagementV1::ProbingDetails

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/networkmanagement_v1/classes.rb,
lib/google/apis/networkmanagement_v1/representations.rb,
lib/google/apis/networkmanagement_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ProbingDetails

Returns a new instance of ProbingDetails.



2044
2045
2046
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2044

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#abort_cause ⇒ String

The reason probing was aborted. Corresponds to the JSON property abortCause

Returns:

  • (String) 


1994
1995
1996
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 1994

def abort_cause
  @abort_cause
end

#destination_egress_location ⇒ Google::Apis::NetworkmanagementV1::EdgeLocation

Representation of a network edge location as per https://cloud.google.com/vpc/ docs/edge-locations. Corresponds to the JSON property destinationEgressLocation

Returns:



2000
2001
2002
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2000

def destination_egress_location
  @destination_egress_location
end

#endpoint_info ⇒ Google::Apis::NetworkmanagementV1::EndpointInfo

For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. Corresponds to the JSON property endpointInfo

Returns:



2007
2008
2009
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2007

def endpoint_info
  @endpoint_info
end

#error ⇒ Google::Apis::NetworkmanagementV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



2017
2018
2019
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2017

def error
  @error
end

#probing_latency ⇒ Google::Apis::NetworkmanagementV1::LatencyDistribution

Describes measured latency distribution. Corresponds to the JSON property probingLatency

Returns:



2022
2023
2024
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2022

def probing_latency
  @probing_latency
end

#result ⇒ String

The overall result of active probing. Corresponds to the JSON property result

Returns:

  • (String) 


2027
2028
2029
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2027

def result
  @result
end

#sent_probe_count ⇒ Fixnum

Number of probes sent. Corresponds to the JSON property sentProbeCount

Returns:

  • (Fixnum) 


2032
2033
2034
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2032

def sent_probe_count
  @sent_probe_count
end

#successful_probe_count ⇒ Fixnum

Number of probes that reached the destination. Corresponds to the JSON property successfulProbeCount

Returns:

  • (Fixnum) 


2037
2038
2039
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2037

def successful_probe_count
  @successful_probe_count
end

#verify_time ⇒ String

The time that reachability was assessed through active probing. Corresponds to the JSON property verifyTime

Returns:

  • (String) 


2042
2043
2044
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2042

def verify_time
  @verify_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
 
# File 'lib/google/apis/networkmanagement_v1/classes.rb', line 2049

def update!(**args)
  @abort_cause = args[:abort_cause] if args.key?(:abort_cause)
  @destination_egress_location = args[:destination_egress_location] if args.key?(:destination_egress_location)
  @endpoint_info = args[:endpoint_info] if args.key?(:endpoint_info)
  @error = args[:error] if args.key?(:error)
  @probing_latency = args[:probing_latency] if args.key?(:probing_latency)
  @result = args[:result] if args.key?(:result)
  @sent_probe_count = args[:sent_probe_count] if args.key?(:sent_probe_count)
  @successful_probe_count = args[:successful_probe_count] if args.key?(:successful_probe_count)
  @verify_time = args[:verify_time] if args.key?(:verify_time)
end