Documentation

Google_Service_NetworkManagement_Resource_ProjectsLocationsNetworkmanagementGlobalConnectivityTests extends Google_Service_Resource
in package

The "connectivityTests" collection of methods.

Typical usage is: $networkmanagementService = new Google_Service_NetworkManagement(...); $connectivityTests = $networkmanagementService->connectivityTests;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_NetworkManagement_Operation
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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_NetworkManagement_Operation
Deletes a specific `ConnectivityTest`. (connectivityTests.delete)
get()  : Google_Service_NetworkManagement_ConnectivityTest
Gets the details of a specific Connectivity Test. (connectivityTests.get)
getIamPolicy()  : Google_Service_NetworkManagement_Policy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
listProjectsLocationsNetworkmanagementGlobalConnectivityTests()  : Google_Service_NetworkManagement_ListConnectivityTestsResponse
Lists all Connectivity Tests owned by a project. (connectivityTests.listProje ctsLocationsNetworkmanagementGlobalConnectivityTests)
patch()  : Google_Service_NetworkManagement_Operation
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 for more details. (connectivityTests.patch)
rerun()  : Google_Service_NetworkManagement_Operation
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)
setIamPolicy()  : Google_Service_NetworkManagement_Policy
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)
testIamPermissions()  : Google_Service_NetworkManagement_TestIamPermissionsResponse
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.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

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.

public create(string $parent, Google_Service_NetworkManagement_ConnectivityTest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_Operation

(connectivityTests.create)

Parameters
$parent : string

Required. The parent resource of the Connectivity Test to create: projects/{project_id}/locations/global

$postBody : Google_Service_NetworkManagement_ConnectivityTest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string testId Required. The logical name of the Connectivity Test in your project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project

Return values
Google_Service_NetworkManagement_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a specific `ConnectivityTest`. (connectivityTests.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_Operation
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_NetworkManagement_Operation —

get()

Gets the details of a specific Connectivity Test. (connectivityTests.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_ConnectivityTest
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_NetworkManagement_ConnectivityTest —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_Policy

(connectivityTests.getIamPolicy)

Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_NetworkManagement_Policy —

listProjectsLocationsNetworkmanagementGlobalConnectivityTests()

Lists all Connectivity Tests owned by a project. (connectivityTests.listProje ctsLocationsNetworkmanagementGlobalConnectivityTests)

public listProjectsLocationsNetworkmanagementGlobalConnectivityTests(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_ListConnectivityTestsResponse
Parameters
$parent : string

Required. The parent resource of the Connectivity Tests: projects/{project_id}/locations/global

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Page token from an earlier query, as returned in next_page_token.

opt_param

int pageSize Number of ConnectivityTests to return.

opt_param

string orderBy Field to use to sort the list.

opt_param

string filter Lists the ConnectivityTests that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form where operators: <, >, <=, >=, !=, =, : are supported (colon : represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1 - Filter by labels: - Resources that have a key called foo labels.foo:* - Resources that have a key called foo whose value is bar labels.foo = bar

Return values
Google_Service_NetworkManagement_ListConnectivityTestsResponse —

patch()

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 for more details. (connectivityTests.patch)

public patch(string $name, Google_Service_NetworkManagement_ConnectivityTest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_Operation
Parameters
$name : string

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

$postBody : Google_Service_NetworkManagement_ConnectivityTest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Required. Mask of fields to update. At least one path must be supplied in this field.

Return values
Google_Service_NetworkManagement_Operation —

rerun()

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)

public rerun(string $name, Google_Service_NetworkManagement_RerunConnectivityTestRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_Operation
Parameters
$name : string

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

$postBody : Google_Service_NetworkManagement_RerunConnectivityTestRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_NetworkManagement_Operation —

setIamPolicy()

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)

public setIamPolicy(string $resource, Google_Service_NetworkManagement_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_NetworkManagement_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_NetworkManagement_Policy —

testIamPermissions()

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.

public testIamPermissions(string $resource, Google_Service_NetworkManagement_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_NetworkManagement_TestIamPermissionsResponse

This operation may "fail open" without warning. (connectivityTests.testIamPermissions)

Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_NetworkManagement_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_NetworkManagement_TestIamPermissionsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results