ProjectsPolicies.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\OrgPolicyAPI\Resource;

use Google\Service\OrgPolicyAPI\GoogleCloudOrgpolicyV2ListPoliciesResponse;
use Google\Service\OrgPolicyAPI\GoogleCloudOrgpolicyV2Policy;
use Google\Service\OrgPolicyAPI\GoogleProtobufEmpty;

/**
 * The "policies" collection of methods.
 * Typical usage is:
 *  <code>
 *   $orgpolicyService = new Google\Service\OrgPolicyAPI(...);
 *   $policies = $orgpolicyService->projects_policies;
 *  </code>
 */
class ProjectsPolicies extends \Google\Service\Resource
{
  /**
   * 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)
   *
   * @param 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}`
   * @param GoogleCloudOrgpolicyV2Policy $postBody
   * @param array $optParams Optional parameters.
   * @return GoogleCloudOrgpolicyV2Policy
   * @throws \Google\Service\Exception
   */
  public function create($parent, GoogleCloudOrgpolicyV2Policy $postBody, $optParams = [])
  {
    $params = ['parent' => $parent, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('create', [$params], GoogleCloudOrgpolicyV2Policy::class);
  }
  /**
   * 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)
   *
   * @param string $name Required. Name of the policy to delete. See the policy
   * entry for naming rules.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string etag Optional. The current entity tag (ETag) of the
   * organization policy. If an ETag is provided and doesn't match the current
   * ETag of the policy, deletion of the policy will be blocked and an `ABORTED`
   * error will be returned.
   * @return GoogleProtobufEmpty
   * @throws \Google\Service\Exception
   */
  public function delete($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('delete', [$params], GoogleProtobufEmpty::class);
  }
  /**
   * Gets a policy on a resource. If no policy is set on the resource, `NOT_FOUND`
   * is returned. The entity tag (ETag) can be used with `UpdatePolicy()` to
   * update a policy during read-modify-write. (policies.get)
   *
   * @param string $name Required. Resource name of the policy. See Policy for
   * naming requirements.
   * @param array $optParams Optional parameters.
   * @return GoogleCloudOrgpolicyV2Policy
   * @throws \Google\Service\Exception
   */
  public function get($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('get', [$params], GoogleCloudOrgpolicyV2Policy::class);
  }
  /**
   * 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)
   *
   * @param string $name Required. The effective policy to compute. See Policy for
   * naming requirements.
   * @param array $optParams Optional parameters.
   * @return GoogleCloudOrgpolicyV2Policy
   * @throws \Google\Service\Exception
   */
  public function getEffectivePolicy($name, $optParams = [])
  {
    $params = ['name' => $name];
    $params = array_merge($params, $optParams);
    return $this->call('getEffectivePolicy', [$params], GoogleCloudOrgpolicyV2Policy::class);
  }
  /**
   * Retrieves all of the policies that exist on a particular resource.
   * (policies.listProjectsPolicies)
   *
   * @param 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}`
   * @param array $optParams Optional parameters.
   *
   * @opt_param int pageSize Size of the pages to be returned. This is currently
   * unsupported and will be ignored. The server may at any point start using this
   * field to limit page size.
   * @opt_param string pageToken Page token used to retrieve the next page. This
   * is currently unsupported and will be ignored. The server may at any point
   * start using this field.
   * @return GoogleCloudOrgpolicyV2ListPoliciesResponse
   * @throws \Google\Service\Exception
   */
  public function listProjectsPolicies($parent, $optParams = [])
  {
    $params = ['parent' => $parent];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], GoogleCloudOrgpolicyV2ListPoliciesResponse::class);
  }
  /**
   * Updates a policy. Returns a `google.rpc.Status` with
   * `google.rpc.Code.NOT_FOUND` if the constraint or the policy doesn't exist.
   * Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the ETag
   * supplied in the request doesn't match the persisted ETag of the policy. Note:
   * the supplied policy will perform a full overwrite of all fields.
   * (policies.patch)
   *
   * @param 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
   * that 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.
   * @param GoogleCloudOrgpolicyV2Policy $postBody
   * @param array $optParams Optional parameters.
   *
   * @opt_param string updateMask Field mask used to specify the fields to be
   * overwritten in the policy. The fields specified in the update_mask are
   * relative to the policy, not the full request.
   * @return GoogleCloudOrgpolicyV2Policy
   * @throws \Google\Service\Exception
   */
  public function patch($name, GoogleCloudOrgpolicyV2Policy $postBody, $optParams = [])
  {
    $params = ['name' => $name, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('patch', [$params], GoogleCloudOrgpolicyV2Policy::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsPolicies::class, 'Google_Service_OrgPolicyAPI_Resource_ProjectsPolicies');