Network Management V1 API - Class Google::Cloud::NetworkManagement::V1::ConnectivityTest (v1.4.0)

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

A Connectivity Test for a network reachability analysis.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#bypass_firewall_checks

def bypass_firewall_checks() -> ::Boolean

Returns

(::Boolean) — Whether the test should skip firewall checking. If not provided, we assume false.

#bypass_firewall_checks=

def bypass_firewall_checks=(value) -> ::Boolean

Parameter

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

#create_time

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

Returns

(::Google::Protobuf::Timestamp) — Output only. The time the test was created.

#description

def description() -> ::String

Returns

(::String) — The user-supplied description of the Connectivity Test. Maximum of 512 characters.

#description=

def description=(value) -> ::String

Parameter

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

#destination

def destination() -> ::Google::Cloud::NetworkManagement::V1::Endpoint

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.

#destination=

def destination=(value) -> ::Google::Cloud::NetworkManagement::V1::Endpoint

Parameter

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

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.

#display_name

def display_name() -> ::String

Returns

(::String) — Output only. The display name of a Connectivity Test.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user-provided metadata.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user-provided metadata.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user-provided metadata.

#name

def name() -> ::String

Returns

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

#name=

def name=(value) -> ::String

Parameter

value (::String) — 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}

#probing_details

def probing_details() -> ::Google::Cloud::NetworkManagement::V1::ProbingDetails

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.

#protocol

def protocol() -> ::String

Returns

(::String) — IP Protocol of the test. When not provided, "TCP" is assumed.

#protocol=

def protocol=(value) -> ::String

Parameter

value (::String) — IP Protocol of the test. When not provided, "TCP" is assumed.

Returns

(::String) — IP Protocol of the test. When not provided, "TCP" is assumed.

#reachability_details

def reachability_details() -> ::Google::Cloud::NetworkManagement::V1::ReachabilityDetails

Returns

(::Google::Cloud::NetworkManagement::V1::ReachabilityDetails) — 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.

#related_projects

def related_projects() -> ::Array<::String>

Returns

(::Array<::String>) — Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

#related_projects=

def related_projects=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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.

#return_reachability_details

def return_reachability_details() -> ::Google::Cloud::NetworkManagement::V1::ReachabilityDetails

Returns

(::Google::Cloud::NetworkManagement::V1::ReachabilityDetails) — Output only. The reachability details of this test from the latest run for the return path. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

#round_trip

def round_trip() -> ::Boolean

Returns

(::Boolean) — Whether run analysis for the return path from destination to source. Default value is false.

#round_trip=

def round_trip=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether run analysis for the return path from destination to source. Default value is false.

Returns

(::Boolean) — Whether run analysis for the return path from destination to source. Default value is false.

#source

def source() -> ::Google::Cloud::NetworkManagement::V1::Endpoint

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.

#source=

def source=(value) -> ::Google::Cloud::NetworkManagement::V1::Endpoint

Parameter

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

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.

#update_time

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

Returns

(::Google::Protobuf::Timestamp) — Output only. The time the test's configuration was updated.