Class: Google::Cloud::NetworkManagement::V1::ConnectivityTest

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

A Connectivity Test for a network reachability analysis.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_firewall_checks ⇒ ::Boolean

Returns Whether the test should skip firewall checking. If not provided, we assume false.

Returns:

  • (::Boolean) —

    Whether the test should skip firewall checking. If not provided, we assume false.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the test was created.

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns The user-supplied description of the Connectivity Test. Maximum of 512 characters.

Returns:

  • (::String) —

    The user-supplied description of the Connectivity Test. Maximum of 512 characters.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#destination ⇒ ::Google::Cloud::NetworkManagement::V1::Endpoint

Returns Required. Destination specification of the Connectivity Test.

You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location.

Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information.

If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface.

A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.

Returns:

  • (::Google::Cloud::NetworkManagement::V1::Endpoint) —

    Required. Destination specification of the Connectivity Test.

    You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location.

    Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information.

    If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface.

    A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String (readonly)

Returns Output only. The display name of a Connectivity Test.

Returns:

  • (::String) —

    Output only. The display name of a Connectivity Test.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Resource labels to represent user-provided metadata.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Resource labels to represent user-provided metadata.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}.

Returns:

  • (::String) —

    Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#probing_details ⇒ ::Google::Cloud::NetworkManagement::V1::ProbingDetails (readonly)

Returns Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

Returns:

  • (::Google::Cloud::NetworkManagement::V1::ProbingDetails) —

    Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#protocol ⇒ ::String

Returns IP Protocol of the test. When not provided, "TCP" is assumed.

Returns:

  • (::String) —

    IP Protocol of the test. When not provided, "TCP" is assumed.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#reachability_details ⇒ ::Google::Cloud::NetworkManagement::V1::ReachabilityDetails (readonly)

Returns Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#related_projects ⇒ ::Array<::String>

Returns Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

Returns:

  • (::Array<::String>) —

    Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source ⇒ ::Google::Cloud::NetworkManagement::V1::Endpoint

Returns Required. Source specification of the Connectivity Test.

You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location.

Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information.

If the source of the test is within an on-premises network, then you must provide the destination VPC network.

If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network.

A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.

Returns:

  • (::Google::Cloud::NetworkManagement::V1::Endpoint) —

    Required. Source specification of the Connectivity Test.

    You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location.

    Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information.

    If the source of the test is within an on-premises network, then you must provide the destination VPC network.

    If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network.

    A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the test's configuration was updated.

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb', line 111

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end