Reference documentation and code samples for the Google Cloud Network Management V1 Client class ConnectivityTest.
A Connectivity Test for a network reachability analysis.
Generated from protobuf message google.cloud.networkmanagement.v1.ConnectivityTest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Unique name of the resource using the form: |
↳ description |
string
The user-supplied description of the Connectivity Test. Maximum of 512 characters. |
↳ source |
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. |
↳ destination |
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. |
↳ protocol |
string
IP Protocol of the test. When not provided, "TCP" is assumed. |
↳ related_projects |
array
Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries. |
↳ display_name |
string
Output only. The display name of a Connectivity Test. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Resource labels to represent user-provided metadata. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time the test was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time the test's configuration was updated. |
↳ reachability_details |
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. |
getName
Required. Unique name of the resource using the form:
projects/{project_id}/locations/global/connectivityTests/{test_id}
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Unique name of the resource using the form:
projects/{project_id}/locations/global/connectivityTests/{test_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
The user-supplied description of the Connectivity Test.
Maximum of 512 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
The user-supplied description of the Connectivity Test.
Maximum of 512 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
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 | |
|---|---|
| Type | Description |
Google\Cloud\NetworkManagement\V1\Endpoint|null | |
hasSource
clearSource
setSource
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\NetworkManagement\V1\Endpoint
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDestination
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 | |
|---|---|
| Type | Description |
Google\Cloud\NetworkManagement\V1\Endpoint|null | |
hasDestination
clearDestination
setDestination
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\NetworkManagement\V1\Endpoint
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProtocol
IP Protocol of the test. When not provided, "TCP" is assumed.
| Returns | |
|---|---|
| Type | Description |
string | |
setProtocol
IP Protocol of the test. When not provided, "TCP" is assumed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRelatedProjects
Other projects that may be relevant for reachability analysis.
This is applicable to scenarios where a test can cross project boundaries.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRelatedProjects
Other projects that may be relevant for reachability analysis.
This is applicable to scenarios where a test can cross project boundaries.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Output only. The display name of a Connectivity Test.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Output only. The display name of a Connectivity Test.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Resource labels to represent user-provided metadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Resource labels to represent user-provided metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time the test was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the test was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time the test's configuration was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the test's configuration was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReachabilityDetails
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 | |
|---|---|
| Type | Description |
Google\Cloud\NetworkManagement\V1\ReachabilityDetails|null | |
hasReachabilityDetails
clearReachabilityDetails
setReachabilityDetails
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\NetworkManagement\V1\ReachabilityDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |