class ProjectsLocationsNetworkconnectivityGlobalPolicyBasedRoutes extends Resource (View source)

The "policyBasedRoutes" collection of methods.

Typical usage is:

 $networkconnectivityService = new Google\Service\Networkconnectivity(...);
 $policyBasedRoutes = $networkconnectivityService->projects_locations_global_policyBasedRoutes;

Methods

create(string $parent, PolicyBasedRoute $postBody, array $optParams = [])

Creates a new policy-based route in a given project and location.

delete(string $name, array $optParams = [])

Deletes a single policy-based route. (policyBasedRoutes.delete)

get(string $name, array $optParams = [])

Gets details of a single policy-based route. (policyBasedRoutes.get)

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.

listProjectsLocationsNetworkconnectivityGlobalPolicyBasedRoutes(string $parent, array $optParams = [])

Lists policy-based routes in a given project and location. (policyBasedRoutes .listProjectsLocationsNetworkconnectivityGlobalPolicyBasedRoutes)

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. (policyBasedRoutes.setIamPolicy)

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.

Details

GoogleLongrunningOperation create(string $parent, PolicyBasedRoute $postBody, array $optParams = [])

Creates a new policy-based route in a given project and location.

(policyBasedRoutes.create)

Parameters

string $parent

Required. The parent resource's name of the PolicyBasedRoute.

PolicyBasedRoute $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a single policy-based route. (policyBasedRoutes.delete)

Parameters

string $name

Required. Name of the policy-based route resource to delete.

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

PolicyBasedRoute get(string $name, array $optParams = [])

Gets details of a single policy-based route. (policyBasedRoutes.get)

Parameters

string $name

Required. Name of the PolicyBasedRoute resource to get.

array $optParams

Optional parameters.

Return Value

PolicyBasedRoute

Exceptions

Exception

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.

(policyBasedRoutes.getIamPolicy)

Parameters

string $resource

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

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListPolicyBasedRoutesResponse listProjectsLocationsNetworkconnectivityGlobalPolicyBasedRoutes(string $parent, array $optParams = [])

Lists policy-based routes in a given project and location. (policyBasedRoutes .listProjectsLocationsNetworkconnectivityGlobalPolicyBasedRoutes)

Parameters

string $parent

Required. The parent resource's name.

array $optParams

Optional parameters.

Return Value

ListPolicyBasedRoutesResponse

Exceptions

Exception

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. (policyBasedRoutes.setIamPolicy)

Parameters

string $resource

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

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

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. (policyBasedRoutes.testIamPermissions)

Parameters

string $resource

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

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception