Google Cloud Org Policy V2 Client - Class OrgPolicyClient (0.5.3)

Reference documentation and code samples for the Google Cloud Org Policy V2 Client class OrgPolicyClient.

Service Description: An interface for managing organization policies.

The Cloud Org Policy service provides a simple mechanism for organizations to restrict the allowed configurations across their entire Cloud Resource hierarchy.

You can use a policy to configure restrictions in Cloud resources. For example, you can enforce a policy that restricts which Google Cloud Platform APIs can be activated in a certain part of your resource hierarchy, or prevents serial port access to VM instances in a particular folder.

Policies are inherited down through the resource hierarchy. A policy applied to a parent resource automatically applies to all its child resources unless overridden with a policy lower in the hierarchy.

A constraint defines an aspect of a resource's configuration that can be controlled by an organization's policy administrator. Policies are a collection of constraints that defines their allowable configuration on a particular resource and its child resources.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\OrgPolicy\V2\OrgPolicyClient for the stable implementation

Namespace

Google \ Cloud \ OrgPolicy \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createPolicy

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 Cloud resource.

The async variant is Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient::createPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\CreatePolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\OrgPolicy\V2\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient;
use Google\Cloud\OrgPolicy\V2\CreatePolicyRequest;
use Google\Cloud\OrgPolicy\V2\Policy;

/**
 * @param string $formattedParent The 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}`
 *                                Please see {@see OrgPolicyClient::projectName()} for help formatting this field.
 */
function create_policy_sample(string $formattedParent): void
{
    // Create a client.
    $orgPolicyClient = new OrgPolicyClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new CreatePolicyRequest())
        ->setParent($formattedParent)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $orgPolicyClient->createPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OrgPolicyClient::projectName('[PROJECT]');

    create_policy_sample($formattedParent);
}

deletePolicy

Deletes a Policy.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or Org Policy does not exist.

The async variant is Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient::deletePolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\DeletePolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient;
use Google\Cloud\OrgPolicy\V2\DeletePolicyRequest;

/**
 * @param string $formattedName Name of the policy to delete.
 *                              See `Policy` for naming rules. Please see
 *                              {@see OrgPolicyClient::policyName()} for help formatting this field.
 */
