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

OrganizationsPolicies

class OrganizationsPolicies extends Resource (View source)

The "policies" collection of methods.

Typical usage is:

 $orgpolicyService = new Google\Service\OrgPolicyAPI(...);
 $policies = $orgpolicyService->organizations_policies;

Methods

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

Creates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud resource. (policies.create)

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

Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist. (policies.delete)

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

Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write. (policies.get)

GoogleCloudOrgpolicyV2Policy
getEffectivePolicy(string $name, array $optParams = [])

Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

GoogleCloudOrgpolicyV2ListPoliciesResponse
listOrganizationsPolicies(string $parent, array $optParams = [])

Retrieves all of the policies that exist on a particular resource.

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

Updates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist.

Details

at line 49
GoogleCloudOrgpolicyV2Policy create(string $parent, GoogleCloudOrgpolicyV2Policy $postBody, array $optParams = [])

Creates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud resource. (policies.create)

Parameters

string $parent

Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: projects/{project_number} projects/{project_id} * folders/{folder_id}

  • organizations/{organization_id}
GoogleCloudOrgpolicyV2Policy $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudOrgpolicyV2Policy

Exceptions

Exception

at line 70
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist. (policies.delete)

Parameters

string $name

Required. Name of the policy to delete. See the policy entry for naming rules.
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 87
GoogleCloudOrgpolicyV2Policy get(string $name, array $optParams = [])

Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write. (policies.get)

Parameters

string $name

Required. Resource name of the policy. See Policy for naming requirements.
array $optParams

Optional parameters.

Return Value

GoogleCloudOrgpolicyV2Policy

Exceptions

Exception

at line 107
GoogleCloudOrgpolicyV2Policy getEffectivePolicy(string $name, array $optParams = [])

Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

(policies.getEffectivePolicy)

Parameters

string $name

Required. The effective policy to compute. See Policy for naming requirements.
array $optParams

Optional parameters.

Return Value

GoogleCloudOrgpolicyV2Policy

Exceptions

Exception

at line 133
GoogleCloudOrgpolicyV2ListPoliciesResponse listOrganizationsPolicies(string $parent, array $optParams = [])

Retrieves all of the policies that exist on a particular resource.

(policies.listOrganizationsPolicies)

Parameters

string $parent

Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: projects/{project_number} projects/{project_id} folders/{folder_id} organizations/{organization_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudOrgpolicyV2ListPoliciesResponse

Exceptions

Exception

at line 166
GoogleCloudOrgpolicyV2Policy patch(string $name, GoogleCloudOrgpolicyV2Policy $postBody, array $optParams = [])

Updates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist.

Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields. (policies.patch)

Parameters

string $name

Immutable. The resource name of the policy. Must be one of the following forms, where constraint_name is the name of the constraint which this policy configures: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} * organizations/{organization_id}/policies/{constraint_name} For example, projects/123/policies/compute.disableSerialPortAccess. Note: projects/{project_id}/policies/{constraint_name} is also an acceptable name for API requests, but responses will return the name using the equivalent project number.
GoogleCloudOrgpolicyV2Policy $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudOrgpolicyV2Policy

Exceptions

Exception