class ProjectsLocationsServiceConnectionPolicies extends Resource (View source)

The "serviceConnectionPolicies" collection of methods.

Typical usage is:

 $networkconnectivityService = new Google\Service\Networkconnectivity(...);
 $serviceConnectionPolicies = $networkconnectivityService->projects_locations_serviceConnectionPolicies;

Methods

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

Creates a new ServiceConnectionPolicy in a given project and location.

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

Deletes a single ServiceConnectionPolicy. (serviceConnectionPolicies.delete)

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

Gets details of a single ServiceConnectionPolicy.

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.

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

Lists ServiceConnectionPolicies in a given project and location.

patch(string $name, ServiceConnectionPolicy $postBody, array $optParams = [])

Updates the parameters of a single ServiceConnectionPolicy.

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. (serviceConnectionPolicies.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, ServiceConnectionPolicy $postBody, array $optParams = [])

Creates a new ServiceConnectionPolicy in a given project and location.

(serviceConnectionPolicies.create)

Parameters

string $parent

Required. The parent resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1

ServiceConnectionPolicy $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Deletes a single ServiceConnectionPolicy. (serviceConnectionPolicies.delete)

Parameters

string $name

Required. The name of the ServiceConnectionPolicy to delete.

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets details of a single ServiceConnectionPolicy.

(serviceConnectionPolicies.get)

Parameters

string $name

Required. Name of the ServiceConnectionPolicy to get.

array $optParams

Optional parameters.

Return Value

ServiceConnectionPolicy

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.

(serviceConnectionPolicies.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

ListServiceConnectionPoliciesResponse listProjectsLocationsServiceConnectionPolicies(string $parent, array $optParams = [])

Lists ServiceConnectionPolicies in a given project and location.

(serviceConnectionPolicies.listProjectsLocationsServiceConnectionPolicies)

Parameters

string $parent

Required. The parent resource's name. ex. projects/123/locations/us-east1

array $optParams

Optional parameters.

Return Value

ListServiceConnectionPoliciesResponse

Exceptions

Exception

GoogleLongrunningOperation patch(string $name, ServiceConnectionPolicy $postBody, array $optParams = [])

Updates the parameters of a single ServiceConnectionPolicy.

(serviceConnectionPolicies.patch)

Parameters

string $name

Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_co nnection_policy} See: https://google.aip.dev/122#fields-representing- resource-names

ServiceConnectionPolicy $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

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. (serviceConnectionPolicies.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. (serviceConnectionPolicies.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