Class: Google::Cloud::NetworkManagement::V1::ProbingDetails

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb

Overview

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

Defined Under Namespace

Modules: ProbingAbortCause, ProbingResult Classes: EdgeLocation

Instance Attribute Summary collapse

Instance Attribute Details

#abort_cause ⇒ ::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingAbortCause

Returns The reason probing was aborted.

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#destination_egress_location ⇒ ::Google::Cloud::NetworkManagement::V1::ProbingDetails::EdgeLocation

Returns 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.



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#endpoint_info ⇒ ::Google::Cloud::NetworkManagement::V1::EndpointInfo

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

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#error ⇒ ::Google::Rpc::Status

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

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#probing_latency ⇒ ::Google::Cloud::NetworkManagement::V1::LatencyDistribution

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

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#result ⇒ ::Google::Cloud::NetworkManagement::V1::ProbingDetails::ProbingResult

Returns The overall result of active probing.

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#sent_probe_count ⇒ ::Integer

Returns Number of probes sent.

Returns:

  • (::Integer) —

    Number of probes sent.



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#successful_probe_count ⇒ ::Integer

Returns Number of probes that reached the destination.

Returns:

  • (::Integer) —

    Number of probes that reached the destination.



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end

#verify_time ⇒ ::Google::Protobuf::Timestamp

Returns The time that reachability was assessed through active probing.

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 392

class ProbingDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Representation of a network edge location as per
  # https://cloud.google.com/vpc/docs/edge-locations.
  # @!attribute [rw] metropolitan_area
  #   @return [::String]
  #     Name of the metropolitan area.
  class EdgeLocation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Overall probing result of the test.
  module ProbingResult
    # No result was specified.
    PROBING_RESULT_UNSPECIFIED = 0

    # At least 95% of packets reached the destination.
    REACHABLE = 1

    # No packets reached the destination.
    UNREACHABLE = 2

    # Less than 95% of packets reached the destination.
    REACHABILITY_INCONSISTENT = 3

    # Reachability could not be determined. Possible reasons are:
    # * The user lacks permission to access some of the network resources
    #   required to run the test.
    # * No valid source endpoint could be derived from the request.
    # * An internal error occurred.
    UNDETERMINED = 4
  end

  # Abort cause types.
  module ProbingAbortCause
    # No reason was specified.
    PROBING_ABORT_CAUSE_UNSPECIFIED = 0

    # The user lacks permission to access some of the
    # network resources required to run the test.
    PERMISSION_DENIED = 1

    # No valid source endpoint could be derived from the request.
    NO_SOURCE_LOCATION = 2
  end
end