ProjectsLocationsNetworkmanagementGlobalConnectivityTests
class ProjectsLocationsNetworkmanagementGlobalConnectivityTests extends Resource (View source)
The "connectivityTests" collection of methods.
Typical usage is:
$networkmanagementService = new Google\Service\NetworkManagement(...);
$connectivityTests = $networkmanagementService->projects_locations_global_connectivityTests;Methods
Creates a new Connectivity Test. After you create a test, the reachability
analysis is performed as part of the long running operation, which completes
when the analysis completes. If the endpoint specifications in
ConnectivityTest are invalid (for example, containing non-existent
resources in the network, or you don't have read permissions to the network
configurations of listed projects), then the reachability result returns a
value of UNKNOWN. If the endpoint specifications in ConnectivityTest are
incomplete, the reachability result returns a value of AMBIGUOUS. For more
information, see the Connectivity Test documentation.
Deletes a specific ConnectivityTest. (connectivityTests.delete)
Gets the details of a specific Connectivity Test. (connectivityTests.get)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists all Connectivity Tests owned by a project. (connectivityTests.listProje ctsLocationsNetworkmanagementGlobalConnectivityTests)
Updates the configuration of an existing ConnectivityTest. After you update
a test, the reachability analysis is performed as part of the long running
operation, which completes when the analysis completes. The Reachability
state in the test resource is updated with the new result. If the endpoint
specifications in ConnectivityTest are invalid (for example, they contain
non-existent resources in the network, or the user does not have read
permissions to the network configurations of listed projects), then the
reachability result returns a value of UNKNOWN. If the endpoint
specifications in ConnectivityTest are incomplete, the reachability result
returns a value of AMBIGUOUS. See the documentation in ConnectivityTest
for more details. (connectivityTests.patch)
Rerun an existing ConnectivityTest. After the user triggers the rerun, the
reachability analysis is performed as part of the long running operation,
which completes when the analysis completes. Even though the test
configuration remains the same, the reachability result may change due to
underlying network configuration changes. If the endpoint specifications in
ConnectivityTest become invalid (for example, specified resources are
deleted in the network, or you lost read permissions to the network
configurations of listed projects), then the reachability result returns a
value of UNKNOWN. (connectivityTests.rerun)
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (connectivityTests.setIamPolicy)
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
Details
Operation
create(string $parent, ConnectivityTest $postBody, array $optParams = [])
Creates a new Connectivity Test. After you create a test, the reachability
analysis is performed as part of the long running operation, which completes
when the analysis completes. If the endpoint specifications in
ConnectivityTest are invalid (for example, containing non-existent
resources in the network, or you don't have read permissions to the network
configurations of listed projects), then the reachability result returns a
value of UNKNOWN. If the endpoint specifications in ConnectivityTest are
incomplete, the reachability result returns a value of AMBIGUOUS. For more
information, see the Connectivity Test documentation.
(connectivityTests.create)
Operation
delete(string $name, array $optParams = [])
Deletes a specific ConnectivityTest. (connectivityTests.delete)
ConnectivityTest
get(string $name, array $optParams = [])
Gets the details of a specific Connectivity Test. (connectivityTests.get)
Policy
getIamPolicy(string $resource, array $optParams = [])
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(connectivityTests.getIamPolicy)
ListConnectivityTestsResponse
listProjectsLocationsNetworkmanagementGlobalConnectivityTests(string $parent, array $optParams = [])
Lists all Connectivity Tests owned by a project. (connectivityTests.listProje ctsLocationsNetworkmanagementGlobalConnectivityTests)
Operation
patch(string $name, ConnectivityTest $postBody, array $optParams = [])
Updates the configuration of an existing ConnectivityTest. After you update
a test, the reachability analysis is performed as part of the long running
operation, which completes when the analysis completes. The Reachability
state in the test resource is updated with the new result. If the endpoint
specifications in ConnectivityTest are invalid (for example, they contain
non-existent resources in the network, or the user does not have read
permissions to the network configurations of listed projects), then the
reachability result returns a value of UNKNOWN. If the endpoint
specifications in ConnectivityTest are incomplete, the reachability result
returns a value of AMBIGUOUS. See the documentation in ConnectivityTest
for more details. (connectivityTests.patch)
Operation
rerun(string $name, RerunConnectivityTestRequest $postBody, array $optParams = [])
Rerun an existing ConnectivityTest. After the user triggers the rerun, the
reachability analysis is performed as part of the long running operation,
which completes when the analysis completes. Even though the test
configuration remains the same, the reachability result may change due to
underlying network configuration changes. If the endpoint specifications in
ConnectivityTest become invalid (for example, specified resources are
deleted in the network, or you lost read permissions to the network
configurations of listed projects), then the reachability result returns a
value of UNKNOWN. (connectivityTests.rerun)
Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (connectivityTests.setIamPolicy)
TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of permissions, not a
NOT_FOUND error. Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization checking.
This operation may "fail open" without warning. (connectivityTests.testIamPermissions)