Network Management v1 API - Class ConnectivityTest (2.3.0)

public sealed class ConnectivityTest : IMessage<ConnectivityTest>, IEquatable<ConnectivityTest>, IDeepCloneable<ConnectivityTest>, IBufferMessage, IMessage

Reference documentation and code samples for the Network Management v1 API class ConnectivityTest.

A Connectivity Test for a network reachability analysis.

Inheritance

Object > ConnectivityTest

Namespace

Google.Cloud.NetworkManagement.V1

Assembly

Google.Cloud.NetworkManagement.V1.dll

Constructors

ConnectivityTest()

public ConnectivityTest()

ConnectivityTest(ConnectivityTest)

public ConnectivityTest(ConnectivityTest other)
Parameter
NameDescription
otherConnectivityTest

Properties

ConnectivityTestName

public ConnectivityTestName ConnectivityTestName { get; set; }

ConnectivityTestName-typed view over the Name resource name property.

Property Value
TypeDescription
ConnectivityTestName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time the test was created.

Property Value
TypeDescription
Timestamp

Description

public string Description { get; set; }

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

Property Value
TypeDescription
String

Destination

public Endpoint Destination { get; set; }

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.

Property Value
TypeDescription
Endpoint

DisplayName

public string DisplayName { get; set; }

Output only. The display name of a Connectivity Test.

Property Value
TypeDescription
String

Labels

public MapField<string, string> Labels { get; }

Resource labels to represent user-provided metadata.

Property Value
TypeDescription
MapField<String, String>

Name

public string Name { get; set; }

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

Property Value
TypeDescription
String

Protocol

public string Protocol { get; set; }

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

Property Value
TypeDescription
String

ReachabilityDetails

public ReachabilityDetails ReachabilityDetails { get; set; }

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.

Property Value
TypeDescription
ReachabilityDetails

RelatedProjects

public RepeatedField<string> RelatedProjects { get; }

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

Property Value
TypeDescription
RepeatedField<String>

Source

public Endpoint Source { get; set; }

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.

Property Value
TypeDescription
Endpoint

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
TypeDescription
Timestamp