1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. ResourcePolicies

ResourcePolicies

class ResourcePolicies extends Resource (View source)

The "resourcePolicies" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $resourcePolicies = $computeService->resourcePolicies;

Methods

ResourcePolicyAggregatedList
aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Operation
delete(string $project, string $region, string $resourcePolicy, array $optParams = [])

Deletes the specified resource policy. (resourcePolicies.delete)

ResourcePolicy
get(string $project, string $region, string $resourcePolicy, array $optParams = [])

Retrieves all information of the specified resource policy.

Policy
getIamPolicy(string $project, string $region, string $resource, array $optParams = [])

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (resourcePolicies.getIamPolicy)

Operation
insert(string $project, string $region, ResourcePolicy $postBody, array $optParams = [])

Creates a new resource policy. (resourcePolicies.insert)

ResourcePolicyList
listResourcePolicies(string $project, string $region, array $optParams = [])

A list all the resource policies that have been configured for the specified project in specified region. (resourcePolicies.listResourcePolicies)

Operation
patch(string $project, string $region, string $resourcePolicy, ResourcePolicy $postBody, array $optParams = [])

Modify the specified resource policy. (resourcePolicies.patch)

Policy
setIamPolicy(string $project, string $region, string $resource, RegionSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (resourcePolicies.setIamPolicy)

TestPermissionsResponse
testIamPermissions(string $project, string $region, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

Details

at line 113
ResourcePolicyAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

(resourcePolicies.aggregatedList)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

ResourcePolicyAggregatedList

Exceptions

Exception

at line 140
Operation delete(string $project, string $region, string $resourcePolicy, array $optParams = [])

Deletes the specified resource policy. (resourcePolicies.delete)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $resourcePolicy

Name of the resource policy to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 157
ResourcePolicy get(string $project, string $region, string $resourcePolicy, array $optParams = [])

Retrieves all information of the specified resource policy.

(resourcePolicies.get)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $resourcePolicy

Name of the resource policy to retrieve.
array $optParams

Optional parameters.

Return Value

ResourcePolicy

Exceptions

Exception

at line 176
Policy getIamPolicy(string $project, string $region, string $resource, array $optParams = [])

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (resourcePolicies.getIamPolicy)

Parameters

string $project

Project ID for this request.
string $region

The name of the region for this request.
string $resource

Name or id of the resource for this request.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 203
Operation insert(string $project, string $region, ResourcePolicy $postBody, array $optParams = [])

Creates a new resource policy. (resourcePolicies.insert)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
ResourcePolicy $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 273
ResourcePolicyList listResourcePolicies(string $project, string $region, array $optParams = [])

A list all the resource policies that have been configured for the specified project in specified region. (resourcePolicies.listResourcePolicies)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
array $optParams

Optional parameters.

Return Value

ResourcePolicyList

Exceptions

Exception

at line 303
Operation patch(string $project, string $region, string $resourcePolicy, ResourcePolicy $postBody, array $optParams = [])

Modify the specified resource policy. (resourcePolicies.patch)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $resourcePolicy

Id of the resource policy to patch.
ResourcePolicy $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 321
Policy setIamPolicy(string $project, string $region, string $resource, RegionSetPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. (resourcePolicies.setIamPolicy)

Parameters

string $project

Project ID for this request.
string $region

The name of the region for this request.
string $resource

Name or id of the resource for this request.
RegionSetPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 339
TestPermissionsResponse testIamPermissions(string $project, string $region, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

(resourcePolicies.testIamPermissions)

Parameters

string $project

Project ID for this request.
string $region

The name of the region for this request.
string $resource

Name or id of the resource for this request.
TestPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestPermissionsResponse

Exceptions

Exception