function delete_policy_sample(string $formattedName): void
{
    // Create a client.
    $orgPolicyClient = new OrgPolicyClient();

    // Prepare the request message.
    $request = (new DeletePolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $orgPolicyClient->deletePolicy($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OrgPolicyClient::policyName('[PROJECT]', '[POLICY]');

    delete_policy_sample($formattedName);
}

getEffectivePolicy

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 a computed Policy across multiple resources.

Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

The async variant is Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient::getEffectivePolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\GetEffectivePolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\OrgPolicy\V2\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient;
use Google\Cloud\OrgPolicy\V2\GetEffectivePolicyRequest;
use Google\Cloud\OrgPolicy\V2\Policy;

/**
 * @param string $formattedName The effective policy to compute. See `Policy` for naming rules. Please see
 *                              {@see OrgPolicyClient::policyName()} for help formatting this field.
 */
function get_effective_policy_sample(string $formattedName): void
{
    // Create a client.
    $orgPolicyClient = new OrgPolicyClient();

    // Prepare the request message.
    $request = (new GetEffectivePolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $orgPolicyClient->getEffectivePolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OrgPolicyClient::policyName('[PROJECT]', '[POLICY]');

    get_effective_policy_sample($formattedName);
}

getPolicy

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.

The async variant is Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient::getPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\GetPolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\OrgPolicy\V2\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient;
use Google\Cloud\OrgPolicy\V2\GetPolicyRequest;
use Google\Cloud\OrgPolicy\V2\Policy;

/**
 * @param string $formattedName Resource name of the policy. See `Policy` for naming
 *                              requirements. Please see
 *                              {@see OrgPolicyClient::policyName()} for help formatting this field.
 */
function get_policy_sample(string $formattedName): void
{
    // Create a client.
    $orgPolicyClient = new OrgPolicyClient();

    // Prepare the request message.
    $request = (new GetPolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $orgPolicyClient->getPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OrgPolicyClient::policyName('[PROJECT]', '[POLICY]');

    get_policy_sample($formattedName);
}

listConstraints

Lists Constraints that could be applied on the specified resource.

The async variant is Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient::listConstraintsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\ListConstraintsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient;
use Google\Cloud\OrgPolicy\V2\Constraint;
use Google\Cloud\OrgPolicy\V2\ListConstraintsRequest;

/**
 * @param string $formattedParent The Cloud resource that parents the constraint. Must be in one of
 *                                the following forms:
 *                                * `projects/{project_number}`
 *                                * `projects/{project_id}`
 *                                * `folders/{folder_id}`
 *                                * `organizations/{organization_id}`
 *                                Please see {@see OrgPolicyClient::projectName()} for help formatting this field.
 */
function list_constraints_sample(string $formattedParent): void
{
    // Create a client.
    $orgPolicyClient = new OrgPolicyClient();

    // Prepare the request message.
    $request = (new ListConstraintsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $orgPolicyClient->listConstraints($request);

        /** @var Constraint $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OrgPolicyClient::projectName('[PROJECT]');

    list_constraints_sample($formattedParent);
}

listPolicies

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

The async variant is Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient::listPoliciesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\ListPoliciesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient;
use Google\Cloud\OrgPolicy\V2\ListPoliciesRequest;
use Google\Cloud\OrgPolicy\V2\Policy;

/**
 * @param string $formattedParent The target 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}`
 *                                Please see {@see OrgPolicyClient::projectName()} for help formatting this field.
 */
function list_policies_sample(string $formattedParent): void
{
    // Create a client.
    $orgPolicyClient = new OrgPolicyClient();

    // Prepare the request message.
    $request = (new ListPoliciesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $orgPolicyClient->listPolicies($request);

        /** @var Policy $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OrgPolicyClient::projectName('[PROJECT]');

    list_policies_sample($formattedParent);
}

updatePolicy

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.

The async variant is Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient::updatePolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\UpdatePolicyRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\OrgPolicy\V2\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\OrgPolicy\V2\Client\OrgPolicyClient;
use Google\Cloud\OrgPolicy\V2\Policy;
use Google\Cloud\OrgPolicy\V2\UpdatePolicyRequest;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_policy_sample(): void
{
    // Create a client.
    $orgPolicyClient = new OrgPolicyClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new UpdatePolicyRequest())
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $orgPolicyClient->updatePolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

createPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\CreatePolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deletePolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\DeletePolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getEffectivePolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\GetEffectivePolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\GetPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listConstraintsAsync

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\ListConstraintsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listPoliciesAsync

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\ListPoliciesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updatePolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\OrgPolicy\V2\UpdatePolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::folderName

Formats a string containing the fully-qualified path to represent a folder resource.

Parameter
Name	Description
`folder`	`string`

Returns
Type	Description
`string`	The formatted folder resource.

static::folderPolicyName

Formats a string containing the fully-qualified path to represent a folder_policy resource.

Parameters
Name	Description
`folder`	`string`
`policy`	`string`

Returns
Type	Description
`string`	The formatted folder_policy resource.

static::organizationName

Formats a string containing the fully-qualified path to represent a organization resource.

Parameter
Name	Description
`organization`	`string`

Returns
Type	Description
`string`	The formatted organization resource.

static::organizationPolicyName

Formats a string containing the fully-qualified path to represent a organization_policy resource.

Parameters
Name	Description
`organization`	`string`
`policy`	`string`

Returns
Type	Description
`string`	The formatted organization_policy resource.

static::policyName

Formats a string containing the fully-qualified path to represent a policy resource.

Parameters
Name	Description
`project`	`string`
`policy`	`string`

Returns
Type	Description
`string`	The formatted policy resource.

static::projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::projectPolicyName

Formats a string containing the fully-qualified path to represent a project_policy resource.

Parameters
Name	Description
`project`	`string`
`policy`	`string`

Returns
Type	Description
`string`	The formatted project_policy resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

folder: folders/{folder}
folderPolicy: folders/{folder}/policies/{policy}
organization: organizations/{organization}
organizationPolicy: organizations/{organization}/policies/{policy}
policy: projects/{project}/policies/{policy}
project: projects/{project}
projectPolicy: projects/{project}/policies/{policy}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.