Network Management V1 API - Class Google::Cloud::NetworkManagement::V1::ConnectivityTest (v2.0.1)

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 analysis should skip firewall checking. Default value is false.

#bypass_firewall_checks=

def bypass_firewall_checks=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the analysis should skip firewall checking. Default value is false.
Returns
  • (::Boolean) — Whether the analysis should skip firewall checking. Default value is false.

#create_time

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

#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, URI of a supported endpoint, project ID, or VPC network to identify the destination location.

    Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination 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, URI of a supported endpoint, project ID, or VPC network to identify the destination location.

    Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination 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, URI of a supported endpoint, project ID, or VPC network to identify the destination location.

    Reachability analysis proceeds even if the destination location is ambiguous. However, the test result might include endpoints or use a destination 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

#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

#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, URI of a supported endpoint, project ID, or VPC network to identify the source location.

    Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source 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, URI of a supported endpoint, project ID, or VPC network to identify the source location.

    Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source 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, URI of a supported endpoint, project ID, or VPC network to identify the source location.

    Reachability analysis might proceed even if the source location is ambiguous. However, the test result might include endpoints or use a source that you don't intend to test.

#update_time

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