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
Namespace
Google \ Cloud \ NetworkManagement \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}
↳ description
string
The user-supplied description of the Connectivity Test. Maximum of 512 characters.
↳ source
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.
↳ destination
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.
↳ 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
↳ create_time
↳ update_time
↳ reachability_details
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.
↳ probing_details
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.
↳ round_trip
bool
Whether run analysis for the return path from destination to source. Default value is false.
↳ return_reachability_details
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.
↳ bypass_firewall_checks
bool
Whether the analysis should skip firewall checking. Default value is false.
getName
Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}
string
setName
Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}
var
string
$this
getDescription
The user-supplied description of the Connectivity Test.
Maximum of 512 characters.
string
setDescription
The user-supplied description of the Connectivity Test.
Maximum of 512 characters.
var
string
$this
getSource
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.
hasSource
clearSource
setSource
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.
$this
getDestination
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.
hasDestination
clearDestination
setDestination
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.
$this
getProtocol
IP Protocol of the test. When not provided, "TCP" is assumed.
string
setProtocol
IP Protocol of the test. When not provided, "TCP" is assumed.
var
string
$this
getRelatedProjects
Other projects that may be relevant for reachability analysis.
This is applicable to scenarios where a test can cross project boundaries.
setRelatedProjects
Other projects that may be relevant for reachability analysis.
This is applicable to scenarios where a test can cross project boundaries.
var
string[]
$this
getDisplayName
Output only. The display name of a Connectivity Test.
string
setDisplayName
Output only. The display name of a Connectivity Test.
var
string
$this
getLabels
Resource labels to represent user-provided metadata.
setLabels
Resource labels to represent user-provided metadata.
$this
getCreateTime
Output only. The time the test was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the test was created.
$this
getUpdateTime
Output only. The time the test's configuration was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the test's configuration was updated.
$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.
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.
$this
getProbingDetails
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.
hasProbingDetails
clearProbingDetails
setProbingDetails
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.
$this
getRoundTrip
Whether run analysis for the return path from destination to source.
Default value is false.
bool
setRoundTrip
Whether run analysis for the return path from destination to source.
Default value is false.
var
bool
$this
getReturnReachabilityDetails
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.
hasReturnReachabilityDetails
clearReturnReachabilityDetails
setReturnReachabilityDetails
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.
$this
getBypassFirewallChecks
Whether the analysis should skip firewall checking. Default value is false.
bool
setBypassFirewallChecks
Whether the analysis should skip firewall checking. Default value is false.
var
bool
$this
