class AccessPoliciesServicePerimeters extends Resource (View source)

The "servicePerimeters" collection of methods.

Typical usage is:

 $accesscontextmanagerService = new Google\Service\AccessContextManager(...);
 $servicePerimeters = $accesscontextmanagerService->accessPolicies_servicePerimeters;

Methods

commit(string $parent, CommitServicePerimetersRequest $postBody, array $optParams = [])

Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its spec field to the status field of the service perimeter. Only service perimeters with use_explicit_dry_run_spec field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The dry_run and the spec fields are cleared after a successful commit operation. (servicePerimeters.commit)

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

Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. (servicePerimeters.create)

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

Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage. (servicePerimeters.delete)

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

Gets a service perimeter based on the resource name. (servicePerimeters.get)

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

Lists all service perimeters for an access policy.

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

Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. (servicePerimeters.patch)

replaceAll(string $parent, ReplaceServicePerimetersRequest $postBody, array $optParams = [])

Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long- lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse. (servicePerimeters.replaceAll)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

Details

Operation commit(string $parent, CommitServicePerimetersRequest $postBody, array $optParams = [])

Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its spec field to the status field of the service perimeter. Only service perimeters with use_explicit_dry_run_spec field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The dry_run and the spec fields are cleared after a successful commit operation. (servicePerimeters.commit)

Parameters

string $parent

Required. Resource name for the parent Access Policy which owns all Service Perimeters in scope for the commit operation. Format: accessPolicies/{policy_id}

CommitServicePerimetersRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. (servicePerimeters.create)

Parameters

string $parent

Required. Resource name for the access policy which owns this Service Perimeter. Format: accessPolicies/{policy_id}

ServicePerimeter $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage. (servicePerimeters.delete)

Parameters

string $name

Required. Resource name for the Service Perimeter. Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets a service perimeter based on the resource name. (servicePerimeters.get)

Parameters

string $name

Required. Resource name for the Service Perimeter. Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}

array $optParams

Optional parameters.

Return Value

ServicePerimeter

Exceptions

Exception

ListServicePerimetersResponse listAccessPoliciesServicePerimeters(string $parent, array $optParams = [])

Lists all service perimeters for an access policy.

(servicePerimeters.listAccessPoliciesServicePerimeters)

Parameters

string $parent

Required. Resource name for the access policy to list Service Perimeters from. Format: accessPolicies/{policy_id}

array $optParams

Optional parameters.

Return Value

ListServicePerimetersResponse

Exceptions

Exception

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

Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. (servicePerimeters.patch)

Parameters

string $name

Identifier. Resource name for the ServicePerimeter. Format: accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}. The service_perimeter component must begin with a letter, followed by alphanumeric characters or _. After you create a ServicePerimeter, you cannot change its name.

ServicePerimeter $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation replaceAll(string $parent, ReplaceServicePerimetersRequest $postBody, array $optParams = [])

Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long- lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse. (servicePerimeters.replaceAll)

Parameters

string $parent

Required. Resource name for the access policy which owns these Service Perimeters. Format: accessPolicies/{policy_id}

ReplaceServicePerimetersRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.

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